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

KWinLibraries

KDecorationDefines Class Reference
[KWin decorations library]

#include <kdecoration.h>

Inheritance diagram for KDecorationDefines:

Inheritance graph
[legend]

List of all members.


Detailed Description

This class provides a namespace for all decoration related classes.

All shared types are defined here.

Definition at line 53 of file kdecoration.h.


Public Types

enum  {
  SettingDecoration = 1 << 0, SettingColors = 1 << 1, SettingFont = 1 << 2, SettingButtons = 1 << 3,
  SettingTooltips = 1 << 4, SettingBorder = 1 << 5
}
enum  Ability {
  AbilityAnnounceButtons = 0, AbilityAnnounceColors = 1, AbilityButtonMenu = 1000, AbilityButtonOnAllDesktops = 1001,
  AbilityButtonSpacer = 1002, AbilityButtonHelp = 1003, AbilityButtonMinimize = 1004, AbilityButtonMaximize = 1005,
  AbilityButtonClose = 1006, AbilityButtonAboveOthers = 1007, AbilityButtonBelowOthers = 1008, AbilityButtonShade = 1009,
  AbilityButtonResize = 1010, AbilityColorTitleBack = 2000, ABILITYCOLOR_FIRST = AbilityColorTitleBack, AbilityColorTitleFore = 2001,
  AbilityColorTitleBlend = 2002, AbilityColorFrame = 2010, AbilityColorHandle = 2011, AbilityColorButtonBack = 2020,
  AbilityColorButtonFore = 2021, ABILITYCOLOR_END, ABILITY_DUMMY = 10000000
}
enum  BorderSize {
  BorderTiny, BorderNormal, BorderLarge, BorderVeryLarge,
  BorderHuge, BorderVeryHuge, BorderOversized, BordersCount
}
enum  ColorType {
  ColorTitleBar, ColorTitleBlend, ColorFont, ColorButtonBg,
  ColorFrame, ColorHandle, NUM_COLORS
}
enum  MaximizeMode { MaximizeRestore = 0, MaximizeVertical = 1, MaximizeHorizontal = 2, MaximizeFull = MaximizeVertical | MaximizeHorizontal }
enum  Position {
  PositionCenter = 0x00, PositionLeft = 0x01, PositionRight = 0x02, PositionTop = 0x04,
  PositionBottom = 0x08, PositionTopLeft = PositionLeft | PositionTop, PositionTopRight = PositionRight | PositionTop, PositionBottomLeft = PositionLeft | PositionBottom,
  PositionBottomRight = PositionRight | PositionBottom
}
enum  Requirement { REQUIREMENT_DUMMY = 1000000 }
enum  WindowOperation {
  MaximizeOp = 5000, RestoreOp, MinimizeOp, MoveOp,
  UnrestrictedMoveOp, ResizeOp, UnrestrictedResizeOp, CloseOp,
  OnAllDesktopsOp, ShadeOp, KeepAboveOp, KeepBelowOp,
  OperationsOp, WindowRulesOp, ToggleStoreSettingsOp = WindowRulesOp, HMaximizeOp,
  VMaximizeOp, LowerOp, FullScreenOp, NoBorderOp,
  NoOp, SetupWindowShortcutOp, ApplicationRulesOp
}

Member Enumeration Documentation

anonymous enum

These flags specify which settings changed when rereading settings.

Each setting in class KDecorationOptions specifies its matching flag.

Enumerator:
SettingDecoration  The decoration was changed.
SettingColors  The color palette was changed.
SettingFont  The titlebar font was changed.
SettingButtons  The button layout was changed.
SettingTooltips  The tooltip setting was changed.
SettingBorder  The border size setting was changed.

Definition at line 130 of file kdecoration.h.

enum KDecorationDefines::Ability

Used to find out which features the decoration supports.

