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