KWin decorations library

Classes
class	ClientGroupItem
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	KCommonDecorationUnstable
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	KDecorationBridgeUnstable
class	KDecorationDefines
	This class provides a namespace for all decoration related classes. More...
class	KDecorationFactory
class	KDecorationFactoryUnstable
class	KDecorationOptions
	This class holds various configuration settings for the decoration. More...
class	KDecorationProvides
class	KDecorationUnstable
Enumerations
enum	ButtonType {   HelpButton = 0, MaxButton, MinButton, CloseButton,   MenuButton, OnAllDesktopsButton, AboveButton, BelowButton,   ShadeButton, NumButtons, ItemCloseButton = 100, ItemMenuButton }
Functions
	KCommonDecoration::KCommonDecoration (KDecorationBridge *bridge, KDecorationFactory *factory)
	KCommonDecorationButton::KCommonDecorationButton (ButtonType type, KCommonDecoration *parent)
	KCommonDecorationUnstable::KCommonDecorationUnstable (KDecorationBridge *bridge, KDecorationFactory *factory)
virtual	KCommonDecoration::~KCommonDecoration ()
virtual	KCommonDecorationButton::~KCommonDecorationButton ()
virtual	KCommonDecorationUnstable::~KCommonDecorationUnstable ()
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
WindowOperation	KCommonDecorationUnstable::buttonToWindowOperation (Qt::MouseButtons button)
QString	KCommonDecoration::caption () const
virtual void	KCommonDecoration::captionChange ()
void	KCommonDecoration::clearMask ()
QList< ClientGroupItem >	KCommonDecorationUnstable::clientGroupItems () const
void	KCommonDecorationUnstable::closeAllInClientGroup ()
void	KCommonDecorationUnstable::closeClientGroupItem (int index)
bool	KCommonDecorationUnstable::compositingActive () const
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 ()
void	KCommonDecorationUnstable::displayClientMenu (int index, const QPoint &pos)
virtual bool	KCommonDecoration::drawbound (const QRect &geom, bool clear)
virtual bool	KCommonDecorationUnstable::eventFilter (QObject *o, QEvent *e)
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	KCommonDecorationUnstable::isClientGroupActive ()
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
long	KCommonDecorationUnstable::itemId (int index)
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)
void	KCommonDecorationUnstable::moveItemInClientGroup (int index, int before)
void	KCommonDecorationUnstable::moveItemToClientGroup (long itemId, int before=-1)
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
void	KCommonDecorationUnstable::removeFromClientGroup (int index, const QRect &newGeom=QRect())
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)
void	KCommonDecorationUnstable::setVisibleClientGroupItem (int index)
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 ()
int	KCommonDecorationUnstable::visibleClientGroupItem ()
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
Variables
const int	SUPPORTED_WINDOW_TYPES_MASK
Public Slots
void	KCommonDecoration::closeWindow ()
void	KCommonDecoration::keepAboveChange (bool above)
void	KCommonDecoration::keepBelowChange (bool below)
void	KCommonDecoration::maximize (MaximizeMode mode)
void	KCommonDecoration::maximize (Qt::MouseButtons button)
void	KCommonDecoration::menuButtonPressed ()
void	KCommonDecoration::menuButtonReleased ()
void	KCommonDecoration::minimize ()
void	KCommonDecoration::setDesktop (int desktop)
void	KCommonDecoration::setKeepAbove (bool set)
void	KCommonDecoration::setKeepBelow (bool set)
void	KCommonDecoration::setShade (bool set)
void	KCommonDecoration::showContextHelp ()
void	KCommonDecoration::slotKeepAbove ()
void	KCommonDecoration::slotKeepBelow ()
void	KCommonDecoration::slotMaximize ()
void	KCommonDecoration::slotShade ()
void	KCommonDecoration::titlebarDblClickOperation ()
void	KCommonDecoration::titlebarMouseWheelOperation (int delta)
void	KCommonDecoration::toggleOnAllDesktops ()

---

Enumeration Type Documentation

enum ButtonType

Enumerator:

