kworship/css/KwCssStyleSheet.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 _KwCssStyleSheet_h_
  21 #define _KwCssStyleSheet_h_
  22
  23 /**
  24  * @file KwCssStyleSheet.h
  25  * @brief Cascading style sheet.
  26  * @author James Hogan <james@albanarts.com>
  27  */
  28
  29 #include <QList>
  30
  31 class KwCssStyleRule;
  32 class KwCssSchema;
  33
  34 /// Cascading style sheet.
  35 /**
  36  * Represents a set of style definitions.
  37  * These definitions may be backed up by a CSS-like file.
  38  */
  39 class KwCssStyleSheet
  40 {
  41   public:
  42
  43     /*
  44      * Types
  45      */
  46
  47     /// List of rules.
  48     typedef QList<KwCssStyleRule> RuleList;
  49
  50     /// Constant iterator.
  51     typedef RuleList::const_iterator ConstIterator;
  52
  53     /// Iterator.
  54     typedef RuleList::iterator Iterator;
  55
  56     /*
  57      * Constructors + destructors
  58      */
  59
  60     /// Default constructor.
  61     KwCssStyleSheet();
  62
  63     /// Copy constructor.
  64     /**
  65      * This copies all except the actual styles in each rule which are aliased.
  66      */
  67     KwCssStyleSheet(const KwCssStyleSheet& copy);
  68
  69     /// Destructor.
  70     virtual ~KwCssStyleSheet();
  71
  72     /*
  73      * Main interface
  74      */
  75
  76     /// Clear the rules.
  77     void clear();
  78
  79     /// Append a rule.
  80     void addRule(const KwCssStyleRule& rule);
  81
  82     /// Import another stylesheet.
  83     void importStyleSheet(const KwCssStyleSheet* styleSheet);
  84
  85     /// Import from CSS-like format into the sheet.
  86     void import(const KwCssSchema* schema, const QString& sheet);
  87
  88     /*
  89      * Accessors
  90      */
  91
  92     /// Get the rules.
  93     RuleList& getRules();
  94
  95     /// Get the constant rules.
  96     const RuleList& getRules() const;
  97
  98     /// Convert to CSS-like format.
  99     QString toString() const;
 100
 101   private:
 102
 103     /*
 104      * Variables
 105      */
 106
 107     /// List of style rules.
 108     RuleList m_rules;
 109 };
 110
 111 #endif // _KwCssStyleSheet_h_
 112