1/* This file is part of the KDE libraries
2 Copyright (C) 1997 Martin Jones (mjones@kde.org)
3
4 This library is free software; you can redistribute it and/or
5 modify it under the terms of the GNU Library General Public
6 License as published by the Free Software Foundation; either
7 version 2 of the License, or (at your option) any later version.
8
9 This library is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 Library General Public License for more details.
13
14 You should have received a copy of the GNU Library General Public License
15 along with this library; see the file COPYING.LIB. If not, write to
16 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17 Boston, MA 02110-1301, USA.
18*/
19
20#ifndef KCOLORBUTTON_H
21#define KCOLORBUTTON_H
22
23#include <kdeui_export.h>
24
25#include <QtGui/QPushButton>
26
27class KColorButtonPrivate;
28/**
29* @short A pushbutton to display or allow user selection of a color.
30*
31* This widget can be used to display or allow user selection of a color.
32*
33* @see KColorDialog
34*
35* \image html kcolorbutton.png "KDE Color Button"
36*/
37class KDEUI_EXPORT KColorButton : public QPushButton
38{
39 Q_OBJECT
40 Q_PROPERTY( QColor color READ color WRITE setColor NOTIFY changed USER true )
41 Q_PROPERTY( QColor defaultColor READ defaultColor WRITE setDefaultColor )
42 Q_PROPERTY( bool alphaChannelEnabled READ isAlphaChannelEnabled WRITE setAlphaChannelEnabled )
43
44public:
45 /**
46 * Creates a color button.
47 */
48 explicit KColorButton( QWidget *parent = 0 );
49
50 /**
51 * Creates a color button with an initial color @p c.
52 */
53 explicit KColorButton( const QColor &c, QWidget *parent = 0 );
54
55 /**
56 * Creates a color button with an initial color @p c and default color @p defaultColor.
57 */
58 KColorButton( const QColor &c, const QColor &defaultColor, QWidget *parent = 0 );
59
60 virtual ~KColorButton();
61
62 /**
63 * Returns the currently chosen color.
64 */
65 QColor color() const;
66
67 /**
68 * Sets the current color to @p c.
69 */
70 void setColor( const QColor &c );
71
72 /**
73 * When set to true, allow the user to change the alpha component
74 * of the color. The default value is false.
75 * @since 4.5
76 */
77 void setAlphaChannelEnabled( bool alpha );
78
79 /**
80 * Returns true if the user is allowed to change the alpha component.
81 * @since 4.5
82 */
83 bool isAlphaChannelEnabled() const;
84
85 /**
86 * Returns the default color or an invalid color
87 * if no default color is set.
88 */
89 QColor defaultColor() const;
90
91 /**
92 * Sets the default color to @p c.
93 */
94 void setDefaultColor( const QColor &c );
95
96 QSize sizeHint() const;
97 QSize minimumSizeHint() const;
98
99Q_SIGNALS:
100 /**
101 * Emitted when the color of the widget
102 * is changed, either with setColor() or via user selection.
103 */
104 void changed( const QColor &newColor );
105
106protected:
107 virtual void paintEvent( QPaintEvent *pe );
108 virtual void dragEnterEvent( QDragEnterEvent *);
109 virtual void dropEvent( QDropEvent *);
110 virtual void mousePressEvent( QMouseEvent *e );
111 virtual void mouseMoveEvent( QMouseEvent *e);
112 virtual void keyPressEvent( QKeyEvent *e );
113
114private:
115 class KColorButtonPrivate;
116 KColorButtonPrivate * const d;
117
118 Q_PRIVATE_SLOT( d, void _k_chooseColor() )
119 Q_PRIVATE_SLOT( d, void _k_colorChosen() )
120};
121
122#endif
123
124