HelpButton
MaxButton
MinButton
CloseButton
MenuButton
OnAllDesktopsButton
AboveButton
BelowButton
ShadeButton
NumButtons
ItemCloseButton
ItemMenuButton

Definition at line 37 of file kcommondecoration.h.

---

Function Documentation

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

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

Definition at line 1266 of file kcommondecoration.cpp.

KCommonDecoration::~KCommonDecoration

(

)

[virtual, inherited]

Definition at line 62 of file kcommondecoration.cpp.

KCommonDecorationButton::~KCommonDecorationButton

(

)

[virtual, inherited]

Definition at line 947 of file kcommondecoration.cpp.

KCommonDecorationUnstable::~KCommonDecorationUnstable

(

)

[virtual, inherited]

Definition at line 1272 of file kcommondecoration.cpp.

void KCommonDecoration::activeChange

(

)

[virtual, inherited]

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

int KCommonDecoration::buttonsRightWidth

(

)

const [inherited]

Definition at line 343 of file kcommondecoration.cpp.

KDecoration::WindowOperation KCommonDecorationUnstable::buttonToWindowOperation

(

Qt::MouseButtons

button

)

[inherited]

Definition at line 1339 of file kcommondecoration.cpp.

QString KCommonDecoration::caption

(

)

const [inherited]

Definition at line 1114 of file kcommondecoration.cpp.

void KCommonDecoration::captionChange

(

)

[virtual, inherited]

Definition at line 641 of file kcommondecoration.cpp.

void KCommonDecoration::clearMask

(

)

[inherited]

Definition at line 1134 of file kcommondecoration.cpp.

QList< ClientGroupItem > KCommonDecorationUnstable::clientGroupItems

(

)

const [inherited]

Definition at line 1289 of file kcommondecoration.cpp.

void KCommonDecorationUnstable::closeAllInClientGroup

(

)

[inherited]

Definition at line 1329 of file kcommondecoration.cpp.

void KCommonDecorationUnstable::closeClientGroupItem

(

int

index

)

[inherited]

Definition at line 1324 of file kcommondecoration.cpp.

bool KCommonDecorationUnstable::compositingActive

(

)

const [inherited]

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

KDecoration * KCommonDecoration::decoration

(

)

[inherited]

Definition at line 1260 of file kcommondecoration.cpp.

const KDecoration * KCommonDecoration::decoration

(

)

const [inherited]

Definition at line 1256 of file kcommondecoration.cpp.

KCommonDecoration * KCommonDecorationButton::decoration

(

)

const [inherited]

Returns:

the KCommonDecoration the button belongs to.

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

void KCommonDecoration::desktopChange

(

)

[virtual, inherited]

Definition at line 603 of file kcommondecoration.cpp.

void KCommonDecorationUnstable::displayClientMenu	(	int	index,
		const QPoint &	pos
	)			[inherited]

Definition at line 1334 of file kcommondecoration.cpp.

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

Definition at line 1030 of file kcommondecoration.cpp.

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

Reimplemented from KCommonDecoration.

Definition at line 1344 of file kcommondecoration.cpp.

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

Reimplemented in KCommonDecorationUnstable.

Definition at line 876 of file kcommondecoration.cpp.

KDecorationFactory * KDecoration::factory

(

)

const [inline, inherited]

Returns the factory that created this decoration.

Definition at line 1018 of file kdecoration.h.

KDecorationFactory * KCommonDecoration::factory

(

)

const [inherited]

Definition at line 1194 of file kcommondecoration.cpp.

QRect KCommonDecoration::geometry

(

)

const [inherited]

Definition at line 1142 of file kcommondecoration.cpp.

void KCommonDecoration::grabXServer

(

)

[inherited]

Definition at line 1198 of file kcommondecoration.cpp.

int KDecoration::height

(

)

const [inline, inherited]

Convenience function that returns the height of the decoration.

Definition at line 1033 of file kdecoration.h.

int KCommonDecoration::height

(

)

const [inherited]

Definition at line 1162 of file kcommondecoration.cpp.

QIcon KCommonDecoration::icon

(

)

