kworship/display/KwTextLayer.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 _KwTextLayer_h_
  21 #define _KwTextLayer_h_
  22
  23 /**
  24  * @file KwTextLayer.h
  25  * @brief Layer of pretty text.
  26  * @author James Hogan <james@albanarts.com>
  27  */
  28
  29 #include "KwAbstractLayer.h"
  30 #include "KwTextStyle.h"
  31
  32 #include <QSize>
  33 #include <QPixmap>
  34
  35 /// Layer of pretty text.
  36 class KwTextLayer : public KwAbstractLayer
  37 {
  38   public:
  39
  40     /*
  41      * Constructors + destructors
  42      */
  43
  44     /// Default constructor.
  45     KwTextLayer();
  46
  47     /// Primaryt constructor.
  48     KwTextLayer(QString text, bool formatted = false);
  49
  50     /// Destructor.
  51     virtual ~KwTextLayer();
  52
  53     /*
  54      * Mutators
  55      */
  56
  57     /// Set text styles.
  58     void setStyle(const KwTextStyle& style);
  59
  60     /*
  61      * Methods
  62      */
  63
  64     /// @copydoc KwAbstractLayer::addWidgets(QWidget*) const
  65     virtual void* addWidgets(QWidget* master) const;
  66
  67     /// @copydoc KwAbstractLayer::removeWidgets(QWidget*,void*) const
  68     virtual void removeWidgets(QWidget* master, void* data) const;
  69
  70   private:
  71
  72     /*
  73      * Variables
  74      */
  75
  76     /// Text style.
  77     KwTextStyle m_style;
  78
  79     /// The actual text.
  80     QString m_text;
  81
  82     /// Whether the text is formatted.
  83     bool m_formatted;
  84 };
  85
  86 #endif // _KwTextLayer_h_
  87