Developer Documentation
text.hh
1 /*===========================================================================*\
2 * *
3 * OpenFlipper *
4  * Copyright (c) 2001-2015, RWTH-Aachen University *
5  * Department of Computer Graphics and Multimedia *
6  * All rights reserved. *
7  * www.openflipper.org *
8  * *
9  *---------------------------------------------------------------------------*
10  * This file is part of OpenFlipper. *
11  *---------------------------------------------------------------------------*
12  * *
13  * Redistribution and use in source and binary forms, with or without *
14  * modification, are permitted provided that the following conditions *
15  * are met: *
16  * *
17  * 1. Redistributions of source code must retain the above copyright notice, *
18  * this list of conditions and the following disclaimer. *
19  * *
20  * 2. Redistributions in binary form must reproduce the above copyright *
21  * notice, this list of conditions and the following disclaimer in the *
22  * documentation and/or other materials provided with the distribution. *
23  * *
24  * 3. Neither the name of the copyright holder nor the names of its *
25  * contributors may be used to endorse or promote products derived from *
26  * this software without specific prior written permission. *
27  * *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39 * *
40 \*===========================================================================*/
41 
42 
43 
44 #ifndef VSI_TEXT_HH
45 #define VSI_TEXT_HH
46 
47 //== INCLUDES =================================================================
48 #include <QGraphicsItem>
49 #include <QGraphicsLayoutItem>
50 #include <QString>
51 #include <QTimer>
52 #include <QPen>
53 #include <QBrush>
54 #include <QPainterPath>
55 
56 //== NAMESPACES ===============================================================
57 namespace VSI {
58 
59 //== FORWARDDECLARATIONS ======================================================
60 class GraphicsScene;
61 
62 //== CLASS DEFINITION =========================================================
63 
67 class Text : public QObject, public QGraphicsSimpleTextItem, public QGraphicsLayoutItem
68 {
69  Q_OBJECT
70  Q_INTERFACES(QGraphicsLayoutItem)
71 
72  public:
73 
75  explicit Text (QGraphicsItem *_parent = 0);
76  Text (const QString &_text, QGraphicsItem *_parent = 0);
77 
79  ~Text ();
80 
82  virtual void setGeometry (const QRectF &_rect);
83 
85  QPainterPath shape () const;
86 
88  virtual void paint (QPainter *_painter, const QStyleOptionGraphicsItem *_option, QWidget *_widget = 0);
89 
91  virtual QRectF boundingRect () const;
92 
94  QBrush backgroundBrush () { return backgroundBrush_; };
95 
97  virtual void setBackgroundBrush (QBrush _brush);
98 
100  QPen backgroundPen () { return backgroundPen_; };
101 
103  virtual void setBackgroundPen (QPen _pen);
104 
106  void setBackground (bool _leftOut, bool _rightOut);
107 
109  void clearBackground ();
110 
112  void setHorizontalStretch (bool _stretch);
113 
115  void setAlignment (Qt::Alignment _alignment);
116 
118  void setText (QString _text) {text_ = _text; update (); };
119 
121  QString text () { return text_; };
122 
123  protected:
124 
125  // size information for layouting
126  virtual QSizeF sizeHint ( Qt::SizeHint _which, const QSizeF & _constraint = QSizeF()) const;
127 
128  private:
129 
130  QString text_;
131 
132  bool backgroundSet_;
133 
134  QBrush backgroundBrush_;
135  QPen backgroundPen_;
136 
137  bool leftOut_;
138  bool rightOut_;
139 
140  Qt::Alignment alignment_;
141  bool hStretch_;
142 };
143 
144 //=============================================================================
145 }
146 //=============================================================================
147 
148 #endif
void setAlignment(Qt::Alignment _alignment)
Placement of the text in a stretched widget.
Definition: text.cc:311
QPainterPath shape() const
Returns the shape for proper repainting/event handling.
Definition: text.cc:397
virtual void setGeometry(const QRectF &_rect)
Sets the geometry.
Definition: text.cc:102
void clearBackground()
Disables backgorund painting.
Definition: text.cc:333
virtual void setBackgroundPen(QPen _pen)
Sets the background pen.
Definition: text.cc:388
QPen backgroundPen()
Returns the current background pen.
Definition: text.hh:100
~Text()
Destrucotr.
Definition: text.cc:95
QString text()
Get displayed text.
Definition: text.hh:121
virtual void paint(QPainter *_painter, const QStyleOptionGraphicsItem *_option, QWidget *_widget=0)
Background painting.
Definition: text.cc:185
QBrush backgroundBrush()
Returns the current background brush.
Definition: text.hh:94
Text(QGraphicsItem *_parent=0)
Constructor.
Definition: text.cc:66
virtual void setBackgroundBrush(QBrush _brush)
Sets the background brush.
Definition: text.cc:379
virtual QRectF boundingRect() const
Bounding rectangle.
Definition: text.cc:342
void setText(QString _text)
Set displayed text.
Definition: text.hh:118
void setBackground(bool _leftOut, bool _rightOut)
Enables background painting.
Definition: text.cc:300
void setHorizontalStretch(bool _stretch)
Should this widget be stretchable in horizontal direction.
Definition: text.cc:324