• Skip to content
  • Skip to link menu
KDE 4.0 API Reference
  • KDE API Reference
  • API Reference
  • Sitemap
  • Contact Us
 

KWinLibraries

KWin decorations library


Classes

class  KCommonDecoration
 This class eases development of decorations by implementing parts of KDecoration which are error prone and common for most decorations. More...
class  KCommonDecorationButton
 Title bar buttons of KCommonDecoration need to inherit this class. More...
class  KDecorationDefines
 This class provides a namespace for all decoration related classes. More...
class  KDecorationProvides
class  KDecorationOptions
 This class holds various configuration settings for the decoration. More...
class  KDecoration
 This is the base class for a decoration object. More...
class  KDecorationBridge
 Bridge class for communicating between decorations and KWin core. More...
class  KDecorationFactory

Enumerations

enum  ButtonType {
  HelpButton = 0, MaxButton, MinButton, CloseButton,
  MenuButton, OnAllDesktopsButton, AboveButton, BelowButton,
  ShadeButton, NumButtons
}

Functions

KDecorationDefines::MaximizeMode operator^ (KDecorationDefines::MaximizeMode m1, KDecorationDefines::MaximizeMode m2)
KDecorationDefines::MaximizeMode operator & (KDecorationDefines::MaximizeMode m1, KDecorationDefines::MaximizeMode m2)
KDecorationDefines::MaximizeMode operator| (KDecorationDefines::MaximizeMode m1, KDecorationDefines::MaximizeMode m2)
 KCommonDecoration::KCommonDecoration (KDecorationBridge *bridge, KDecorationFactory *factory)
virtual KCommonDecoration::~KCommonDecoration ()
virtual QString KCommonDecoration::defaultButtonsLeft () const
virtual QString KCommonDecoration::defaultButtonsRight () const
virtual bool KCommonDecoration::decorationBehaviour (DecorationBehaviour behaviour) const
virtual int KCommonDecoration::layoutMetric (LayoutMetric lm, bool respectWindowState=true, const KCommonDecorationButton *button=0) const
virtual void KCommonDecoration::init ()
virtual void KCommonDecoration::reset (unsigned long changed)
virtual QRegion KCommonDecoration::cornerShape (WindowCorner corner)
virtual void KCommonDecoration::updateCaption ()
virtual void KCommonDecoration::borders (int &left, int &right, int &top, int &bottom) const
void KCommonDecoration::updateLayout () const
void KCommonDecoration::updateButtons () const
void KCommonDecoration::resetButtons () const
int KCommonDecoration::buttonsLeftWidth () const
int KCommonDecoration::buttonsRightWidth () const
virtual void KCommonDecoration::show ()
virtual void KCommonDecoration::resize (const QSize &s)
virtual QSize KCommonDecoration::minimumSize () const
virtual void KCommonDecoration::maximizeChange ()
virtual void KCommonDecoration::desktopChange ()
virtual void KCommonDecoration::shadeChange ()
virtual void KCommonDecoration::iconChange ()
virtual void KCommonDecoration::activeChange ()
virtual void KCommonDecoration::captionChange ()
virtual void KCommonDecoration::resizeEvent (QResizeEvent *e)
virtual void KCommonDecoration::mouseDoubleClickEvent (QMouseEvent *e)
virtual void KCommonDecoration::wheelEvent (QWheelEvent *e)
virtual Position KCommonDecoration::mousePosition (const QPoint &point) const
virtual void KCommonDecoration::updateWindowShape ()
virtual bool KCommonDecoration::eventFilter (QObject *o, QEvent *e)
bool KCommonDecoration::isToolWindow () const
QRect KCommonDecoration::titleRect () const
 KCommonDecorationButton::KCommonDecorationButton (ButtonType type, KCommonDecoration *parent)
