summaryrefslogtreecommitdiffstats
path: root/doc/html/qwsdecoration.html
blob: 21a558319a920743d298a43080c4fd008b1d09f4 (plain)
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/kernel/qwsdecoration_qws.cpp:44 -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>QWSDecoration Class</title>
<style type="text/css"><!--
fn { margin-left: 1cm; text-indent: -1cm; }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
body { background: #ffffff; color: black; }
--></style>
</head>
<body>

<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr bgcolor="#E5E5E5">
<td valign=center>
 <a href="index.html">
<font color="#004faf">Home</font></a>
 | <a href="classes.html">
<font color="#004faf">All&nbsp;Classes</font></a>
 | <a href="mainclasses.html">
<font color="#004faf">Main&nbsp;Classes</font></a>
 | <a href="annotated.html">
<font color="#004faf">Annotated</font></a>
 | <a href="groups.html">
<font color="#004faf">Grouped&nbsp;Classes</font></a>
 | <a href="functions.html">
<font color="#004faf">Functions</font></a>
</td>
<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QWSDecoration Class Reference</h1>

<p>The QWSDecoration class allows the appearance of the Qt/Embedded Window
Manager to be customized.
<a href="#details">More...</a>
<p><tt>#include &lt;<a href="qwsdecoration_qws-h.html">qwsdecoration_qws.h</a>&gt;</tt>
<p><a href="qwsdecoration-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<li class=fn><a href="#QWSDecoration"><b>QWSDecoration</b></a> ()</li>
<li class=fn>virtual <a href="#~QWSDecoration"><b>~QWSDecoration</b></a> ()</li>
<li class=fn>enum <a href="#Region-enum"><b>Region</b></a> { None = 0, All = 1, Title = 2, Top = 3, Bottom = 4, Left = 5, Right = 6, TopLeft = 7, TopRight = 8, BottomLeft = 9, BottomRight = 10, Close = 11, Minimize = 12, Maximize = 13, Normalize = 14, Menu = 15, LastRegion = Menu }</li>
<li class=fn>virtual QRegion <a href="#region"><b>region</b></a> ( const&nbsp;QWidget&nbsp;*&nbsp;widget, const&nbsp;QRect&nbsp;&amp;&nbsp;rect, Region&nbsp;type = All ) = 0</li>
<li class=fn>virtual void <a href="#close"><b>close</b></a> ( QWidget&nbsp;*&nbsp;widget )</li>
<li class=fn>virtual void <a href="#minimize"><b>minimize</b></a> ( QWidget&nbsp;*&nbsp;widget )</li>
<li class=fn>virtual void <a href="#maximize"><b>maximize</b></a> ( QWidget&nbsp;*&nbsp;widget )</li>
<li class=fn>virtual QPopupMenu * <a href="#menu"><b>menu</b></a> ( const QWidget *, const QPoint &amp; )</li>
<li class=fn>virtual void <a href="#paint"><b>paint</b></a> ( QPainter&nbsp;*&nbsp;painter, const&nbsp;QWidget&nbsp;*&nbsp;widget ) = 0</li>
<li class=fn>virtual void <a href="#paintButton"><b>paintButton</b></a> ( QPainter&nbsp;*&nbsp;painter, const&nbsp;QWidget&nbsp;*&nbsp;widget, Region&nbsp;type, int&nbsp;state ) = 0</li>
</ul>
<hr><a name="details"></a><h2>Detailed Description</h2>


The QWSDecoration class allows the appearance of the Qt/Embedded Window
Manager to be customized.
<p> 
<p> Qt/Embedded provides window management to top level windows. The
appearance of the borders and buttons (the decoration) around the
managed windows can be customized by creating your own class
derived from QWSDecoration and overriding a few methods.
<p> This class is non-portable. It is available <em>only</em> in Qt/Embedded.
<p> <p>See also <a href="qapplication.html#qwsSetDecoration">QApplication::qwsSetDecoration</a>() and <a href="qws.html">Qt/Embedded</a>.

<hr><h2>Member Type Documentation</h2>
<h3 class=fn><a name="Region-enum"></a>QWSDecoration::Region</h3>

<p> This enum describes the regions in the window decorations.
<ul>
<li><tt>QWSDecoration::None</tt> - used internally.
<li><tt>QWSDecoration::All</tt> - the entire region used by the window decoration.
<li><tt>QWSDecoration::Title</tt> - Displays the window title and allows the window to be
moved by dragging.
<li><tt>QWSDecoration::Top</tt> - allows the top of the window to be resized.
<li><tt>QWSDecoration::Bottom</tt> - allows the bottom of the window to be resized.
<li><tt>QWSDecoration::Left</tt> - allows the left edge of the window to be resized.
<li><tt>QWSDecoration::Right</tt> - allows the right edge of the window to be resized.
<li><tt>QWSDecoration::TopLeft</tt> - allows the top-left of the window to be resized.
<li><tt>QWSDecoration::TopRight</tt> - allows the top-right of the window to be resized.
<li><tt>QWSDecoration::BottomLeft</tt> - allows the bottom-left of the window to be resized.
<li><tt>QWSDecoration::BottomRight</tt> - allows the bottom-right of the window to be resized.
<li><tt>QWSDecoration::Close</tt> - clicking in this region closes the window.
<li><tt>QWSDecoration::Minimize</tt> - clicking in this region minimizes the window.
<li><tt>QWSDecoration::Maximize</tt> - clicking in this region maximizes the window.
<li><tt>QWSDecoration::Normalize</tt> - returns a maximized window to its previous size.
<li><tt>QWSDecoration::Menu</tt> - clicking in this region opens the window operations
(system) menu.
</ul>
<hr><h2>Member Function Documentation</h2>
<h3 class=fn><a name="QWSDecoration"></a>QWSDecoration::QWSDecoration ()
</h3>

<p> Constructs a decorator.

<h3 class=fn><a name="~QWSDecoration"></a>QWSDecoration::~QWSDecoration ()<tt> [virtual]</tt>
</h3>

<p> Destroys a decorator.

<h3 class=fn>void <a name="close"></a>QWSDecoration::close ( <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;widget )<tt> [virtual]</tt>
</h3>
Called when the user clicks in the <a href="#Region-enum">Close</a> region.
<p> <em>widget</em> is the widget to be closed.
<p> The default behaviour is to close the widget.

<h3 class=fn>void <a name="maximize"></a>QWSDecoration::maximize ( <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;widget )<tt> [virtual]</tt>
</h3>
Called when the user clicks in the <a href="#Region-enum">Maximize</a> region.
<p> <em>widget</em> is the widget to be maximized.
<p> The default behaviour is to resize the widget to be full-screen.
This method can be overridden e.g. to allow room for launch
panels.

<h3 class=fn><a href="qpopupmenu.html">QPopupMenu</a>&nbsp;* <a name="menu"></a>QWSDecoration::menu ( const&nbsp;<a href="qwidget.html">QWidget</a>&nbsp;*, const&nbsp;<a href="qpoint.html">QPoint</a>&nbsp;&amp; )<tt> [virtual]</tt>
</h3>
Called to create a <a href="qpopupmenu.html">QPopupMenu</a> containing the valid menu operations.
<p> The default implementation adds all possible window operations.

<h3 class=fn>void <a name="minimize"></a>QWSDecoration::minimize ( <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;widget )<tt> [virtual]</tt>
</h3>
Called when the user clicks in the <a href="#Region-enum">Minimize</a> region.
<p> <em>widget</em> is the widget to be minimized.
<p> The default behaviour is to ignore this action.

<h3 class=fn>void <a name="paint"></a>QWSDecoration::paint ( <a href="qpainter.html">QPainter</a>&nbsp;*&nbsp;painter, const&nbsp;<a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;widget )<tt> [pure virtual]</tt>
</h3>

<p> Override to paint the border and title decoration around <em>widget</em>
using <em>painter</em>.

<h3 class=fn>void <a name="paintButton"></a>QWSDecoration::paintButton ( <a href="qpainter.html">QPainter</a>&nbsp;*&nbsp;painter, const&nbsp;<a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;widget, <a href="qwsdecoration.html#Region-enum">Region</a>&nbsp;type, int&nbsp;state )<tt> [pure virtual]</tt>
</h3>

<p> Override to paint a button of type <em>type</em> using <em>painter</em>.
<p> <em>widget</em> is the widget whose button is to be drawn.
<em>state</em> is the state of the button. It can be a combination of the
following OR-ed together:
<ul>
<li> <tt>QWSButton::MouseOver</tt>
<li> <tt>QWSButton::Clicked</tt>
<li> <tt>QWSButton::On</tt>
</ul>

<h3 class=fn><a href="qregion.html">QRegion</a> <a name="region"></a>QWSDecoration::region ( const&nbsp;<a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;widget, const&nbsp;<a href="qrect.html">QRect</a>&nbsp;&amp;&nbsp;rect, <a href="qwsdecoration.html#Region-enum">Region</a>&nbsp;type = All )<tt> [pure virtual]</tt>
</h3>

<p> Returns the requested region <em>type</em> which will contain <em>widget</em>
with geometry <em>rect</em>.

<!-- eof -->
<hr><p>
This file is part of the <a href="index.html">Qt toolkit</a>.
Copyright &copy; 1995-2007
<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
<table width=100% cellspacing=0 border=0><tr>
<td>Copyright &copy; 2007
<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
<td align=right><div align=right>Qt 3.3.8</div>
</table></div></address></body>
</html>