const [inherited]

Definition at line 1110 of file kcommondecoration.cpp.

void KCommonDecoration::iconChange

(

)

[virtual, inherited]

Definition at line 626 of file kcommondecoration.cpp.

QRect KCommonDecoration::iconGeometry

(

)

const [inherited]

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

Qt::WFlags KCommonDecoration::initialWFlags

(

)

const [inherited]

Definition at line 1182 of file kcommondecoration.cpp.

bool KCommonDecoration::isActive

(

)

const [inherited]

Definition at line 1042 of file kcommondecoration.cpp.

bool KCommonDecorationUnstable::isClientGroupActive

(

)

[inherited]

Definition at line 1284 of file kcommondecoration.cpp.

bool KCommonDecoration::isCloseable

(

)

const [inherited]

Definition at line 1046 of file kcommondecoration.cpp.

bool KCommonDecorationButton::isLeft

(

)

const [inherited]

Whether the button is left of the titlebar or not.

Definition at line 961 of file kcommondecoration.cpp.

bool KCommonDecoration::isMaximizable

(

)

const [inherited]

Definition at line 1050 of file kcommondecoration.cpp.

bool KCommonDecoration::isMinimizable

(

)

const [inherited]

Definition at line 1058 of file kcommondecoration.cpp.

bool KCommonDecoration::isModal

(

)

const [inherited]

Definition at line 1074 of file kcommondecoration.cpp.

bool KCommonDecoration::isMovable

(

)

const [inherited]

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

bool KCommonDecoration::isOnAllDesktops

(

)

const [inherited]

Definition at line 1070 of file kcommondecoration.cpp.

bool KCommonDecoration::isPreview

(

)

const [inherited]

Definition at line 1138 of file kcommondecoration.cpp.

bool KCommonDecoration::isResizable

(

)

const [inherited]

Definition at line 1102 of file kcommondecoration.cpp.

bool KCommonDecoration::isSetShade

(

)

const [inherited]

Definition at line 1086 of file kcommondecoration.cpp.

bool KCommonDecoration::isShade

(

)

const [inherited]

Definition at line 1082 of file kcommondecoration.cpp.

bool KCommonDecoration::isShadeable

(

)

const [inherited]

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

long KCommonDecorationUnstable::itemId

(

int

index

)

[inherited]

Definition at line 1294 of file kcommondecoration.cpp.

bool KCommonDecoration::keepAbove

(

)

const [inherited]

Definition at line 1090 of file kcommondecoration.cpp.

bool KCommonDecoration::keepBelow

(

)

const [inherited]

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

KCommonDecoration::MaximizeMode KCommonDecoration::maximizeMode

(

)

const [inherited]

Definition at line 1054 of file kcommondecoration.cpp.

QSize KCommonDecoration::minimumSize

(

)

const [virtual, inherited]

Definition at line 579 of file kcommondecoration.cpp.

void KCommonDecoration::mouseDoubleClickEvent

(

QMouseEvent *

e

)

[virtual, inherited]

Definition at line 765 of file kcommondecoration.cpp.

KCommonDecoration::Position KCommonDecoration::mousePosition

(

const QPoint &

point

)

const [virtual, inherited]

Definition at line 786 of file kcommondecoration.cpp.

void KCommonDecorationButton::mousePressEvent

(

QMouseEvent *

e

)

[protected, inherited]

Definition at line 1009 of file kcommondecoration.cpp.

void KCommonDecorationButton::mouseReleaseEvent

(

QMouseEvent *

e

)

[protected, inherited]

Definition at line 1018 of file kcommondecoration.cpp.

void KCommonDecorationUnstable::moveItemInClientGroup	(	int	index,
		int	before
	)			[inherited]

Definition at line 1309 of file kcommondecoration.cpp.

void KCommonDecorationUnstable::moveItemToClientGroup	(	long	itemId,
		int	before = -1
	)			[inherited]

Definition at line 1314 of file kcommondecoration.cpp.

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

Definition at line 997 of file kdecoration.h.

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

Definition at line 991 of file kdecoration.h.

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

