diff options
Diffstat (limited to 'doc/man/man3/qwsdecoration.3qt')
| -rw-r--r-- | doc/man/man3/qwsdecoration.3qt | 156 |
1 files changed, 156 insertions, 0 deletions
diff --git a/doc/man/man3/qwsdecoration.3qt b/doc/man/man3/qwsdecoration.3qt new file mode 100644 index 000000000..63bc8e039 --- /dev/null +++ b/doc/man/man3/qwsdecoration.3qt @@ -0,0 +1,156 @@ +'\" t +.TH QWSDecoration 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- +.\" Copyright 1992-2007 Trolltech ASA. All rights reserved. See the +.\" license file included in the distribution for a complete license +.\" statement. +.\" +.ad l +.nh +.SH NAME +QWSDecoration \- Allows the appearance of the Qt/Embedded Window Manager to be customized +.SH SYNOPSIS +\fC#include <qwsdecoration_qws.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQWSDecoration\fR ()" +.br +.ti -1c +.BI "virtual \fB~QWSDecoration\fR ()" +.br +.ti -1c +.BI "enum \fBRegion\fR { 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 }" +.br +.ti -1c +.BI "virtual QRegion \fBregion\fR ( const QWidget * widget, const QRect & rect, Region type = All ) = 0" +.br +.ti -1c +.BI "virtual void \fBclose\fR ( QWidget * widget )" +.br +.ti -1c +.BI "virtual void \fBminimize\fR ( QWidget * widget )" +.br +.ti -1c +.BI "virtual void \fBmaximize\fR ( QWidget * widget )" +.br +.ti -1c +.BI "virtual QPopupMenu * \fBmenu\fR ( const QWidget *, const QPoint & )" +.br +.ti -1c +.BI "virtual void \fBpaint\fR ( QPainter * painter, const QWidget * widget ) = 0" +.br +.ti -1c +.BI "virtual void \fBpaintButton\fR ( QPainter * painter, const QWidget * widget, Region type, int state ) = 0" +.br +.in -1c +.SH DESCRIPTION +The QWSDecoration class allows the appearance of the Qt/Embedded Window Manager to be customized. +.PP +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. +.PP +This class is non-portable. It is available \fIonly\fR in Qt/Embedded. +.PP +See also QApplication::qwsSetDecoration() and Qt/Embedded. +.SS "Member Type Documentation" +.SH "QWSDecoration::Region" +This enum describes the regions in the window decorations. +.TP +\fCQWSDecoration::None\fR - used internally. +.TP +\fCQWSDecoration::All\fR - the entire region used by the window decoration. +.TP +\fCQWSDecoration::Title\fR - Displays the window title and allows the window to be moved by dragging. +.TP +\fCQWSDecoration::Top\fR - allows the top of the window to be resized. +.TP +\fCQWSDecoration::Bottom\fR - allows the bottom of the window to be resized. +.TP +\fCQWSDecoration::Left\fR - allows the left edge of the window to be resized. +.TP +\fCQWSDecoration::Right\fR - allows the right edge of the window to be resized. +.TP +\fCQWSDecoration::TopLeft\fR - allows the top-left of the window to be resized. +.TP +\fCQWSDecoration::TopRight\fR - allows the top-right of the window to be resized. +.TP +\fCQWSDecoration::BottomLeft\fR - allows the bottom-left of the window to be resized. +.TP +\fCQWSDecoration::BottomRight\fR - allows the bottom-right of the window to be resized. +.TP +\fCQWSDecoration::Close\fR - clicking in this region closes the window. +.TP +\fCQWSDecoration::Minimize\fR - clicking in this region minimizes the window. +.TP +\fCQWSDecoration::Maximize\fR - clicking in this region maximizes the window. +.TP +\fCQWSDecoration::Normalize\fR - returns a maximized window to its previous size. +.TP +\fCQWSDecoration::Menu\fR - clicking in this region opens the window operations (system) menu. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QWSDecoration::QWSDecoration ()" +Constructs a decorator. +.SH "QWSDecoration::~QWSDecoration ()\fC [virtual]\fR" +Destroys a decorator. +.SH "void QWSDecoration::close ( QWidget * widget )\fC [virtual]\fR" +Called when the user clicks in the Close region. +.PP +\fIwidget\fR is the widget to be closed. +.PP +The default behaviour is to close the widget. +.SH "void QWSDecoration::maximize ( QWidget * widget )\fC [virtual]\fR" +Called when the user clicks in the Maximize region. +.PP +\fIwidget\fR is the widget to be maximized. +.PP +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. +.SH "QPopupMenu * QWSDecoration::menu ( const QWidget *, const QPoint & )\fC [virtual]\fR" +Called to create a QPopupMenu containing the valid menu operations. +.PP +The default implementation adds all possible window operations. +.SH "void QWSDecoration::minimize ( QWidget * widget )\fC [virtual]\fR" +Called when the user clicks in the Minimize region. +.PP +\fIwidget\fR is the widget to be minimized. +.PP +The default behaviour is to ignore this action. +.SH "void QWSDecoration::paint ( QPainter * painter, const QWidget * widget )\fC [pure virtual]\fR" +Override to paint the border and title decoration around \fIwidget\fR using \fIpainter\fR. +.SH "void QWSDecoration::paintButton ( QPainter * painter, const QWidget * widget, Region type, int state )\fC [pure virtual]\fR" +Override to paint a button of type \fItype\fR using \fIpainter\fR. +.PP +\fIwidget\fR is the widget whose button is to be drawn. \fIstate\fR is the state of the button. It can be a combination of the following OR-ed together: +.TP +\fCQWSButton::MouseOver\fR +.TP +\fCQWSButton::Clicked\fR +.TP +\fCQWSButton::On\fR +.SH "QRegion QWSDecoration::region ( const QWidget * widget, const QRect & rect, Region type = All )\fC [pure virtual]\fR" +Returns the requested region \fItype\fR which will contain \fIwidget\fR +with geometry \fIrect\fR. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qwsdecoration.html +.BR http://www.trolltech.com/faq/tech.html +.SH COPYRIGHT +Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the +license file included in the distribution for a complete license +statement. +.SH AUTHOR +Generated automatically from the source code. +.SH BUGS +If you find a bug in Qt, please report it as described in +.BR http://doc.trolltech.com/bughowto.html . +Good bug reports help us to help you. Thank you. +.P +The definitive Qt documentation is provided in HTML format; it is +located at $QTDIR/doc/html and can be read using Qt Assistant or with +a web browser. This man page is provided as a convenience for those +users who prefer man pages, although this format is not officially +supported by Trolltech. +.P +If you find errors in this manual page, please report them to +.BR [email protected] . +Please include the name of the manual page (qwsdecoration.3qt) and the Qt +version (3.3.8). |