Changed the code naming style according to agreed guideline
[situare] / src / ui / pixmap.h
1 /*
2    Situare - A location system for Facebook
3    Copyright (C) 2010  Ixonos Plc. Authors:
4
5        Jukka Saastamoinen - jukka.saastamoinen@ixonos.com
6
7    Situare is free software; you can redistribute it and/or
8    modify it under the terms of the GNU General Public License
9    version 2 as published by the Free Software Foundation.
10
11    Situare is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    You should have received a copy of the GNU General Public License
17    along with Situare; if not, write to the Free Software
18    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
19    USA.
20 */
21
22 #ifndef PIXMAP_H
23 #define PIXMAP_H
24
25 #include <QtCore>
26 #include <QtGui>
27
28 /**
29 * @brief Pixmap class.
30 *
31 * General purpose class used to display graphical objects
32 * that can be animated.
33 * @author Jukka Saastamoinen
34 */
35
36 class Pixmap : public QGraphicsObject
37 {
38     Q_OBJECT
39 public:
40     /**
41     * @brief Bounding box of the drawed pixmap
42     *
43     * @return Rectangle shaped bounding box of the pixmap
44     */
45     QRectF boundingRect() const;
46     /**
47     * @brief Mouse press event
48     *
49     * @param event Mouse event
50     */
51     void mousePressEvent(QGraphicsSceneMouseEvent *event);
52 protected:
53     /**
54     * @brief Drawer of the given picture
55     *
56     * @param painter Pointer to painting class
57     * @param Pointer to class describing parameters needed to draw the item
58     * @param Pointer to the widget
59     */
60     void paint(QPainter *painter, const QStyleOptionGraphicsItem *, QWidget *);
61 public:
62     /**
63     * @brief Constructor
64     *
65     * @param picture Reference to the picture displayed
66     * @param parent Parent
67     */
68     Pixmap(const QPixmap &picture, QGraphicsObject *parent = 0);
69 signals:
70     /**
71     * @brief Signal which is emitted when the pixmap
72     * bounding box area is clicked.
73     */
74     void clicked();
75 private:
76     QPixmap m_p;    ///<Holds the buttons pixmap
77 };
78
79 #endif // PIXMAP_H