attribute.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
 *  Copyright (C) 2003-2005 Hamish Rodda <rodda@kde.org>
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Library General Public
 *  License as published by the Free Software Foundation; either
 *  version 2 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Library General Public License for more details.
 *
 *  You should have received a copy of the GNU Library General Public License
 *  along with this library; see the file COPYING.LIB.  If not, write to
 *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 *  Boston, MA 02110-1301, USA.
 */

#ifndef KDELIBS_KTEXTEDITOR_ATTRIBUTE_H
#define KDELIBS_KTEXTEDITOR_ATTRIBUTE_H

#include <QtGui/QTextFormat>

#include <ksharedptr.h>
#include <ktexteditor/ktexteditor_export.h>

class KAction;

namespace KTextEditor
{

class KTEXTEDITOR_EXPORT Attribute : public QTextCharFormat, public KShared
{
  public:
    typedef KSharedPtr<Attribute> Ptr;

    Attribute();

    Attribute(const Attribute& a);

    virtual ~Attribute();

    void changed() const;

    //BEGIN custom properties
    enum CustomProperties {
      Outline = QTextFormat::UserProperty,
      SelectedForeground,
      SelectedBackground,
      BackgroundFillWhitespace,
      AttributeDynamicEffect = 0x10A00,
      AttributeInternalProperty = 0x10E00,
      AttributeUserProperty = 0x110000
    };

    bool fontBold() const;

    void setFontBold(bool bold = true);

    QBrush outline() const;

    void setOutline(const QBrush& brush);

    QBrush selectedForeground() const;

    void setSelectedForeground(const QBrush& foreground);

    QBrush selectedBackground() const;

    void setSelectedBackground(const QBrush& brush);

    bool backgroundFillWhitespace() const;

    void setBackgroundFillWhitespace(bool fillWhitespace);

    // Fix deficiencies in QText{Char}Format
    void clear();

    bool hasAnyProperty() const;
    //END

    //BEGIN Action association
    void associateAction(KAction* action);

    void dissociateAction(KAction* action);

    const QList<KAction*>& associatedActions() const;

    void clearAssociatedActions();
    //END

    //BEGIN Dynamic highlighting
    enum ActivationType {
      ActivateMouseIn = 0,
      ActivateCaretIn
    };

    enum Effect {
      EffectNone          = 0x0 ,
      EffectFadeIn        = 0x1 ,
      EffectFadeOut       = 0x2 ,
      EffectPulse         = 0x4 ,
      EffectCycleGradient = 0x8 
    };
    Q_DECLARE_FLAGS(Effects, Effect)
    Attribute::Ptr dynamicAttribute(ActivationType type) const;

    void setDynamicAttribute(ActivationType type, Attribute::Ptr attribute);

    Effects effects() const;
    void setEffects(Effects effects);
    //END

    Attribute& operator+=(const Attribute& a);

    Attribute& operator=(const Attribute& a);

  private:
    class AttributePrivate* const d;
};

Q_DECLARE_OPERATORS_FOR_FLAGS(Attribute::Effects)

}

#endif

// kate: space-indent on; indent-width 2; replace-tabs on;