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 * $Revision$ *
45 * $LastChangedBy$ *
46 * $Date$ *
47 * *
48 \*===========================================================================*/
49 
50 #ifndef VSI_TEXT_HH
51 #define VSI_TEXT_HH
52 
53 //== INCLUDES =================================================================
54 #include <QGraphicsItem>
55 #include <QGraphicsLayoutItem>
56 #include <QString>
57 #include <QTimer>
58 #include <QPen>
59 #include <QBrush>
60 #include <QPainterPath>
61 
62 //== NAMESPACES ===============================================================
63 namespace VSI {
64 
65 //== FORWARDDECLARATIONS ======================================================
66 class GraphicsScene;
67 
68 //== CLASS DEFINITION =========================================================
69 
73 class Text : public QObject, public QGraphicsSimpleTextItem, public QGraphicsLayoutItem
74 {
75  Q_OBJECT
76  Q_INTERFACES(QGraphicsLayoutItem)
77 
78  public:
79 
81  Text (QGraphicsItem *_parent = 0);
82  Text (const QString &_text, QGraphicsItem *_parent = 0);
83 
85  ~Text ();
86 
88  virtual void setGeometry (const QRectF &_rect);
89 
91  QPainterPath shape () const;
92 
94  virtual void paint (QPainter *_painter, const QStyleOptionGraphicsItem *_option, QWidget *_widget = 0);
95 
97  virtual QRectF boundingRect () const;
98 
100  QBrush backgroundBrush () { return backgroundBrush_; };
101 
103  virtual void setBackgroundBrush (QBrush _brush);
104 
106  QPen backgroundPen () { return backgroundPen_; };
107 
109  virtual void setBackgroundPen (QPen _pen);
110 
112  void setBackground (bool _leftOut, bool _rightOut);
113 
115  void clearBackground ();
116 
118  void setHorizontalStretch (bool _stretch);
119 
121  void setAlignment (Qt::Alignment _alignment);
122 
124  void setText (QString _text) {text_ = _text; update (); };
125 
127  QString text () { return text_; };
128 
129  protected:
130 
131  // size information for layouting
132  virtual QSizeF sizeHint ( Qt::SizeHint _which, const QSizeF & _constraint = QSizeF()) const;
133 
134  private:
135 
136  QString text_;
137 
138  bool backgroundSet_;
139 
140  QBrush backgroundBrush_;
141  QPen backgroundPen_;
142 
143  bool leftOut_;
144  bool rightOut_;
145 
146  Qt::Alignment alignment_;
147  bool hStretch_;
148 };
149 
150 //=============================================================================
151 }
152 //=============================================================================
153 
154 #endif
void setText(QString _text)
Set displayed text.
Definition: text.hh:124
virtual void setBackgroundBrush(QBrush _brush)
Sets the background brush.
Definition: text.cc:385
void clearBackground()
Disables backgorund painting.
Definition: text.cc:339
virtual QRectF boundingRect() const
Bounding rectangle.
Definition: text.cc:348
void setHorizontalStretch(bool _stretch)
Should this widget be stretchable in horizontal direction.
Definition: text.cc:330
void setAlignment(Qt::Alignment _alignment)
Placement of the text in a stretched widget.
Definition: text.cc:317
QPen backgroundPen()
Returns the current background pen.
Definition: text.hh:106
void setBackground(bool _leftOut, bool _rightOut)
Enables background painting.
Definition: text.cc:306
QString text()
Get displayed text.
Definition: text.hh:127
virtual void setGeometry(const QRectF &_rect)
Sets the geometry.
Definition: text.cc:108
virtual void paint(QPainter *_painter, const QStyleOptionGraphicsItem *_option, QWidget *_widget=0)
Background painting.
Definition: text.cc:191
QPainterPath shape() const
Returns the shape for proper repainting/event handling.
Definition: text.cc:403
Text(QGraphicsItem *_parent=0)
Constructor.
Definition: text.cc:72
~Text()
Destrucotr.
Definition: text.cc:101
QBrush backgroundBrush()
Returns the current background brush.
Definition: text.hh:100
virtual void setBackgroundPen(QPen _pen)
Sets the background pen.
Definition: text.cc:394