Definition at line 1003 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 127 of file kdecorationfactory.h.

const KDecorationOptions * KCommonDecoration::options

(

)

[static, inherited]

Definition at line 1038 of file kcommondecoration.cpp.

void KCommonDecoration::performWindowOperation

(

WindowOperation

op

)

[inherited]

Definition at line 1126 of file kcommondecoration.cpp.

void KCommonDecoration::processMousePressEvent

(

QMouseEvent *

e

)

[inherited]

Definition at line 1166 of file kcommondecoration.cpp.

bool KCommonDecoration::providesContextHelp

(

)

const [inherited]

Definition at line 1062 of file kcommondecoration.cpp.

void KCommonDecorationUnstable::removeFromClientGroup	(	int	index,
		const QRect &	newGeom = QRect()
	)			[inherited]

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

void KCommonDecoration::resize

(

const QSize &

s

)

[virtual, inherited]

Definition at line 574 of file kcommondecoration.cpp.

void KCommonDecoration::resizeEvent

(

QResizeEvent *

e

)

[virtual, inherited]

Definition at line 732 of file kcommondecoration.cpp.

void KCommonDecorationButton::setLeft

(

bool

left

)

[protected, inherited]

Definition at line 966 of file kcommondecoration.cpp.

void KCommonDecoration::setMainWidget

(

QWidget *

w

)

[inherited]

Definition at line 1170 of file kcommondecoration.cpp.

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

Definition at line 1130 of file kcommondecoration.cpp.

void KCommonDecorationButton::setOn

(

bool

on

)

[protected, inherited]

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

void KCommonDecorationButton::setSize

(

const QSize &

s

)

[inherited]

Set the button size.

Definition at line 976 of file kcommondecoration.cpp.

void KCommonDecorationButton::setTipText

(

const QString &

tip

)

[inherited]

Set/update the button's tool tip.

Definition at line 991 of file kcommondecoration.cpp.

void KCommonDecorationButton::setToggleButton

(

bool

toggle

)

[protected, inherited]

Definition at line 995 of file kcommondecoration.cpp.

void KCommonDecorationUnstable::setVisibleClientGroupItem

(

int

index

)

[inherited]

Definition at line 1304 of file kcommondecoration.cpp.

void KCommonDecoration::shadeChange

(

)

[virtual, inherited]

Definition at line 614 of file kcommondecoration.cpp.

void KCommonDecoration::show

(

)

[virtual, inherited]

Definition at line 567 of file kcommondecoration.cpp.

void KCommonDecoration::showWindowMenu

(

QPoint

pos

)

[inherited]

Definition at line 1122 of file kcommondecoration.cpp.

void KCommonDecoration::showWindowMenu

(

const QRect &

pos

)

[inherited]

Definition at line 1118 of file kcommondecoration.cpp.

QSize KCommonDecorationButton::sizeHint

(

)

const [inherited]

Definition at line 986 of file kcommondecoration.cpp.

QRect KCommonDecoration::titleRect

(

)

const [inherited]

Convenience method.

Returns:

the title rect.

Definition at line 912 of file kcommondecoration.cpp.

ButtonType KCommonDecorationButton::type

(

)

const [inherited]

Returns:

the button type.

See also:

ButtonType

Definition at line 956 of file kcommondecoration.cpp.

void KCommonDecoration::ungrabXServer

(

)

[inherited]

Definition at line 1202 of file kcommondecoration.cpp.

QRegion KCommonDecoration::unobscuredRegion

(

const QRegion &

r

)

const [inherited]

Definition at line 1150 of file kcommondecoration.cpp.

void KCommonDecoration::updateButtons

(

)

const [inherited]

Makes sure all buttons are repainted.

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

int KCommonDecorationUnstable::visibleClientGroupItem

(

)

[inherited]

Definition at line 1299 of file kcommondecoration.cpp.

void KCommonDecoration::wheelEvent

(

QWheelEvent *

e

)

[virtual, inherited]

Definition at line 778 of file kcommondecoration.cpp.

const QWidget * KDecoration::widget

(

)

const [inline, inherited]

