kworship/css/KwCssStyleRule.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 _KwCssStyleRule_h_
  21 #define _KwCssStyleRule_h_
  22
  23 /**
  24  * @file KwCssStyleRule.h
  25  * @brief Rule for apply cascading styles.
  26  * @author James Hogan <james@albanarts.com>
  27  */
  28
  29 #include "KwCssScopeKey.h"
  30 #include "KwCssStyles.h"
  31
  32 #include "CountedReference.h"
  33
  34 #include <kdemacros.h>
  35
  36 #include <QString>
  37 #include <QStringList>
  38 #include <QSet>
  39 #include <QList>
  40
  41 /// Rule for apply cascading styles.
  42 class KDE_EXPORT KwCssStyleRule
  43 {
  44   public:
  45
  46     /*
  47      * Types
  48      */
  49
  50     /// List of keys.
  51     typedef QList<KwCssScopeKey> KeyList;
  52
  53     /// Set of strings.
  54     typedef QSet<QString> StringSet;
  55
  56     /*
  57      * Constructors + destructors
  58      */
  59
  60     /// Default constructor.
  61     KwCssStyleRule();
  62
  63     /// Destructor.
  64     virtual ~KwCssStyleRule();
  65
  66     /*
  67      * Main interface.
  68      */
  69
  70     /// Set the set of critieria keys.
  71     void setCriteriaKeys(const KeyList& keys);
  72
  73     /// Set the set of required classes.
  74     void setCriteriaClasses(const StringSet& classes);
  75
  76     /// Set the set of included classes.
  77     void setIncludedStyles(const StringSet& includes);
  78
  79     /// Set a style.
  80     void setRawStyle(const QString& name, KwCssAbstractStyle* style);
  81
  82     /// Set a style of a particular type.
  83     template <typename T>
  84     void setStyle(const QString& name, const T& value)
  85     {
  86       m_styles->setStyle<T>(name, value);
  87     }
  88
  89     /*
  90      * Accessors
  91      */
  92
  93     /// Get the list of criteria keys.
  94     KeyList& getCriteriaKeys();
  95
  96     /// Get the set of criteria classes.
  97     StringSet& getCriteriaClasses();
  98
  99     /// Get the list of included styles.
 100     const StringSet& getIncludedStyles() const;
 101
 102     /// Get the styles.
 103     ReferenceCountedExtension<KwCssStyles>* getStyles() const;
 104
 105     /// Convert to CSS-like format.
 106     QString toString() const;
 107
 108   private:
 109
 110     /*
 111      * Matching criteria
 112      */
 113
 114     /// List of (sequences of scope keys to match in order).
 115     KeyList m_criteriaKeys;
 116
 117     /// Classes required to match.
 118     StringSet m_criteriaClasses;
 119
 120     /*
 121      * Variables
 122      */
 123
 124     /// Names of included classes.
 125     StringSet m_includedStyles;
 126
 127     /// The styles.
 128     Reference<ReferenceCountedExtension<KwCssStyles> > m_styles;
 129 };
 130
 131 #endif // _KwCssStyleRule_h_
 132