virtual KCommonDecorationButton::~KCommonDecorationButton ()
KCommonDecoration * KCommonDecorationButton::decoration () const
ButtonType KCommonDecorationButton::type () const
bool KCommonDecorationButton::isLeft () const
void KCommonDecorationButton::setLeft (bool left)
void KCommonDecorationButton::setRealizeButtons (int btns)
void KCommonDecorationButton::setSize (const QSize &s)
QSize KCommonDecorationButton::sizeHint () const
void KCommonDecorationButton::setTipText (const QString &tip)
void KCommonDecorationButton::setToggleButton (bool toggle)
void KCommonDecorationButton::setOn (bool on)
void KCommonDecorationButton::mousePressEvent (QMouseEvent *e)
void KCommonDecorationButton::mouseReleaseEvent (QMouseEvent *e)
virtual bool KCommonDecoration::drawbound (const QRect &geom, bool clear)
virtual bool KCommonDecoration::windowDocked (Position side)
static const KDecorationOptions * KCommonDecoration::options ()
bool KCommonDecoration::isActive () const
bool KCommonDecoration::isCloseable () const
bool KCommonDecoration::isMaximizable () const
MaximizeMode KCommonDecoration::maximizeMode () const
bool KCommonDecoration::isMinimizable () const
bool KCommonDecoration::providesContextHelp () const
int KCommonDecoration::desktop () const
bool KCommonDecoration::isOnAllDesktops () const
bool KCommonDecoration::isModal () const
bool KCommonDecoration::isShadeable () const
bool KCommonDecoration::isShade () const
bool KCommonDecoration::isSetShade () const
bool KCommonDecoration::keepAbove () const
bool KCommonDecoration::keepBelow () const
bool KCommonDecoration::isMovable () const
bool KCommonDecoration::isResizable () const
NET::WindowType KCommonDecoration::windowType (unsigned long supported_types) const
QIcon KCommonDecoration::icon () const
QString KCommonDecoration::caption () const
void KCommonDecoration::showWindowMenu (const QRect &pos)
void KCommonDecoration::showWindowMenu (QPoint pos)
void KCommonDecoration::performWindowOperation (WindowOperation op)
void KCommonDecoration::setMask (const QRegion &reg, int mode=0)
void KCommonDecoration::clearMask ()
bool KCommonDecoration::isPreview () const
QRect KCommonDecoration::geometry () const
QRect KCommonDecoration::iconGeometry () const
QRegion KCommonDecoration::unobscuredRegion (const QRegion &r) const
WId KCommonDecoration::windowId () const
int KCommonDecoration::width () const
int KCommonDecoration::height () const
void KCommonDecoration::processMousePressEvent (QMouseEvent *e)
void KCommonDecoration::setMainWidget (QWidget *)
void KCommonDecoration::createMainWidget (Qt::WFlags flags=0)
QWidget * KCommonDecoration::initialParentWidget () const
Qt::WFlags KCommonDecoration::initialWFlags () const
QWidget * KCommonDecoration::widget ()
const QWidget * KCommonDecoration::widget () const
KDecorationFactory * KCommonDecoration::factory () const
void KCommonDecoration::grabXServer ()
void KCommonDecoration::ungrabXServer ()
const KDecoration * KCommonDecoration::decoration () const
KDecoration * KCommonDecoration::decoration ()
QWidget * KDecoration::widget ()
const QWidget * KDecoration::widget () const
KDecorationFactory * KDecoration::factory () const
bool KDecoration::isOnAllDesktops () const
int KDecoration::width () const
int KDecoration::height () const
const KDecorationOptions * KDecorationFactory::options ()

Variables

const int SUPPORTED_WINDOW_TYPES_MASK

Enumeration Type Documentation

enum ButtonType

Enumerator:
HelpButton 
MaxButton 
MinButton 
CloseButton 
MenuButton 
OnAllDesktopsButton 
AboveButton 
BelowButton 
ShadeButton 
NumButtons 

Definition at line 37 of file kcommondecoration.h.

Function Documentation

void KCommonDecoration::activeChange (  )  [virtual, inherited]

Definition at line 578 of file kcommondecoration.cpp.

void KCommonDecoration::borders ( int &  left,
int &  right,
int &  top,
int &  bottom 
) const [virtual, inherited]

Definition at line 167 of file kcommondecoration.cpp.

int KCommonDecoration::buttonsLeftWidth (  )  const [inherited]

Definition at line 308 of file kcommondecoration.cpp.

int KCommonDecoration::buttonsRightWidth (  )  const [inherited]

Definition at line 313 of file kcommondecoration.cpp.

QString KCommonDecoration::caption (  )  const [inherited]

