• Skip to content
  • Skip to link menu
KDE 4.2 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  KDecoration
 This is the base class for a decoration object. More...
class  KDecorationBridge
 Bridge class for communicating between decorations and KWin core. More...
class  KDecorationDefines
 This class provides a namespace for all decoration related classes. More...
class  KDecorationFactory
class  KDecorationOptions
 This class holds various configuration settings for the decoration. More...
class  KDecorationProvides

Enumerations

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

Functions

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

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 577 of file kcommondecoration.cpp.

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

Definition at line 166 of file kcommondecoration.cpp.

int KCommonDecoration::buttonsLeftWidth (  )  const [inherited]

Definition at line 307 of file kcommondecoration.cpp.

int KCommonDecoration::buttonsRightWidth (  )  const [inherited]

Definition at line 312 of file kcommondecoration.cpp.

QString KCommonDecoration::caption (  )  const [inherited]

Definition at line 1073 of file kcommondecoration.cpp.

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

Definition at line 583 of file kcommondecoration.cpp.

void KCommonDecoration::clearMask (  )  [inherited]

Definition at line 1093 of file kcommondecoration.cpp.

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

Returns:
the mask for the specific window corner.

Definition at line 155 of file kcommondecoration.cpp.

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

Definition at line 1133 of file kcommondecoration.cpp.

KDecoration * KCommonDecoration::decoration (  )  [inherited]

Definition at line 1219 of file kcommondecoration.cpp.

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

Definition at line 1215 of file kcommondecoration.cpp.

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

Returns:
the KCommonDecoration the button belongs to.

Definition at line 910 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 80 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 70 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 75 of file kcommondecoration.cpp.

int KCommonDecoration::desktop (  )  const [inherited]

Definition at line 1025 of file kcommondecoration.cpp.

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

Definition at line 545 of file kcommondecoration.cpp.

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

Definition at line 989 of file kcommondecoration.cpp.

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

Reimplemented from QObject.

Definition at line 841 of file kcommondecoration.cpp.

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

Returns the factory that created this decoration.

Definition at line 880 of file kdecoration.h.

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

Definition at line 1153 of file kcommondecoration.cpp.

QRect KCommonDecoration::geometry (  )  const [inherited]

Definition at line 1101 of file kcommondecoration.cpp.

void KCommonDecoration::grabXServer (  )  [inherited]

Definition at line 1157 of file kcommondecoration.cpp.

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

Convenience function that returns the height of the decoration.

Definition at line 895 of file kdecoration.h.

int KCommonDecoration::height (  )  const [inherited]

Definition at line 1121 of file kcommondecoration.cpp.

QIcon KCommonDecoration::icon (  )  const [inherited]

Definition at line 1069 of file kcommondecoration.cpp.

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

Definition at line 568 of file kcommondecoration.cpp.

QRect KCommonDecoration::iconGeometry (  )  const [inherited]

Definition at line 1105 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 130 of file kcommondecoration.cpp.

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

Definition at line 1137 of file kcommondecoration.cpp.

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

Definition at line 1141 of file kcommondecoration.cpp.

bool KCommonDecoration::isActive (  )  const [inherited]

Definition at line 1001 of file kcommondecoration.cpp.

bool KCommonDecoration::isCloseable (  )  const [inherited]

Definition at line 1005 of file kcommondecoration.cpp.

bool KCommonDecorationButton::isLeft (  )  const [inherited]

Whether the button is left of the titlebar or not.

Definition at line 920 of file kcommondecoration.cpp.

bool KCommonDecoration::isMaximizable (  )  const [inherited]

Definition at line 1009 of file kcommondecoration.cpp.

bool KCommonDecoration::isMinimizable (  )  const [inherited]

Definition at line 1017 of file kcommondecoration.cpp.

bool KCommonDecoration::isModal (  )  const [inherited]

Definition at line 1033 of file kcommondecoration.cpp.

bool KCommonDecoration::isMovable (  )  const [inherited]

Definition at line 1057 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 885 of file kdecoration.h.

bool KCommonDecoration::isOnAllDesktops (  )  const [inherited]