Returns the main widget for the decoration.

Definition at line 1013 of file kdecoration.h.

QWidget * KDecoration::widget

(

)

[inline, inherited]

Returns the main widget for the decoration.

Definition at line 1008 of file kdecoration.h.

const QWidget * KCommonDecoration::widget

(

)

const [inherited]

Definition at line 1190 of file kcommondecoration.cpp.

QWidget * KCommonDecoration::widget

(

)

[inherited]

Definition at line 1186 of file kcommondecoration.cpp.

int KDecoration::width

(

)

const [inline, inherited]

Convenience function that returns the width of the decoration.

Definition at line 1028 of file kdecoration.h.

int KCommonDecoration::width

(

)

const [inherited]

Definition at line 1158 of file kcommondecoration.cpp.

bool KCommonDecoration::windowDocked

(

Position

side

)

[virtual, inherited]

Definition at line 1034 of file kcommondecoration.cpp.

WId KCommonDecoration::windowId

(

)

const [inherited]

Definition at line 1154 of file kcommondecoration.cpp.

NET::WindowType KCommonDecoration::windowType

(

unsigned long

supported_types

)

const [inherited]

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

---

Public Slots

void KCommonDecoration::closeWindow

(

)

[slot, inherited]

Definition at line 1206 of file kcommondecoration.cpp.

void KCommonDecoration::keepAboveChange

(

bool

above

)

[slot, inherited]

Definition at line 646 of file kcommondecoration.cpp.

void KCommonDecoration::keepBelowChange

(

bool

below

)

[slot, inherited]

Definition at line 663 of file kcommondecoration.cpp.

void KCommonDecoration::maximize

(

MaximizeMode

mode

)

[slot, inherited]

Definition at line 1214 of file kcommondecoration.cpp.

void KCommonDecoration::maximize

(

Qt::MouseButtons

button

)

[slot, inherited]

Definition at line 1210 of file kcommondecoration.cpp.

void KCommonDecoration::menuButtonPressed

(

)

[slot, inherited]

Definition at line 703 of file kcommondecoration.cpp.

void KCommonDecoration::menuButtonReleased

(

)

[slot, inherited]

Definition at line 726 of file kcommondecoration.cpp.

void KCommonDecoration::minimize

(

)

[slot, inherited]

Definition at line 1218 of file kcommondecoration.cpp.

void KCommonDecoration::setDesktop

(

int

desktop

)

[slot, inherited]

Definition at line 1226 of file kcommondecoration.cpp.

void KCommonDecoration::setKeepAbove

(

bool

set

)

[slot, inherited]

Definition at line 1246 of file kcommondecoration.cpp.

void KCommonDecoration::setKeepBelow

(

bool

set

)

[slot, inherited]

Definition at line 1250 of file kcommondecoration.cpp.

void KCommonDecoration::setShade

(

bool

set

)

[slot, inherited]

Definition at line 1242 of file kcommondecoration.cpp.

void KCommonDecoration::showContextHelp

(

)

[slot, inherited]

Definition at line 1222 of file kcommondecoration.cpp.

void KCommonDecoration::slotKeepAbove

(

)

[slot, inherited]

Definition at line 693 of file kcommondecoration.cpp.

void KCommonDecoration::slotKeepBelow

(

)

[slot, inherited]

Definition at line 698 of file kcommondecoration.cpp.

void KCommonDecoration::slotMaximize

(

)

[slot, inherited]

Definition at line 680 of file kcommondecoration.cpp.

void KCommonDecoration::slotShade

(

)

[slot, inherited]

Definition at line 688 of file kcommondecoration.cpp.

void KCommonDecoration::titlebarDblClickOperation

(

)

[slot, inherited]

Definition at line 1234 of file kcommondecoration.cpp.

void KCommonDecoration::titlebarMouseWheelOperation

(

int

delta

)

[slot, inherited]

Definition at line 1238 of file kcommondecoration.cpp.

void KCommonDecoration::toggleOnAllDesktops

(

)

[slot, inherited]

Definition at line 1230 of file kcommondecoration.cpp.