QWindowDecorationInterface Class Reference
[QtBaseModule]

Detailed Description

The QWindowDecorationInterface class provides an interface for Qt Extended window decoration styles.

Window decoration styles may be added to Qt Extended via plug-ins. In order to write a style plug-in you must derive from the QWindowDecorationInterface class and implement the virtual functions.

The window being decorated is defined by the QWindowDecorationPlugin::WindowData struct:

    struct WindowData {
        const QWidget *window;
        QRect rect;
        QPalette palette;
        QString caption;
        enum Flags { Maximized=0x01, Dialog=0x02, Active=0x04 };
        Q_UINT32 flags;
        Q_UINT32 reserved;
    };

Window decorations are loaded by setting the Decoration setting in the Appearance group of Trolltech/qpe, for example:

        [Appearance]
        Decoration=mydecoration

To allow a QWindowDecorationInterface class to be created a plug-in class derived from QWindowDecorationPlugin should be implemented.

Note that Qt Extended includes a decoration plugin that allows basic theming, and this should be used in preference to custom decoration plugins.

See also QWindowDecorationPlugin.

Member Type Documentation

enum QWindowDecorationInterface::Area

enum QWindowDecorationInterface::Button

enum QWindowDecorationInterface::Metric

Member Function Documentation

void QWindowDecorationInterface::drawArea ( Area area, QPainter * p, const WindowData * wd ) const   [virtual]

Draw the specified area using QPainter p for the window defined by wd.

void QWindowDecorationInterface::drawButton ( Button button, QPainter * painter, const WindowData * wd, int x, int y, int w, int h, QDecoration::DecorationState state ) const   [virtual]

Draw button with QPainter painter for the window defined by wd within the bounds supplied by x, y, w, h in the specified state.

QPixmap QWindowDecorationInterface::icon () const   [pure virtual]

Returns the icon of the decoration. This may be displayed in the appearance settings dialog.

QRegion QWindowDecorationInterface::mask ( const WindowData * wd ) const   [virtual]

Returns the mask of the decoration including all borders and the title for the window defined by wd as a QRegion. The window decorations do not necessarily need to be rectangular, however the title bar must be rectangular and must be the width of the window. This ensures the title is drawn correctly for maximized windows.

int QWindowDecorationInterface::metric ( Metric metric, const WindowData * wd ) const   [virtual]

Returns the metric for the window defined by wd.

QString QWindowDecorationInterface::name () const   [pure virtual]

Returns the name of the decoration. This will be displayed in the appearance settings dialog.