KDecoration2

KDecoration2 Namespace Reference

Classes

class  DecoratedClient
 
class  Decoration
 
class  DecorationButton
 
class  DecorationButtonGroup
 
class  DecorationSettings
 
class  DecorationShadow
 

Enumerations

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

Detailed Description

Framework for creating window decorations.

Enumeration Type Documentation

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.

Color groups are used for DecoratedClient::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.

Color roles are used for DecoratedClient::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.

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 DecoratedClient 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 DecoratedClient's on all desktops state.

The DecoratedButton is only visible if multiple virtual desktops are available.

Minimize 

The Minimize button requests minimizing the DecoratedClient.

The DecorationButton is only enabled if the DecoratedClient is minimizeable.

Maximize 

The Maximize button requests maximizing the DecoratedClient.

The DecorationButton is checkable and if the DecoratedClient 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 DecoratedClient is maximizeable.

Close 

The Close button requests closing the DecoratedClient.

The DecorationButton is only enabled if the DecoratedClient is closeable.

ContextHelp 

The ContextHelp button requests entering the context help mode.

The DecorationButton is only visible if the DecoratedClient provides context help.

Shade 

The Shade button requests toggling the DecoratedClient's shaded state.

The DecoratedButton is only enabled if the DecoratedClient is shadeable.

KeepBelow 

The KeepBelow button requests toggling the DecoratedClient's keep below state.

KeepAbove 

The KeepAbove button requests toggling the DecoratedClient's keep above state.

Custom 

The Custom type allows a Decoration to provide custom DecorationButtons.

Definition at line 19 of file decorationdefines.h.

This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sat Nov 21 2020 23:07:58 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.