File: buttonsprite.h

package info (click to toggle)
kfourinline 4:18.04.1-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 6,784 kB
  • sloc: cpp: 7,339; sh: 8; makefile: 5
file content (136 lines) | stat: -rw-r--r-- 4,030 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
#ifndef BUTTON_SPRITE_H
#define BUTTON_SPRITE_H
/*
   This file is part of the KDE games kwin4 program
   Copyright (c) 2006 Martin Heni <kde@heni-online.de>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/

// Qt includes
#include <QMouseEvent>
#include <QGraphicsPixmapItem>
#include <QGraphicsTextItem>


// Local includes
#include "thememanager.h"
#include "pixmapsprite.h"
#include "spritenotify.h"


/** The sprite for a interactive buttons. The button can either be
  * a push button which reacts on mouse press events or a toggle button
  * which is toggled on mouse release.
  *
  * NOTE: An own event handler is implemeted currently in the DisplayIntro
  *       class which uses this buttons because the Qt4.3 QGraphicsView event
  *       handling system is faulty!!!!
 */
class ButtonSprite : public PixmapSprite
{
  public:
    /** Constructor for the score sprite.
      * @param pushButton      True: push button, False: Toggle button
      * @param id              The theme id
      * @param theme           The theme manager
      * @param no              A used defined number (unused)
      * @param scene           The graphics scene
      */
    ButtonSprite(bool pushButton, const QString &id, ThemeManager* theme, int no, QGraphicsScene* scene);
    
    /** Destructor 
      */
    ~ButtonSprite();

    /** Standard QGI advance function.
     *  @param phase The advance phase
     */
    void advance(int phase) Q_DECL_OVERRIDE;

    /** Retrieve the type of QGI. This item is UserType+10
     *  @return The type of item.
     */
    int type() const Q_DECL_OVERRIDE {return QGraphicsItem::UserType+100;}

    /** Main theme change function. On call of this the item needs to redraw and
      * resize.
      */
    void changeTheme() Q_DECL_OVERRIDE;

    /** Store the button text.
      * @param s  The text
      */ 
    void setText(const QString &s);

    /** Set the status of the button to on or off.
      * @param status The status
      */
    void setStatus(const bool status);  

    /** Retrieve the status of the button (on or off).
      * @return The status
      */
    bool status() const;

    /** Allow the sprite to emit a signal. Used for button events.
      * @return The notify object.
      */
    SpriteNotify* notify() {return mSignal;}

    /** A mouse press event is received.
      * @param event The mouse event
      */
    virtual void mousePressEvent(QMouseEvent* event);

    /** A mouse release event is received.
      * @param event The mouse event
      */
    virtual void mouseReleaseEvent(QMouseEvent* event);

    /** A hover in event is reveived (mouse tracking must be on).
      * @param event The mouse event
      */
    virtual void hoverEnterEvent(QMouseEvent* event);  

    /** A hover out event is reveived (mouse tracking must be on).
      * @param event The mouse event
      */
    virtual void hoverLeaveEvent(QMouseEvent* event);  


  protected:
    /** Change the frame of the sprite to match the button state.
      */
    void changeFrame();

    
  private:
    // Button text 
    QGraphicsTextItem* mText;
    // State of button
    bool mButtonPressed;
    // State of hover
    bool mHover;
    // Is push button?
    bool mPushButton;

    // The notification object
    SpriteNotify* mSignal;

};

#endif