Developer Documentation
arrow.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_ARROW_HH
51 #define VSI_ARROW_HH
52 
53 //== INCLUDES =================================================================
54 #include <QGraphicsWidget>
55 #include <QGraphicsPathItem>
56 #include <QString>
57 #include <QTimer>
58 
59 //== NAMESPACES ===============================================================
60 namespace VSI {
61 
62 //== FORWARDDECLARATIONS ======================================================
63 class GraphicsScene;
64 
65 //== CLASS DEFINITION =========================================================
66 
68 class Arrow : public QObject, public QGraphicsPixmapItem, public QGraphicsLayoutItem
69 {
70  Q_OBJECT
71  Q_INTERFACES(QGraphicsLayoutItem)
72 
73  public:
74 
76  enum Direction
77  {
78  North,
79  South,
80  East,
81  West,
82  Center
83  };
84 
85  public:
86 
88  Arrow (GraphicsScene *_scene, QGraphicsItem *_parent, Direction _dir);
89 
91  ~Arrow ();
92 
94  void activate ();
95 
97  void reset ();
98 
100  void setHighlight (bool _highlight);
101 
103  virtual void setGeometry (const QRectF &_rect);
104 
105  protected:
106 
107  // catch mouse hover events
108  virtual void hoverEnterEvent (QGraphicsSceneHoverEvent *_event);
109  virtual void hoverLeaveEvent (QGraphicsSceneHoverEvent *_event);
110 
111  // catch mouse press/release events
112  virtual void mousePressEvent (QGraphicsSceneMouseEvent *_event);
113  virtual void mouseReleaseEvent (QGraphicsSceneMouseEvent *_event);
114 
115  // catch mouse wheel events
116  virtual void wheelEvent (QGraphicsSceneWheelEvent *_event);
117 
118  // size information for layouting
119  virtual QSizeF sizeHint ( Qt::SizeHint _which, const QSizeF & _constraint = QSizeF()) const;
120 
121  private slots:
122  void timeout ();
123 
124  private:
125  GraphicsScene *scene_;
126 
127  Direction dir_;
128 
129  QTimer timer_;
130 
131  int interval_;
132 
133  bool moveSelected_;
134 
135  bool highlight_;
136 };
137 
138 //=============================================================================
139 }
140 //=============================================================================
141 
142 #endif
void reset()
Stop the timer.
Definition: arrow.cc:256
virtual void setGeometry(const QRectF &_rect)
Sets the geometry.
Definition: arrow.cc:265
Scene movement widget.
Definition: arrow.hh:68
void activate()
Activates the timer for movement (will be called if an element is moved above)
Definition: arrow.cc:245
Arrow(GraphicsScene *_scene, QGraphicsItem *_parent, Direction _dir)
Constructor.
Definition: arrow.cc:72
void setHighlight(bool _highlight)
Highlights the widget if the scene can be moved in this direction.
Definition: arrow.cc:293
~Arrow()
Destructor.
Definition: arrow.cc:108
Direction
Movement direction.
Definition: arrow.hh:76