Definition at line 1074 of file kcommondecoration.cpp.

void KCommonDecoration::captionChange (  )  [virtual, inherited]

Definition at line 584 of file kcommondecoration.cpp.

void KCommonDecoration::clearMask (  )  [inherited]

Definition at line 1094 of file kcommondecoration.cpp.

QRegion KCommonDecoration::cornerShape ( WindowCorner  corner  )  [virtual, inherited]

Returns:
the mask for the specific window corner.

Definition at line 156 of file kcommondecoration.cpp.

void KCommonDecoration::createMainWidget ( Qt::WFlags  flags = 0  )  [inherited]

Definition at line 1134 of file kcommondecoration.cpp.

KDecoration * KCommonDecoration::decoration (  )  [inherited]

Definition at line 1220 of file kcommondecoration.cpp.

const KDecoration * KCommonDecoration::decoration (  )  const [inherited]

Definition at line 1216 of file kcommondecoration.cpp.

KCommonDecoration * KCommonDecorationButton::decoration (  )  const [inherited]

Returns:
the KCommonDecoration the button belongs to.

Definition at line 911 of file kcommondecoration.cpp.

bool KCommonDecoration::decorationBehaviour ( DecorationBehaviour  behaviour  )  const [virtual, inherited]

This controls whether some specific behaviour should be enabled or not.

See also:
DecorationBehaviour

Definition at line 81 of file kcommondecoration.cpp.

QString KCommonDecoration::defaultButtonsLeft (  )  const [virtual, inherited]

The default title button order on the left.

See also:
KDecoration::titleButtonsLeft()

KDecoration::titleButtonsRight()

Definition at line 71 of file kcommondecoration.cpp.

QString KCommonDecoration::defaultButtonsRight (  )  const [virtual, inherited]

The default title button order on the left.

See also:
KDecoration::titleButtonsLeft()

KDecoration::titleButtonsRight()

Definition at line 76 of file kcommondecoration.cpp.

int KCommonDecoration::desktop (  )  const [inherited]

Definition at line 1026 of file kcommondecoration.cpp.

void KCommonDecoration::desktopChange (  )  [virtual, inherited]

Definition at line 546 of file kcommondecoration.cpp.

bool KCommonDecoration::drawbound ( const QRect &  geom,
bool  clear 
) [virtual, inherited]

Definition at line 990 of file kcommondecoration.cpp.

bool KCommonDecoration::eventFilter ( QObject *  o,
QEvent *  e 
) [virtual, inherited]

Reimplemented from QObject.

Definition at line 842 of file kcommondecoration.cpp.

KDecorationFactory * KDecoration::factory (  )  const [inline, inherited]

Returns the factory that created this decoration.

Definition at line 878 of file kdecoration.h.

KDecorationFactory * KCommonDecoration::factory (  )  const [inherited]

Definition at line 1154 of file kcommondecoration.cpp.

QRect KCommonDecoration::geometry (  )  const [inherited]

Definition at line 1102 of file kcommondecoration.cpp.

void KCommonDecoration::grabXServer (  )  [inherited]

Definition at line 1158 of file kcommondecoration.cpp.

int KDecoration::height (  )  const [inline, inherited]

Convenience function that returns the height of the decoration.

Definition at line 893 of file kdecoration.h.

int KCommonDecoration::height (  )  const [inherited]

Definition at line 1122 of file kcommondecoration.cpp.

QIcon KCommonDecoration::icon (  )  const [inherited]

Definition at line 1070 of file kcommondecoration.cpp.

void KCommonDecoration::iconChange (  )  [virtual, inherited]

Definition at line 569 of file kcommondecoration.cpp.

QRect KCommonDecoration::iconGeometry (  )  const [inherited]

Definition at line 1106 of file kcommondecoration.cpp.

void KCommonDecoration::init (  )  [virtual, inherited]

Handles widget and layout creation, call the base implementation when subclassing this member.

Definition at line 131 of file kcommondecoration.cpp.

QWidget * KCommonDecoration::initialParentWidget (  )  const [inherited]

Definition at line 1138 of file kcommondecoration.cpp.

Qt::WFlags KCommonDecoration::initialWFlags (  )  const [inherited]

Definition at line 1142 of file kcommondecoration.cpp.

