kworship/css/KwCssScope.h

   1 /***************************************************************************
   2  *   This file is part of KWorship.                                        *
   3  *   Copyright 2008 James Hogan <james@albanarts.com>                      *
   4  *                                                                         *
   5  *   KWorship is free software: you can redistribute it and/or modify      *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation, either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   KWorship is distributed in the hope that it will be useful,           *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with KWorship.  If not, write to the Free Software Foundation,  *
  17  *   Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.   *
  18  ***************************************************************************/
  19
  20 #ifndef _KwCssScope_h_
  21 #define _KwCssScope_h_
  22
  23 /**
  24  * @file KwCssScope.h
  25  * @brief Cascading style scope.
  26  * @author James Hogan <james@albanarts.com>
  27  */
  28
  29 #include "KwCssScopeKey.h"
  30 #include "KwCssStyleSheet.h"
  31 #include "KwCssStyles.h"
  32 #include "KwCssStyleStates.h"
  33
  34 #include <QStringList>
  35 #include <QString>
  36 #include <QSet>
  37 #include <QList>
  38
  39 class KwCssStyleSheet;
  40 class KwResourceManager;
  41 class QDomDocument;
  42 class QDomElement;
  43
  44 #define KW_CSS_SCOPE(TYPE_NAME) \
  45   public: \
  46     /** Get the type id corresponding to this type statically. */ \
  47     static KwCssScopeKey::ScopeTypeId scopeTypeId() \
  48     { \
  49       static KwCssScopeKey::ScopeTypeId id = KwCssScopeKey::registerScopeType(TYPE_NAME); \
  50       return id; \
  51     } \
  52     /** Get the type id corresponding to this type virtually. */ \
  53     virtual KwCssScopeKey::ScopeTypeId getTypeId() const \
  54     { \
  55       return scopeTypeId(); \
  56     }
  57
  58 /// Cascading style scope.
  59 class KwCssScope
  60 {
  61     KW_CSS_SCOPE("scope")
  62
  63   public:
  64
  65     /*
  66      * Constructors + destructors
  67      */
  68
  69     /// Primary constructor.
  70     KwCssScope(KwCssSchema* schema, KwCssScope* parent = 0);
  71
  72     /// Destructor.
  73     virtual ~KwCssScope();
  74
  75     /*
  76      * DOM filters
  77      */
  78
  79     /// Import the style information from a DOM.
  80     void importStylesFromDom(const QDomElement& element, KwResourceManager* resourceManager);
  81
  82     /// Export the style information to a DOM.
  83     void exportStylesToDom(QDomDocument& document, QDomElement& element, KwResourceManager* resourceManager) const;
  84
  85     /*
  86      * Main interface
  87      */
  88
  89     /// Add a stylesheet for this scope.
  90     void addStyleSheet(KwCssStyleSheet* styleSheet);
  91
  92     /// Set an explicit style.
  93     template <typename T>
  94     void setExplicitStyle(QString name, const T& value)
  95     {
  96       m_styles.setStyle<T>(name, value);
  97       recalculateStyles();
  98     }
  99
 100     /// Add a class to this scope.
 101     void addClass(QString className);
 102
 103     /// Get all the styles included in this scope.
 104     const KwCssStyleStates& getStyles() const;
 105
 106     /// Recalculate all styles.
 107     void recalculateStyles();
 108
 109     /*
 110      * Accessors
 111      */
 112
 113     /// Find whether the scope is effectively empty.
 114     bool isScopeEmpty() const;
 115
 116     /// Get explicit styles.
 117     const KwCssStyles& getExplicitStyles() const;
 118
 119     /// Get the scope's key.
 120     KwCssScopeKey getKey() const;
 121
 122     /// Find whether a scope key matches this scope.
 123     bool isKeyMatching(KwCssScopeKey key) const;
 124
 125     /*
 126      * Mutators
 127      */
 128
 129     /// Set the parent scope.
 130     void setParentScope(KwCssScope* parent);
 131
 132   private:
 133
 134     /*
 135      * Types
 136      */
 137
 138     /// Set of scopes.
 139     typedef QSet<KwCssScope*> ScopeSet;
 140
 141     /// Set of strings.
 142     typedef QSet<QString> StringSet;
 143
 144     /// List of style sheets.
 145     typedef QList<KwCssStyleSheet*> StyleSheetList;
 146
 147     /*
 148      * Basic data
 149      */
 150
 151     /// Style schema.
 152     KwCssSchema* m_schema;
 153
 154     /// Parent scope.
 155     KwCssScope* m_parentScope;
 156
 157     /// Set of child scopes.
 158     ScopeSet m_childScopes;
 159
 160     /// Name of the scope.
 161     KwCssScopeKey::ScopeName m_name;
 162
 163     /*
 164      * Variables
 165      */
 166
 167     /// Classes enabled by default in this scope.
 168     StringSet m_classes;
 169
 170     /// Style sheets.
 171     StyleSheetList m_styleSheets;
 172
 173     /// Explicit style overrides.
 174     KwCssStyles m_styles;
 175
 176     /*
 177      * Cache
 178      */
 179
 180     /// Cached styles.
 181     KwCssStyleStates m_cachedStyles;
 182
 183     /// Cached stylesheet accumulation.
 184     KwCssStyleSheet m_cachedStyleSheet;
 185
 186     /// Cached total class list.
 187     StringSet m_cachedClasses;
 188 };
 189
 190 #endif // _KwCssScope_h_
 191