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