KDecorationDefines Class Reference

#include <kdecoration.h>

Inheritance diagram for KDecorationDefines:
KDecoration KDecorationBridge KDecorationFactory KDecorationOptions KDecorationOptionsPrivate KDecorationProvides KWinDecorationModule KWinInternal::Client KWinInternal::Rules KWinInternal::WindowRules KWinInternal::Workspace

List of all members.

Public Types

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  MaximizeMode { MaximizeRestore = 0, MaximizeVertical = 1, MaximizeHorizontal = 2, MaximizeFull = MaximizeVertical | MaximizeHorizontal }
enum  WindowOperation {
  MaximizeOp = 5000, RestoreOp, MinimizeOp, MoveOp,
  UnrestrictedMoveOp, ResizeOp, UnrestrictedResizeOp, CloseOp,
  OnAllDesktopsOp, ShadeOp, KeepAboveOp, KeepBelowOp,
  OperationsOp, WindowRulesOp, ToggleStoreSettingsOp = WindowRulesOp, HMaximizeOp,
  VMaximizeOp, LowerOp, FullScreenOp, NoBorderOp,
  ShadowOp, NoOp, SetupWindowShortcutOp, ApplicationRulesOp
}
enum  ColorType {
  ColorTitleBar, ColorTitleBlend, ColorFont, ColorButtonBg,
  ColorFrame, ColorHandle, NUM_COLORS
}
enum  {
  SettingDecoration = 1 << 0, SettingColors = 1 << 1, SettingFont = 1 << 2, SettingButtons = 1 << 3,
  SettingTooltips = 1 << 4, SettingBorder = 1 << 5
}
enum  BorderSize {
  BorderTiny, BorderNormal, BorderLarge, BorderVeryLarge,
  BorderHuge, BorderVeryHuge, BorderOversized, BordersCount
}
enum  Ability {
  AbilityAnnounceButtons = 0, AbilityButtonMenu = 1000, AbilityButtonOnAllDesktops = 1001, AbilityButtonSpacer = 1002,
  AbilityButtonHelp = 1003, AbilityButtonMinimize = 1004, AbilityButtonMaximize = 1005, AbilityButtonClose = 1006,
  AbilityButtonAboveOthers = 1007, AbilityButtonBelowOthers = 1008, AbilityButtonShade = 1009, AbilityButtonResize = 1010,
  ABILITY_DUMMY = 10000000
}
enum  Requirement { REQUIREMENT_DUMMY = 1000000 }

Detailed Description

This class provides a namespace for all decoration related classes. All shared types are defined here.

Since:
3.2

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.

Used to find out which features the decoration supports.

See also:
KDecorationFactory::supports()
Enumerator:
AbilityAnnounceButtons 

decoration supports AbilityButton* 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

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.

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.

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.

These values represent positions inside an area

Enumerator:
ToggleStoreSettingsOp 
ApplicationRulesOp 
Since:
3.5

The documentation for this class was generated from the following file:

Generated on Sat Oct 2 22:59:21 2010 by  doxygen 1.6.1