KDecoration3 Namespace Reference

Classes
class	DecoratedWindow
class	Decoration
class	DecorationButton
class	DecorationButtonGroup
class	DecorationSettings
class	DecorationShadow
class	DecorationState
class	DecorationThemeMetaData
class	DecorationThemeProvider

Enumerations
enum class	BorderSize {   None , NoSides , Tiny , Normal ,   Large , VeryLarge , Huge , VeryHuge ,   Oversized }
enum class	ColorGroup { Inactive , Active , Warning }
enum class	ColorRole { Frame , TitleBar , Foreground }
enum class	DecorationButtonType {   Menu , ApplicationMenu , OnAllDesktops , Minimize ,   Maximize , Close , ContextHelp , Shade ,   KeepBelow , KeepAbove , Custom , Spacer }

Functions
qreal	pixelSize (qreal scale)
QPointF	snapToPixelGrid (const QPointF &value, qreal scale)
QRectF	snapToPixelGrid (const QRectF &value, qreal scale)
QSizeF	snapToPixelGrid (const QSizeF &value, qreal scale)
qreal	snapToPixelGrid (qreal value, qreal scale)

Detailed Description

Framework for creating window decorations.

Enumeration Type Documentation

BorderSize

enum class KDecoration3::BorderSize

strong

Border sizes are a combination of visual and accessibility features.

Larger borders should be used to increase the non title bar borders to make it easier to resize the decoration

Enumerator
None	Border sizes of all non title bar sides should be set to 0.
NoSides	Border sizes of the sides should be set to 0. Title bar and the border on opposite side of the title bar should follow the Normal settings.
Tiny	Borders should be smaller than Normal, e.g. a factor of 0.5.
Normal	The default border size with borders on each side. This should be the base for calculating other border sizes.
Large	Increased border sizes, considered a factor of 1.5.
VeryLarge	Increased border sizes, considered a factor of 2.0.
Huge	Increased border sizes, considered a factor of 2.5.
VeryHuge	Increased border sizes, considered a factor of 3.0.
Oversized	Increased border sizes, considered a factor of 5.0.

Definition at line 82 of file decorationdefines.h.

ColorGroup

enum class KDecoration3::ColorGroup

strong

Color groups are used for DecoratedWindow::color().

Since

5.3

Enumerator
Inactive	Inactive color, used for unfocused windows.
Active	Active color, used for focused windows.
Warning	Warning color, can only be used with ColorRole::Foreground. If used with other roles, a invalid QColor is returned. It can be used for close buttons and is typically red.

Definition at line 128 of file decorationdefines.h.

ColorRole

enum class KDecoration3::ColorRole

strong

Color roles are used for DecoratedWindow::color().

Since

5.3

Enumerator
Frame	The decoration's frame background color.
TitleBar	The decoration's title bar background color.
Foreground	The decoration's title bar forground color.

Definition at line 148 of file decorationdefines.h.

DecorationButtonType

enum class KDecoration3::DecorationButtonType

strong

The DecorationButtonType is a helper type for the DecorationButton.

A Decoration should provide a DecorationButton for each of the types, if it wants to provide further buttons it should use the Custom type. The DecorationButton gets configured depending on the type. E.g. the Close button gets disabled if the DecoratedWindow is not closeable.

Enumerator
Menu	The Menu button requests showing the window menu on left or right click.
ApplicationMenu	The ApplicationMenu button requests showing the application's menu on left or right click.
OnAllDesktops	The OnAllDesktops button requests toggling the DecoratedWindow's on all desktops state. The DecoratedButton is only visible if multiple virtual desktops are available.
Minimize	The Minimize button requests minimizing the DecoratedWindow. The DecorationButton is only enabled if the DecoratedWindow is minimizeable.
Maximize	The Maximize button requests maximizing the DecoratedWindow. The DecorationButton is checkable and if the DecoratedWindow is maximized the DecorationButton is checked. The DecorationButton supports multiple mouse buttons to change horizontal, vertical and overall maximized state. The DecorationButton is only enabled if the DecoratedWindow is maximizeable.
Close	The Close button requests closing the DecoratedWindow. The DecorationButton is only enabled if the DecoratedWindow is closeable.
ContextHelp	The ContextHelp button requests entering the context help mode. The DecorationButton is only visible if the DecoratedWindow provides context help.
Shade	The Shade button requests toggling the DecoratedWindow's shaded state. The DecoratedButton is only enabled if the DecoratedWindow is shadeable.
KeepBelow	The KeepBelow button requests toggling the DecoratedWindow's keep below state.
KeepAbove	The KeepAbove button requests toggling the DecoratedWindow's keep above state.
Custom	The Custom type allows a Decoration to provide custom DecorationButtons.
Spacer	The Spacer button provides some space between buttons.

Definition at line 17 of file decorationdefines.h.

Function Documentation

pixelSize()

qreal KDecoration3::pixelSize ( qreal scale )

inline

Returns

the pixel size with the provided scale

Since

6.3

Definition at line 19 of file scalehelpers.h.

snapToPixelGrid() [1/4]

QPointF KDecoration3::snapToPixelGrid ( const QPointF & value, qreal scale )

inline

snaps the logical geometry value to a fractional logical geometry value that aligns to the pixel grid of the provided scale

Since

6.3

Definition at line 39 of file scalehelpers.h.

snapToPixelGrid() [2/4]

QRectF KDecoration3::snapToPixelGrid ( const QRectF & value, qreal scale )

inline

snaps the logical geometry value to a fractional logical geometry value that aligns to the pixel grid of the provided scale

Since

6.3

Definition at line 59 of file scalehelpers.h.

snapToPixelGrid() [3/4]

QSizeF KDecoration3::snapToPixelGrid ( const QSizeF & value, qreal scale )

inline

snaps the logical geometry value to a fractional logical geometry value that aligns to the pixel grid of the provided scale

Since

6.3

Definition at line 49 of file scalehelpers.h.

snapToPixelGrid() [4/4]

qreal KDecoration3::snapToPixelGrid ( qreal value, qreal scale )

inline

snaps the logical geometry value to a fractional logical geometry value that aligns to the pixel grid of the provided scale

Since

6.3

Definition at line 29 of file scalehelpers.h.