source: trunk/doc/html/qwsdecoration.html

Last change on this file was 190, checked in by rudi, 14 years ago

reference documentation added

File size: 8.7 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/kernel/qwsdecoration_qws.cpp:44 -->
3<html>
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
6<title>QWSDecoration Class</title>
7<style type="text/css"><!--
8fn { margin-left: 1cm; text-indent: -1cm; }
9a:link { color: #004faf; text-decoration: none }
10a:visited { color: #672967; text-decoration: none }
11body { background: #ffffff; color: black; }
12--></style>
13</head>
14<body>
15
16<table border="0" cellpadding="0" cellspacing="0" width="100%">
17<tr bgcolor="#E5E5E5">
18<td valign=center>
19 <a href="index.html">
20<font color="#004faf">Home</font></a>
21 | <a href="classes.html">
22<font color="#004faf">All&nbsp;Classes</font></a>
23 | <a href="mainclasses.html">
24<font color="#004faf">Main&nbsp;Classes</font></a>
25 | <a href="annotated.html">
26<font color="#004faf">Annotated</font></a>
27 | <a href="groups.html">
28<font color="#004faf">Grouped&nbsp;Classes</font></a>
29 | <a href="functions.html">
30<font color="#004faf">Functions</font></a>
31</td>
32<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>
33
34<p>The QWSDecoration class allows the appearance of the Qt/Embedded Window
35Manager to be customized.
36<a href="#details">More...</a>
37<p><tt>#include &lt;<a href="qwsdecoration_qws-h.html">qwsdecoration_qws.h</a>&gt;</tt>
38<p><a href="qwsdecoration-members.html">List of all member functions.</a>
39<h2>Public Members</h2>
40<ul>
41<li class=fn><a href="#QWSDecoration"><b>QWSDecoration</b></a> ()</li>
42<li class=fn>virtual <a href="#~QWSDecoration"><b>~QWSDecoration</b></a> ()</li>
43<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>
44<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>
45<li class=fn>virtual void <a href="#close"><b>close</b></a> ( QWidget&nbsp;*&nbsp;widget )</li>
46<li class=fn>virtual void <a href="#minimize"><b>minimize</b></a> ( QWidget&nbsp;*&nbsp;widget )</li>
47<li class=fn>virtual void <a href="#maximize"><b>maximize</b></a> ( QWidget&nbsp;*&nbsp;widget )</li>
48<li class=fn>virtual QPopupMenu * <a href="#menu"><b>menu</b></a> ( const QWidget *, const QPoint &amp; )</li>
49<li class=fn>virtual void <a href="#paint"><b>paint</b></a> ( QPainter&nbsp;*&nbsp;painter, const&nbsp;QWidget&nbsp;*&nbsp;widget ) = 0</li>
50<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>
51</ul>
52<hr><a name="details"></a><h2>Detailed Description</h2>
53
54
55The QWSDecoration class allows the appearance of the Qt/Embedded Window
56Manager to be customized.
57<p>
58<p> Qt/Embedded provides window management to top level windows. The
59appearance of the borders and buttons (the decoration) around the
60managed windows can be customized by creating your own class
61derived from QWSDecoration and overriding a few methods.
62<p> This class is non-portable. It is available <em>only</em> in Qt/Embedded.
63<p> <p>See also <a href="qapplication.html#qwsSetDecoration">QApplication::qwsSetDecoration</a>() and <a href="qws.html">Qt/Embedded</a>.
64
65<hr><h2>Member Type Documentation</h2>
66<h3 class=fn><a name="Region-enum"></a>QWSDecoration::Region</h3>
67
68<p> This enum describes the regions in the window decorations.
69<ul>
70<li><tt>QWSDecoration::None</tt> - used internally.
71<li><tt>QWSDecoration::All</tt> - the entire region used by the window decoration.
72<li><tt>QWSDecoration::Title</tt> - Displays the window title and allows the window to be
73moved by dragging.
74<li><tt>QWSDecoration::Top</tt> - allows the top of the window to be resized.
75<li><tt>QWSDecoration::Bottom</tt> - allows the bottom of the window to be resized.
76<li><tt>QWSDecoration::Left</tt> - allows the left edge of the window to be resized.
77<li><tt>QWSDecoration::Right</tt> - allows the right edge of the window to be resized.
78<li><tt>QWSDecoration::TopLeft</tt> - allows the top-left of the window to be resized.
79<li><tt>QWSDecoration::TopRight</tt> - allows the top-right of the window to be resized.
80<li><tt>QWSDecoration::BottomLeft</tt> - allows the bottom-left of the window to be resized.
81<li><tt>QWSDecoration::BottomRight</tt> - allows the bottom-right of the window to be resized.
82<li><tt>QWSDecoration::Close</tt> - clicking in this region closes the window.
83<li><tt>QWSDecoration::Minimize</tt> - clicking in this region minimizes the window.
84<li><tt>QWSDecoration::Maximize</tt> - clicking in this region maximizes the window.
85<li><tt>QWSDecoration::Normalize</tt> - returns a maximized window to its previous size.
86<li><tt>QWSDecoration::Menu</tt> - clicking in this region opens the window operations
87(system) menu.
88</ul>
89<hr><h2>Member Function Documentation</h2>
90<h3 class=fn><a name="QWSDecoration"></a>QWSDecoration::QWSDecoration ()
91</h3>
92
93<p> Constructs a decorator.
94
95<h3 class=fn><a name="~QWSDecoration"></a>QWSDecoration::~QWSDecoration ()<tt> [virtual]</tt>
96</h3>
97
98<p> Destroys a decorator.
99
100<h3 class=fn>void <a name="close"></a>QWSDecoration::close ( <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;widget )<tt> [virtual]</tt>
101</h3>
102Called when the user clicks in the <a href="#Region-enum">Close</a> region.
103<p> <em>widget</em> is the widget to be closed.
104<p> The default behaviour is to close the widget.
105
106<h3 class=fn>void <a name="maximize"></a>QWSDecoration::maximize ( <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;widget )<tt> [virtual]</tt>
107</h3>
108Called when the user clicks in the <a href="#Region-enum">Maximize</a> region.
109<p> <em>widget</em> is the widget to be maximized.
110<p> The default behaviour is to resize the widget to be full-screen.
111This method can be overridden e.g. to allow room for launch
112panels.
113
114<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>
115</h3>
116Called to create a <a href="qpopupmenu.html">QPopupMenu</a> containing the valid menu operations.
117<p> The default implementation adds all possible window operations.
118
119<h3 class=fn>void <a name="minimize"></a>QWSDecoration::minimize ( <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;widget )<tt> [virtual]</tt>
120</h3>
121Called when the user clicks in the <a href="#Region-enum">Minimize</a> region.
122<p> <em>widget</em> is the widget to be minimized.
123<p> The default behaviour is to ignore this action.
124
125<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>
126</h3>
127
128<p> Override to paint the border and title decoration around <em>widget</em>
129using <em>painter</em>.
130
131<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>
132</h3>
133
134<p> Override to paint a button of type <em>type</em> using <em>painter</em>.
135<p> <em>widget</em> is the widget whose button is to be drawn.
136<em>state</em> is the state of the button. It can be a combination of the
137following OR-ed together:
138<ul>
139<li> <tt>QWSButton::MouseOver</tt>
140<li> <tt>QWSButton::Clicked</tt>
141<li> <tt>QWSButton::On</tt>
142</ul>
143
144<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>
145</h3>
146
147<p> Returns the requested region <em>type</em> which will contain <em>widget</em>
148with geometry <em>rect</em>.
149
150<!-- eof -->
151<hr><p>
152This file is part of the <a href="index.html">Qt toolkit</a>.
153Copyright &copy; 1995-2007
154<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
155<table width=100% cellspacing=0 border=0><tr>
156<td>Copyright &copy; 2007
157<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
158<td align=right><div align=right>Qt 3.3.8</div>
159</table></div></address></body>
160</html>
Note: See TracBrowser for help on using the repository browser.