Definition at line 1029 of file kcommondecoration.cpp.

bool KCommonDecoration::isPreview (  )  const [inherited]

Definition at line 1097 of file kcommondecoration.cpp.

bool KCommonDecoration::isResizable (  )  const [inherited]

Definition at line 1061 of file kcommondecoration.cpp.

bool KCommonDecoration::isSetShade (  )  const [inherited]

Definition at line 1045 of file kcommondecoration.cpp.

bool KCommonDecoration::isShade (  )  const [inherited]

Definition at line 1041 of file kcommondecoration.cpp.

bool KCommonDecoration::isShadeable (  )  const [inherited]

Definition at line 1037 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 871 of file kcommondecoration.cpp.

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

Definition at line 47 of file kcommondecoration.cpp.

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

Definition at line 895 of file kcommondecoration.cpp.

bool KCommonDecoration::keepAbove (  )  const [inherited]

Definition at line 1049 of file kcommondecoration.cpp.

bool KCommonDecoration::keepBelow (  )  const [inherited]

Definition at line 1053 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 96 of file kcommondecoration.cpp.

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

Definition at line 532 of file kcommondecoration.cpp.

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

Definition at line 1013 of file kcommondecoration.cpp.

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

Definition at line 521 of file kcommondecoration.cpp.

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

Definition at line 707 of file kcommondecoration.cpp.

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

Definition at line 726 of file kcommondecoration.cpp.

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

Definition at line 968 of file kcommondecoration.cpp.

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

Definition at line 977 of file kcommondecoration.cpp.

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

Definition at line 859 of file kdecoration.h.

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

Definition at line 853 of file kdecoration.h.

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

Definition at line 865 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 997 of file kcommondecoration.cpp.

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

Definition at line 1085 of file kcommondecoration.cpp.

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

Definition at line 1125 of file kcommondecoration.cpp.

bool KCommonDecoration::providesContextHelp (  )  const [inherited]

Definition at line 1021 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 147 of file kcommondecoration.cpp.

void KCommonDecoration::resetButtons (  )  const [inherited]

Manually call reset() on each button.

Definition at line 263 of file kcommondecoration.cpp.

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

Definition at line 516 of file kcommondecoration.cpp.

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

Definition at line 674 of file kcommondecoration.cpp.

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

Definition at line 925 of file kcommondecoration.cpp.

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

Definition at line 1129 of file kcommondecoration.cpp.

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

Definition at line 1089 of file kcommondecoration.cpp.

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

Reimplemented from QAbstractButton.

Definition at line 960 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 930 of file kcommondecoration.cpp.

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

Set the button size.

Definition at line 935 of file kcommondecoration.cpp.

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

Set/update the button's tool tip.

Definition at line 950 of file kcommondecoration.cpp.

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

Reimplemented from QAbstractButton.

Definition at line 954 of file kcommondecoration.cpp.

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

Definition at line 556 of file kcommondecoration.cpp.

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

Definition at line 509 of file kcommondecoration.cpp.

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

Definition at line 1081 of file kcommondecoration.cpp.

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

Definition at line 1077 of file kcommondecoration.cpp.

QSize KCommonDecorationButton::sizeHint (  )  const [inherited]

Definition at line 945 of file kcommondecoration.cpp.

QRect KCommonDecoration::titleRect (  )  const [inherited]

Convenience method.

Returns:
the title rect.

Definition at line 877 of file kcommondecoration.cpp.

ButtonType KCommonDecorationButton::type (  )  const [inherited]

Returns:
the button type.

See also:
ButtonType

Definition at line 915 of file kcommondecoration.cpp.

void KCommonDecoration::ungrabXServer (  )  [inherited]

Definition at line 1161 of file kcommondecoration.cpp.

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

Definition at line 1109 of file kcommondecoration.cpp.

void KCommonDecoration::updateButtons (  )  const [inherited]

Makes sure all buttons are repainted.

Definition at line 257 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 160 of file kcommondecoration.cpp.

void KCommonDecoration::updateLayout (  )  const [inherited]

TODO: remove?

Definition at line 178