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