attribute.h

/* 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 KTEXTEDITOR_ATTRIBUTE_H
#define KTEXTEDITOR_ATTRIBUTE_H

#include <QTextFormat>

#include <QSharedData>
#include <QExplicitlySharedDataPointer>

#include <ktexteditor_export.h>

class QAction;

namespace KTextEditor
{

enum DefaultStyle {
    //
    // normal text
    //
    dsNormal = 0,
    dsKeyword,
    dsFunction,
    dsVariable,
    dsControlFlow,
    dsOperator,
    dsBuiltIn,
    dsExtension,
    dsPreprocessor,
    dsAttribute,

    //
    // Strings & Characters
    //
    dsChar,
    dsSpecialChar,
    dsString,
    dsVerbatimString,
    dsSpecialString,
    dsImport,

    //
    // Number, Types & Constants
    //
    dsDataType,
    dsDecVal,
    dsBaseN,
    dsFloat,
    dsConstant,

    //
    // Comments & Documentation
    //
    dsComment,
    dsDocumentation,
    dsAnnotation,
    dsCommentVar,
    dsRegionMarker,
    dsInformation,
    dsWarning,
    dsAlert,

    //
    // Misc
    //
    dsOthers,
    dsError

    //
    // WARNING: Whenever you add a default style to this list,
    //          make sure to adapt KateHlManager::defaultStyleCount()
    //
};

class KTEXTEDITOR_EXPORT Attribute : public QTextCharFormat, public QSharedData
{
public:
    typedef QExplicitlySharedDataPointer<Attribute> Ptr;

    Attribute();
    
    Attribute(const QString &name, DefaultStyle style);

    Attribute(const Attribute &a);

    virtual ~Attribute();

    //BEGIN custom properties

    QString name() const;
    
    void setName(const QString &name);

    DefaultStyle defaultStyle() const;
    
    void setDefaultStyle(DefaultStyle style);

    bool skipSpellChecking() const;
    
    void setSkipSpellChecking(bool skipspellchecking);

    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);

    void clear();

    bool hasAnyProperty() const;

    //END

    //BEGIN Dynamic highlighting

    enum ActivationType {
        ActivateMouseIn = 0,
        ActivateCaretIn
    };

    Attribute::Ptr dynamicAttribute(ActivationType type) const;

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


    //END

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

    Attribute &operator=(const Attribute &a);

private:
    class AttributePrivate *const d;
};

class AttributeBlock
{
public:
    AttributeBlock(int _start, int _length, const Attribute::Ptr &_attribute)
        : start(_start), length(_length), attribute(_attribute) {
    }

    int start;

    int length;

    Attribute::Ptr attribute;
};

}

Q_DECLARE_TYPEINFO(KTextEditor::AttributeBlock, Q_MOVABLE_TYPE);

#endif