kworship/css/KwCssScope.h

   1 #ifndef _KwCssScope_h_
   2 #define _KwCssScope_h_
   3
   4 /**
   5  * @file KwCssScope.h
   6  * @brief Cascading style scope.
   7  * @author James Hogan <james@albanarts.com>
   8  */
   9
  10 #include "KwCssScopeKey.h"
  11 #include "KwCssStyleSheet.h"
  12 #include "KwCssStyles.h"
  13 #include "KwCssStyleStates.h"
  14
  15 #include <QStringList>
  16 #include <QString>
  17 #include <QSet>
  18 #include <QList>
  19
  20 class KwCssStyleSheet;
  21
  22 /// Cascading style scope.
  23 class KwCssScope
  24 {
  25   public:
  26
  27     /*
  28      * Constructors + destructors
  29      */
  30
  31     /// Primary constructor.
  32     KwCssScope(KwCssScope* parent = 0);
  33
  34     /// Destructor.
  35     virtual ~KwCssScope();
  36
  37     /*
  38      * Main interface
  39      */
  40
  41     /// Add a stylesheet for this scope.
  42     void addStyleSheet(KwCssStyleSheet* styleSheet);
  43
  44     /// Set an explicit style.
  45     template <typename T>
  46     void setExplicitStyle(QString name, const T& value)
  47     {
  48       m_styles.setStyle<T>(name, value);
  49       recalculateStyles();
  50     }
  51
  52     /// Add a class to this scope.
  53     void addClass(QString className);
  54
  55     /// Get all the styles included in this scope.
  56     const KwCssStyleStates& getStyles() const;
  57
  58     /// Recalculate all styles.
  59     void recalculateStyles();
  60
  61     /*
  62      * Virtual interface
  63      */
  64
  65     /// Get the type id corresponding to this type.
  66     virtual KwCssScopeKey::ScopeTypeId getTypeId() const;
  67
  68     /*
  69      * Accessors
  70      */
  71
  72     /// Get explicit styles.
  73     const KwCssStyles& getExplicitStyles() const;
  74
  75     /// Get the scope's key.
  76     KwCssScopeKey getKey() const;
  77
  78     /// Find whether a scope key matches this scope.
  79     bool isKeyMatching(KwCssScopeKey key) const;
  80
  81     /*
  82      * Mutators
  83      */
  84
  85     /// Set the parent scope.
  86     void setParentScope(KwCssScope* parent);
  87
  88   private:
  89
  90     /*
  91      * Types
  92      */
  93
  94     /// Set of scopes.
  95     typedef QSet<KwCssScope*> ScopeSet;
  96
  97     /// Set of strings.
  98     typedef QSet<QString> StringSet;
  99
 100     /// List of style sheets.
 101     typedef QList<KwCssStyleSheet*> StyleSheetList;
 102
 103     /*
 104      * Basic data
 105      */
 106
 107     /// Parent scope.
 108     KwCssScope* m_parentScope;
 109
 110     /// Set of child scopes.
 111     ScopeSet m_childScopes;
 112
 113     /// Name of the scope.
 114     KwCssScopeKey::ScopeName m_name;
 115
 116     /*
 117      * Variables
 118      */
 119
 120     /// Classes enabled by default in this scope.
 121     StringSet m_classes;
 122
 123     /// Style sheets.
 124     StyleSheetList m_styleSheets;
 125
 126     /// Explicit style overrides.
 127     KwCssStyles m_styles;
 128
 129     /*
 130      * Cache
 131      */
 132
 133     /// Cached styles.
 134     KwCssStyleStates m_cachedStyles;
 135
 136     /// Cached stylesheet accumulation.
 137     KwCssStyleSheet m_cachedStyleSheet;
 138
 139     /// Cached total class list.
 140     StringSet m_cachedClasses;
 141 };
 142
 143 #endif // _KwCssScope_h_
 144