kwin/lib Library API Documentation

KDecorationOptions Class Reference

This class holds various configuration settings for the decoration. More...

#include <kdecoration.h>

Inheritance diagram for KDecorationOptions:

KDecorationDefines List of all members.

Public Member Functions

const QColor & color (ColorType type, bool active=true) const
const QColorGroup & colorGroup (ColorType type, bool active=true) const
const QFont & font (bool active=true, bool small=false) const
bool customButtonPositions () const
QString titleButtonsLeft () const
QString titleButtonsRight () const
bool showTooltips () const
BorderSize preferredBorderSize (KDecorationFactory *factory) const
bool moveResizeMaximizedWindows () const
WindowOperation operationMaxButtonClick (Qt::ButtonState button) const
virtual unsigned long updateSettings ()=0

Protected Attributes

KDecorationOptionsPrivate * d

Detailed Description

This class holds various configuration settings for the decoration.

It is accessible from the decorations either as KDecoration::options() or KDecorationFactory::options().

Since:
3.2

Definition at line 186 of file kdecoration.h.


Member Function Documentation

const QColor & KDecorationOptions::color ColorType  type,
bool  active = true
const
 

Returns the color that should be used for the given part of the decoration.

The changed flags for this setting is SettingColors.

Parameters:
type The requested color type.
active Whether the color should be for active or inactive windows.

Definition at line 373 of file kdecoration.cpp.

const QColorGroup & KDecorationOptions::colorGroup ColorType  type,
bool  active = true
const
 

Returns a colorgroup using the given decoration color as the background.

The changed flags for this setting is SettingColors.

Parameters:
type The requested color type.
active Whether to return the color for active or inactive windows.

Definition at line 386 of file kdecoration.cpp.

const QFont & KDecorationOptions::font bool  active = true,
bool  small = false
const
 

Returns the active or inactive decoration font.

The changed flags for this setting is SettingFont.

Parameters:
active Whether to return the color for active or inactive windows.
small If true, returns a font that's suitable for tool windows.

Definition at line 378 of file kdecoration.cpp.

bool KDecorationOptions::customButtonPositions  )  const
 

Returns true if the style should use custom button positions The changed flags for this setting is SettingButtons.

See also:
titleButtonsLeft

titleButtonsRight

Definition at line 398 of file kdecoration.cpp.

QString KDecorationOptions::titleButtonsLeft  )  const
 

If customButtonPositions() returns true, titleButtonsLeft returns which buttons should be on the left side of the titlebar from left to right.

Characters in the returned string have this meaning :

  • 'M' menu button
  • 'S' on_all_desktops button
  • 'H' quickhelp button
  • 'I' minimize ( iconify ) button
  • 'A' maximize button
  • 'X' close button
  • 'F' keep_above_others button
  • 'B' keep_below_others button
  • 'L' shade button
  • 'R' resize button
  • '_' spacer
The default ( which is also returned if customButtonPositions returns false ) is "MS". Unknown buttons in the returned string must be ignored. The changed flags for this setting is SettingButtons.

Definition at line 403 of file kdecoration.cpp.

QString KDecorationOptions::titleButtonsRight  )  const
 

If customButtonPositions() returns true, titleButtonsRight returns which buttons should be on the right side of the titlebar from left to right.

Characters in the return string have the same meaning like in titleButtonsLeft().

The default ( which is also returned if customButtonPositions returns false ) is "HIAX". Unknown buttons in the returned string must be ignored. The changed flags for this setting is SettingButtons.

Definition at line 408 of file kdecoration.cpp.

bool KDecorationOptions::showTooltips  )  const
 

Returns:
true if the style should use tooltips for window buttons The changed flags for this setting is SettingTooltips.

Definition at line 413 of file kdecoration.cpp.

KDecorationOptions::BorderSize KDecorationOptions::preferredBorderSize KDecorationFactory *  factory  )  const
 

The preferred border size selected by the user, e.g.

for accessibility reasons, or when using high resolution displays. It's up to the decoration to decide which borders or if any borders at all will obey this setting. It is guaranteed that the returned value will be one of those returned by KDecorationFactory::borderSizes(), so if that one hasn't been reimplemented, BorderNormal is always returned. The changed flags for this setting is SettingBorder.

Parameters:
factory the decoration factory used

Definition at line 418 of file kdecoration.cpp.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kwin/lib Library Version 3.4.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Fri Nov 4 00:45:30 2005 by doxygen 1.4.0 written by Dimitri van Heesch, © 1997-2003