bool KCommonDecoration::isActive (  )  const [inherited]

Definition at line 1002 of file kcommondecoration.cpp.

bool KCommonDecoration::isCloseable (  )  const [inherited]

Definition at line 1006 of file kcommondecoration.cpp.

bool KCommonDecorationButton::isLeft (  )  const [inherited]

Whether the button is left of the titlebar or not.

Definition at line 921 of file kcommondecoration.cpp.

bool KCommonDecoration::isMaximizable (  )  const [inherited]

Definition at line 1010 of file kcommondecoration.cpp.

bool KCommonDecoration::isMinimizable (  )  const [inherited]

Definition at line 1018 of file kcommondecoration.cpp.

bool KCommonDecoration::isModal (  )  const [inherited]

Definition at line 1034 of file kcommondecoration.cpp.

bool KCommonDecoration::isMovable (  )  const [inherited]

Definition at line 1058 of file kcommondecoration.cpp.

bool KDecoration::isOnAllDesktops (  )  const [inline, inherited]

Convenience function that returns true if the window is on all virtual desktops.

Definition at line 883 of file kdecoration.h.

bool KCommonDecoration::isOnAllDesktops (  )  const [inherited]

Definition at line 1030 of file kcommondecoration.cpp.

bool KCommonDecoration::isPreview (  )  const [inherited]

Definition at line 1098 of file kcommondecoration.cpp.

bool KCommonDecoration::isResizable (  )  const [inherited]

Definition at line 1062 of file kcommondecoration.cpp.

bool KCommonDecoration::isSetShade (  )  const [inherited]

Definition at line 1046 of file kcommondecoration.cpp.

bool KCommonDecoration::isShade (  )  const [inherited]

Definition at line 1042 of file kcommondecoration.cpp.

bool KCommonDecoration::isShadeable (  )  const [inherited]

Definition at line 1038 of file kcommondecoration.cpp.

bool KCommonDecoration::isToolWindow (  )  const [inherited]

Convenience method.

Returns:
true if the window type is NET::Toolbar, NET::Utility, or NET::Menu

Definition at line 872 of file kcommondecoration.cpp.

KCommonDecoration::KCommonDecoration ( KDecorationBridge *  bridge,
KDecorationFactory *  factory 
) [inherited]

Definition at line 48 of file kcommondecoration.cpp.

KCommonDecorationButton::KCommonDecorationButton ( ButtonType  type,
KCommonDecoration *  parent 
) [inherited]

Definition at line 896 of file kcommondecoration.cpp.

bool KCommonDecoration::keepAbove (  )  const [inherited]

Definition at line 1050 of file kcommondecoration.cpp.

bool KCommonDecoration::keepBelow (  )  const [inherited]

Definition at line 1054 of file kcommondecoration.cpp.

int KCommonDecoration::layoutMetric ( LayoutMetric  lm,
bool  respectWindowState = true,
const KCommonDecorationButton *  button = 0 
) const [virtual, inherited]

This controls the layout of the decoration in various ways.

It is possible to have a different layout for different window states.

Parameters:
lm The layout element.
respectWindowState Whether window states should be taken into account or a "default" state should be assumed.
button For LM_ButtonWidth and LM_ButtonHeight, the button.

Definition at line 97 of file kcommondecoration.cpp.

void KCommonDecoration::maximizeChange (  )  [virtual, inherited]

Definition at line 533 of file kcommondecoration.cpp.

KCommonDecoration::MaximizeMode KCommonDecoration::maximizeMode (  )  const [inherited]

Definition at line 1014 of file kcommondecoration.cpp.

QSize KCommonDecoration::minimumSize (  )  const [virtual, inherited]

Definition at line 522 of file kcommondecoration.cpp.

void KCommonDecoration::mouseDoubleClickEvent ( QMouseEvent *  e  )  [virtual, inherited]

Definition at line 708 of file kcommondecoration.cpp.

KCommonDecoration::Position KCommonDecoration::mousePosition ( const QPoint &  point  )  const [virtual, inherited]

Definition at line 727 of file kcommondecoration.cpp.

void KCommonDecorationButton::mousePressEvent ( QMouseEvent *  e  )  [protected, inherited]