See also:
KDecorationFactory::supports()
Enumerator:
AbilityAnnounceButtons  decoration supports AbilityButton* values (always use)
AbilityAnnounceColors  decoration supports AbilityColor* values (always use)
AbilityButtonMenu  decoration supports the menu button
AbilityButtonOnAllDesktops  decoration supports the on all desktops button
AbilityButtonSpacer  decoration supports inserting spacers between buttons
AbilityButtonHelp  decoration supports what's this help button
AbilityButtonMinimize  decoration supports a minimize button
AbilityButtonMaximize  decoration supports a maximize button
AbilityButtonClose  decoration supports a close button
AbilityButtonAboveOthers  decoration supports an above button
AbilityButtonBelowOthers  decoration supports a below button
AbilityButtonShade  decoration supports a shade button
AbilityButtonResize  decoration supports a resize button
AbilityColorTitleBack  decoration supports titlebar background color
ABILITYCOLOR_FIRST 
AbilityColorTitleFore  decoration supports titlebar foreground color
AbilityColorTitleBlend  decoration supports second titlebar background color
AbilityColorFrame  decoration supports frame color
AbilityColorHandle  decoration supports resize handle color
AbilityColorButtonBack  decoration supports button background color
AbilityColorButtonFore  decoration supports button foreground color
ABILITYCOLOR_END 
ABILITY_DUMMY 

Definition at line 160 of file kdecoration.h.

enum KDecorationDefines::BorderSize

Border size.

KDecorationOptions::preferredBorderSize() returns one of these values.

Enumerator:
BorderTiny  Minimal borders.
BorderNormal  Standard size borders, the default setting.
BorderLarge  Larger borders.
BorderVeryLarge  Very large borders.
BorderHuge  Huge borders.
BorderVeryHuge  Very huge borders.
BorderOversized  Oversized borders.
BordersCount 

Definition at line 144 of file kdecoration.h.

enum KDecorationDefines::ColorType

Basic color types that should be recognized by all decoration styles.

Decorations are not required to implement all the colors, but for the ones that are implemented the color setting for them should be obeyed.

Enumerator:
ColorTitleBar  The color for the titlebar.
ColorTitleBlend  The blend color for the titlebar.
ColorFont  The titlebar text color.
ColorButtonBg  The color to use for the titlebar buttons.
ColorFrame  The color for the window frame (border).
ColorHandle  The color for the resize handle.
NUM_COLORS 

Definition at line 115 of file kdecoration.h.

enum KDecorationDefines::MaximizeMode

Maximize mode.

These values specify how a window is maximized.

Enumerator:
MaximizeRestore  The window is not maximized in any direction.
MaximizeVertical  The window is maximized vertically.
MaximizeHorizontal  The window is maximized horizontally.

MaximizeFull  Equal to MaximizeVertical | MaximizeHorizontal.

Definition at line 75 of file kdecoration.h.

enum KDecorationDefines::Position

These values represent positions inside an area.

Enumerator:
PositionCenter 
PositionLeft 
PositionRight 
PositionTop 
PositionBottom 
PositionTopLeft 
PositionTopRight 
PositionBottomLeft 
PositionBottomRight 

Definition at line 59 of file kdecoration.h.

enum KDecorationDefines::Requirement

Enumerator:
REQUIREMENT_DUMMY 

Definition at line 191 of file kdecoration.h.

enum KDecorationDefines::WindowOperation

Enumerator:
MaximizeOp 
RestoreOp 
MinimizeOp 
MoveOp 
UnrestrictedMoveOp 
ResizeOp 
UnrestrictedResizeOp 
CloseOp 
OnAllDesktopsOp 
ShadeOp 
KeepAboveOp 
KeepBelowOp 
OperationsOp 
WindowRulesOp 
ToggleStoreSettingsOp 
Deprecated:
HMaximizeOp 
VMaximizeOp 
LowerOp 
FullScreenOp 
NoBorderOp 
NoOp 
SetupWindowShortcutOp 
ApplicationRulesOp 

Definition at line 84 of file kdecoration.h.


The documentation for this class was generated from the following file:
  • kdecoration.h

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
  •   libsolidcontrol
  •   libtaskmanager
  • 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