QWSDecoration(3qt)

1QWSDecoration(3qt)                                          QWSDecoration(3qt)
2
3
4

NAME

6       QWSDecoration - Allows the appearance of the Qt/Embedded Window Manager
7       to be customized
8

SYNOPSIS

10       #include <qwsdecoration_qws.h>
11
12   Public Members
13       QWSDecoration ()
14       virtual ~QWSDecoration ()
15       enum Region { None = 0, All = 1, Title = 2, Top = 3, Bottom = 4, Left =
16           5, Right = 6, TopLeft = 7, TopRight = 8, BottomLeft = 9,
17           BottomRight = 10, Close = 11, Minimize = 12, Maximize = 13,
18           Normalize = 14, Menu = 15, LastRegion = Menu }
19       virtual QRegion region ( const QWidget * widget, const QRect & rect,
20           Region type = All ) = 0
21       virtual void close ( QWidget * widget )
22       virtual void minimize ( QWidget * widget )
23       virtual void maximize ( QWidget * widget )
24       virtual QPopupMenu * menu ( const QWidget *, const QPoint & )
25       virtual void paint ( QPainter * painter, const QWidget * widget ) = 0
26       virtual void paintButton ( QPainter * painter, const QWidget * widget,
27           Region type, int state ) = 0
28

DESCRIPTION

30       The QWSDecoration class allows the appearance of the Qt/Embedded Window
31       Manager to be customized.
32
33       Qt/Embedded provides window management to top level windows. The
34       appearance of the borders and buttons (the decoration) around the
35       managed windows can be customized by creating your own class derived
36       from QWSDecoration and overriding a few methods.
37
38       This class is non-portable. It is available only in Qt/Embedded.
39
40       See also QApplication::qwsSetDecoration() and Qt/Embedded.
41
42   Member Type Documentation

QWSDecoration::Region

44       This enum describes the regions in the window decorations.
45
46       QWSDecoration::None - used internally.
47
48       QWSDecoration::All - the entire region used by the window decoration.
49
50       QWSDecoration::Title - Displays the window title and allows the window
51       to be moved by dragging.
52
53       QWSDecoration::Top - allows the top of the window to be resized.
54
55       QWSDecoration::Bottom - allows the bottom of the window to be resized.
56
57       QWSDecoration::Left - allows the left edge of the window to be resized.
58
59       QWSDecoration::Right - allows the right edge of the window to be
60       resized.
61
62       QWSDecoration::TopLeft - allows the top-left of the window to be
63       resized.
64
65       QWSDecoration::TopRight - allows the top-right of the window to be
66       resized.
67
68       QWSDecoration::BottomLeft - allows the bottom-left of the window to be
69       resized.
70
71       QWSDecoration::BottomRight - allows the bottom-right of the window to
72       be resized.
73
74       QWSDecoration::Close - clicking in this region closes the window.
75
76       QWSDecoration::Minimize - clicking in this region minimizes the window.
77
78       QWSDecoration::Maximize - clicking in this region maximizes the window.
79
80       QWSDecoration::Normalize - returns a maximized window to its previous
81       size.
82
83       QWSDecoration::Menu - clicking in this region opens the window
84       operations (system) menu.
85

MEMBER FUNCTION DOCUMENTATION

QWSDecoration::QWSDecoration ()

88       Constructs a decorator.
89

QWSDecoration::~QWSDecoration () [virtual]

91       Destroys a decorator.
92

void QWSDecoration::close ( QWidget * widget ) [virtual]

94       Called when the user clicks in the Close region.
95
96       widget is the widget to be closed.
97
98       The default behaviour is to close the widget.
99

void QWSDecoration::maximize ( QWidget * widget ) [virtual]

101       Called when the user clicks in the Maximize region.
102
103       widget is the widget to be maximized.
104
105       The default behaviour is to resize the widget to be full-screen. This
106       method can be overridden e.g. to allow room for launch panels.
107

QPopupMenu * QWSDecoration::menu ( const QWidget *, const QPoint & ) [virtual]

109
110       Called to create a QPopupMenu containing the valid menu operations.
111
112       The default implementation adds all possible window operations.
113

void QWSDecoration::minimize ( QWidget * widget ) [virtual]

115       Called when the user clicks in the Minimize region.
116
117       widget is the widget to be minimized.
118
119       The default behaviour is to ignore this action.
120

void QWSDecoration::paint ( QPainter * painter, const QWidget * widget ) [pure

122       virtual]
123       Override to paint the border and title decoration around widget using
124       painter.
125

void QWSDecoration::paintButton ( QPainter * painter, const QWidget * widget,

127       Region type, int state ) [pure virtual]
128       Override to paint a button of type type using painter.
129
130       widget is the widget whose button is to be drawn. state is the state of
131       the button. It can be a combination of the following OR-ed together:
132
133       QWSButton::MouseOver
134
135       QWSButton::Clicked
136
137       QWSButton::On
138

QRegion QWSDecoration::region ( const QWidget * widget, const QRect & rect,

140       Region type = All ) [pure virtual]
141       Returns the requested region type which will contain widget with
142       geometry rect.
143
144

COPYRIGHT

150       Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com.  See the
151       license file included in the distribution for a complete license
152       statement.
153

AUTHOR

155       Generated automatically from the source code.
156

BUGS

158       If you find a bug in Qt, please report it as described in
159       http://doc.trolltech.com/bughowto.html.  Good bug reports help us to
160       help you. Thank you.
161
162       The definitive Qt documentation is provided in HTML format; it is
163       located at $QTDIR/doc/html and can be read using Qt Assistant or with a
164       web browser. This man page is provided as a convenience for those users
165       who prefer man pages, although this format is not officially supported
166       by Trolltech.
167
168       If you find errors in this manual page, please report them to qt-
169       bugs@trolltech.com.  Please include the name of the manual page
170       (qwsdecoration.3qt) and the Qt version (3.3.8).
171
172
173
174Trolltech AS                    2 February 2007             QWSDecoration(3qt)