kwin/lib Library API Documentation

KDecorationDefines Class Reference

This class provides a namespace for all decoration related classes. More...

#include <kdecoration.h>

Inheritance diagram for KDecorationDefines:

Inheritance graph
[legend]
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,
  NoOp
}
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 { 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

Definition at line 48 of file kdecoration.h.


Member Enumeration Documentation

enum KDecorationDefines::Position
 

These values represent positions inside an area.

Definition at line 54 of file kdecoration.h.

enum KDecorationDefines::MaximizeMode
 

Maximize mode.

These values specify how a window is maximized.

Enumeration values:
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 70 of file kdecoration.h.

enum KDecorationDefines::WindowOperation
 

Enumeration values:
ToggleStoreSettingsOp 
Deprecated:

Definition at line 79 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.

Enumeration values:
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.

Definition at line 108 of file kdecoration.h.

anonymous enum
 

These flags specify which settings changed when rereading settings.

Each setting in class KDecorationOptions specifies its matching flag.

Enumeration values:
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 123 of file kdecoration.h.

enum KDecorationDefines::BorderSize
 

Border size.

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

Enumeration values:
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.

Definition at line 137 of file kdecoration.h.


The documentation for this class was generated from the following file:
KDE Logo
This file is part of the documentation for kwin/lib Library Version 3.3.90.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Tue Apr 5 03:59:45 2005 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003