Definition at line 969 of file kcommondecoration.cpp.

void KCommonDecorationButton::mouseReleaseEvent ( QMouseEvent *  e  )  [protected, inherited]

Definition at line 978 of file kcommondecoration.cpp.

KDecorationDefines::MaximizeMode operator & ( KDecorationDefines::MaximizeMode  m1,
KDecorationDefines::MaximizeMode  m2 
) [inline]

Definition at line 857 of file kdecoration.h.

KDecorationDefines::MaximizeMode operator^ ( KDecorationDefines::MaximizeMode  m1,
KDecorationDefines::MaximizeMode  m2 
) [inline]

Definition at line 851 of file kdecoration.h.

KDecorationDefines::MaximizeMode operator| ( KDecorationDefines::MaximizeMode  m1,
KDecorationDefines::MaximizeMode  m2 
) [inline]

Definition at line 863 of file kdecoration.h.

const KDecorationOptions * KDecorationFactory::options (  )  [inline, inherited]

Returns the KDecorationOptions object, which is used to access configuration settings for the decoration.

Definition at line 118 of file kdecorationfactory.h.

const KDecorationOptions * KCommonDecoration::options (  )  [static, inherited]

Definition at line 998 of file kcommondecoration.cpp.

void KCommonDecoration::performWindowOperation ( WindowOperation  op  )  [inherited]

Definition at line 1086 of file kcommondecoration.cpp.

void KCommonDecoration::processMousePressEvent ( QMouseEvent *  e  )  [inherited]

Definition at line 1126 of file kcommondecoration.cpp.

bool KCommonDecoration::providesContextHelp (  )  const [inherited]

Definition at line 1022 of file kcommondecoration.cpp.

void KCommonDecoration::reset ( unsigned long  changed  )  [virtual, inherited]

Handles SettingButtons, call the base implementation when subclassing this member.

Definition at line 148 of file kcommondecoration.cpp.

void KCommonDecoration::resetButtons (  )  const [inherited]

Manually call reset() on each button.

Definition at line 264 of file kcommondecoration.cpp.

void KCommonDecoration::resize ( const QSize &  s  )  [virtual, inherited]

Definition at line 517 of file kcommondecoration.cpp.

void KCommonDecoration::resizeEvent ( QResizeEvent *  e  )  [virtual, inherited]

Definition at line 675 of file kcommondecoration.cpp.

void KCommonDecorationButton::setLeft ( bool  left  )  [protected, inherited]

Definition at line 926 of file kcommondecoration.cpp.

void KCommonDecoration::setMainWidget ( QWidget *  w  )  [inherited]

Definition at line 1130 of file kcommondecoration.cpp.

void KCommonDecoration::setMask ( const QRegion &  reg,
int  mode = 0 
) [inherited]

Definition at line 1090 of file kcommondecoration.cpp.

void KCommonDecorationButton::setOn ( bool  on  )  [protected, inherited]

Reimplemented from QAbstractButton.

Definition at line 961 of file kcommondecoration.cpp.

void KCommonDecorationButton::setRealizeButtons ( int  btns  )  [inherited]

Set which mouse buttons the button should honor.

Used e.g. to prevent accidental right mouse clicks.

Definition at line 931 of file kcommondecoration.cpp.

void KCommonDecorationButton::setSize ( const QSize &  s  )  [inherited]

Set the button size.

Definition at line 936 of file kcommondecoration.cpp.

void KCommonDecorationButton::setTipText ( const QString &  tip  )  [inherited]

Set/update the button's tool tip.

Definition at line 951 of file kcommondecoration.cpp.

void KCommonDecorationButton::setToggleButton ( bool  toggle  )  [protected, inherited]

Reimplemented from QAbstractButton.

Definition at line 955 of file kcommondecoration.cpp.

void KCommonDecoration::shadeChange (  )  [virtual, inherited]

Definition at line 557 of file kcommondecoration.cpp.

void KCommonDecoration::show (  )  [virtual, inherited]

Definition at line 510 of file kcommondecoration.cpp.

void KCommonDecoration::showWindowMenu ( QPoint  pos  )  [inherited]

Definition at line 1082 of file kcommondecoration.cpp.

void KCommonDecoration::showWindowMenu ( const QRect &  pos  )  [inherited]

Definition at line 1078 of file kcommondecoration.cpp.

QSize KCommonDecorationButton::sizeHint (  )  const [inherited]

Definition at line 946 of file kcommondecoration.cpp.

QRect KCommonDecoration::titleRect (  )  const [inherited]

Convenience method.

Returns:
the title rect.

Definition at line 878 of file kcommondecoration.cpp.

ButtonType KCommonDecorationButton::type (  )  const [inherited]

Returns:
the button type.

See also:
ButtonType

Definition at line 916 of file kcommondecoration.cpp.

void KCommonDecoration::ungrabXServer (  )  [inherited]

Definition at line 1162 of file kcommondecoration.cpp.

QRegion KCommonDecoration::unobscuredRegion ( const QRegion &  r  )  const [inherited]

Definition at line 1110 of file kcommondecoration.cpp.

void KCommonDecoration::updateButtons (  )  const [inherited]

Makes sure all buttons are repainted.

Definition at line 258 of file kcommondecoration.cpp.

void KCommonDecoration::updateCaption (  )  [virtual, inherited]

This is used to update the painting of the title bar after the caption has been changed.

Reimplement for a more efficient implementation (default calls update() on the whole decoration).

Definition at line 161 of file kcommondecoration.cpp.

void KCommonDecoration::updateLayout (  )  const [inherited]

TODO: remove?

Definition at line 179 of file kcommondecoration.cpp.

void KCommonDecoration::updateWindowShape (  )  [virtual, inherited]

This updates the window mask using the information provided by cornerShape().

Edges which are aligned to screen corners are not shaped for better usability (remember to paint these areas in paintEvent(), too). You normally don't want/need to reimplement updateWindowShape().

See also:
cornerShape()

Definition at line 792 of file kcommondecoration.cpp.

void KCommonDecoration::wheelEvent ( QWheelEvent *  e  )  [virtual, inherited]

Definition at line 720 of file kcommondecoration.cpp.

const QWidget * KDecoration::widget (  )  const [inline, inherited]

Returns the main widget for the decoration.

Definition at line 873 of file kdecoration.h.

QWidget * KDecoration::widget (  )  [inline, inherited]

Returns the main widget for the decoration.

Definition at line 868 of file kdecoration.h.

const QWidget * KCommonDecoration::widget (  )  const [inherited]

Definition at line 1150 of file kcommondecoration.cpp.

QWidget * KCommonDecoration::widget (  )  [inherited]

Definition at line 1146 of file kcommondecoration.cpp.

int KDecoration::width (  )  const [inline, inherited]

Convenience function that returns the width of the decoration.

Definition at line 888 of file kdecoration.h.

int KCommonDecoration::width (  )  const [inherited]

Definition at line 1118 of file kcommondecoration.cpp.

bool KCommonDecoration::windowDocked ( Position  side  )  [virtual, inherited]

Definition at line 994 of file kcommondecoration.cpp.

WId KCommonDecoration::windowId (  )  const [inherited]

Definition at line 1114 of file kcommondecoration.cpp.

NET::WindowType KCommonDecoration::windowType ( unsigned long  supported_types  )  const [inherited]

Definition at line 1066 of file kcommondecoration.cpp.

KCommonDecoration::~KCommonDecoration (  )  [virtual, inherited]

Definition at line 62 of file kcommondecoration.cpp.

KCommonDecorationButton::~KCommonDecorationButton (  )  [virtual, inherited]

Definition at line 907 of file kcommondecoration.cpp.

Variable Documentation

const int SUPPORTED_WINDOW_TYPES_MASK

Initial value:

 NET::NormalMask | NET::DesktopMask | NET::DockMask
        | NET::ToolbarMask | NET::MenuMask | NET::DialogMask  | NET::TopMenuMask
        | NET::UtilityMask | NET::SplashMask

Definition at line 868 of file kcommondecoration.cpp.

KWinLibraries

Skip menu "KWinLibraries"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

API Reference

Skip menu "API Reference"
  • KWin
  •   KWin Libraries
  • Libraries
  •   libkworkspace
  •   libplasma
  • Plasma
  •   Animators
  •   Applets
  •   Engines
  • Solid Modules
Generated for API Reference by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal