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

KWin

KWin::Options

KWin::Options Class Reference

#include <options.h>

Inheritance diagram for KWin::Options:

Inheritance graph
[legend]

List of all members.


Public Types

enum  { ElectricDisabled = 0, ElectricMoveOnly = 1, ElectricAlways = 2 }
enum  AltTabStyle { KDE, CDE }
enum  FocusPolicy { ClickToFocus, FocusFollowsMouse, FocusUnderMouse, FocusStrictlyUnderMouse }
enum  GLMode { GLTFP, GLSHM, GLFallback }
enum  MouseCommand {
  MouseRaise, MouseLower, MouseOperationsMenu, MouseToggleRaiseAndLower,
  MouseActivateAndRaise, MouseActivateAndLower, MouseActivate, MouseActivateRaiseAndPassClick,
  MouseActivateAndPassClick, MouseMove, MouseUnrestrictedMove, MouseActivateRaiseAndMove,
  MouseActivateRaiseAndUnrestrictedMove, MouseResize, MouseUnrestrictedResize, MouseShade,
  MouseSetShade, MouseUnsetShade, MouseMaximize, MouseRestore,
  MouseMinimize, MouseNextDesktop, MousePreviousDesktop, MouseAbove,
  MouseBelow, MouseOpacityMore, MouseOpacityLess, MouseNothing
}
enum  MouseWheelCommand {
  MouseWheelRaiseLower, MouseWheelShadeUnshade, MouseWheelMaximizeRestore, MouseWheelAboveBelow,
  MouseWheelPreviousNextDesktop, MouseWheelChangeOpacity, MouseWheelNothing
}
enum  MoveResizeMode { Transparent, Opaque }

Public Member Functions

double animationTimeFactor () const
bool checkIgnoreFocusStealing (const Client *c)
MouseCommand commandActiveTitlebar1 ()
MouseCommand commandActiveTitlebar2 ()
MouseCommand commandActiveTitlebar3 ()
MouseCommand commandAll1 ()
MouseCommand commandAll2 ()
MouseCommand commandAll3 ()
MouseCommand commandInactiveTitlebar1 ()
MouseCommand commandInactiveTitlebar2 ()
MouseCommand commandInactiveTitlebar3 ()
MouseCommand commandWindow1 ()
MouseCommand commandWindow2 ()
MouseCommand commandWindow3 ()
bool desktopTopMenu () const
int electricBorderDelay ()
int electricBorders ()
bool focusPolicyIsReasonable ()
uint keyCmdAllModKey ()
WindowOperation operationTitlebarDblClick ()
MouseCommand operationTitlebarMouseWheel (int delta)
MouseCommand operationWindowMouseWheel (int delta)
 Options ()
bool showGeometryTip ()
bool topMenuEnabled () const
virtual unsigned long updateSettings ()
 ~Options ()

Static Public Member Functions

static MouseCommand mouseCommand (const QString &name, bool restricted)
static MouseWheelCommand mouseWheelCommand (const QString &name)
static const char * moveResizeModeToString (MoveResizeMode mode)
static MoveResizeMode stringToMoveResizeMode (const QString &s)
static WindowOperation windowOperation (const QString &name, bool restricted)

Public Attributes

bool activeMouseScreen
AltTabStyle altTabStyle
bool autoRaise
int autoRaiseInterval
int borderSnapZone
int centerSnapZone
bool clickRaise
CompositingType compositingMode
bool delayFocus
int delayFocusInterval
bool disableCompositingChecks
FocusPolicy focusPolicy
int focusStealingPreventionLevel
bool glDirect
GLMode glMode
bool glStrictBinding
bool glVSync
HiddenPreviews hiddenPreviews
bool hideUtilityWindowsForInactive
QStringList ignorePositionClasses
int killPingTimeout
MoveResizeMode moveMode
Placement::Policy placement
uint refreshRate
MoveResizeMode resizeMode
bool rollOverDesktops
bool separateScreenFocus
bool shadeHover
int shadeHoverInterval
bool showDesktopIsMinimizeAll
int smoothScale
bool snapOnlyWhenOverlapping
bool unredirectFullscreen
bool useCompositing
int windowSnapZone
bool xineramaEnabled
bool xineramaFullscreenEnabled
bool xineramaMaximizeEnabled
bool xineramaMovementEnabled
bool xineramaPlacementEnabled
int xineramaPlacementScreen
bool xrenderSmoothScale

Detailed Description

Definition at line 39 of file options.h.


Member Enumeration Documentation

anonymous enum

Enumerator:
ElectricDisabled 
ElectricMoveOnly 
ElectricAlways 

Definition at line 271 of file options.h.

enum KWin::Options::AltTabStyle

Different Alt-Tab-Styles:.

  • KDE - the recommended KDE style. Alt-Tab opens a nice icon box that makes it easy to select the window you want to tab to. The order automatically adjusts to the most recently used windows. Note that KDE style does not work with the FocusUnderMouse and FocusStrictlyUnderMouse focus policies. Choose ClickToFocus or FocusFollowsMouse instead.

  • CDE - the old-fashion CDE style. Alt-Tab cycles between the windows in static order. The current window gets raised, the previous window gets lowered.

Enumerator:
KDE 
CDE 

Definition at line 136 of file options.h.

enum KWin::Options::FocusPolicy

Different focus policies:

  • ClickToFocus - Clicking into a window activates it. This is also the default.

  • FocusFollowsMouse - Moving the mouse pointer actively onto a normal window activates it. For convenience, the desktop and windows on the dock are excluded. They require clicking.

  • FocusUnderMouse - The window that happens to be under the mouse pointer becomes active. The invariant is: no window can have focus that is not under the mouse. This also means that Alt-Tab won't work properly and popup dialogs are usually unsable with the keyboard. Note that the desktop and windows on the dock are excluded for convenience. They get focus only when clicking on it.

  • FocusStrictlyUnderMouse - this is even worse than FocusUnderMouse. Only the window under the mouse pointer is active. If the mouse points nowhere, nothing has the focus. If the mouse points onto the desktop, the desktop has focus. The same holds for windows on the dock.

    Note that FocusUnderMouse and FocusStrictlyUnderMouse are not particulary useful. They are only provided for old-fashined die-hard UNIX people ;-)

Enumerator:
ClickToFocus 
FocusFollowsMouse 
FocusUnderMouse 
FocusStrictlyUnderMouse 

Definition at line 79 of file options.h.

enum KWin::Options::GLMode

Enumerator:
GLTFP 
GLSHM 
GLFallback 

Definition at line 308 of file options.h.

enum KWin::Options::MouseCommand

Enumerator:
MouseRaise 
MouseLower 
MouseOperationsMenu 
MouseToggleRaiseAndLower 
MouseActivateAndRaise 
MouseActivateAndLower 
MouseActivate 
MouseActivateRaiseAndPassClick 
MouseActivateAndPassClick 
MouseMove 
MouseUnrestrictedMove 
MouseActivateRaiseAndMove 
MouseActivateRaiseAndUnrestrictedMove 
MouseResize 
MouseUnrestrictedResize 
MouseShade 
MouseSetShade 
MouseUnsetShade 
MouseMaximize 
MouseRestore 
MouseMinimize 
MouseNextDesktop 
MousePreviousDesktop 
MouseAbove 
MouseBelow 
MouseOpacityMore 
MouseOpacityLess 
MouseNothing 

Definition at line 214 of file options.h.

enum KWin::Options::MouseWheelCommand

Enumerator:
MouseWheelRaiseLower 
MouseWheelShadeUnshade 
MouseWheelMaximizeRestore 
MouseWheelAboveBelow 
MouseWheelPreviousNextDesktop 
MouseWheelChangeOpacity 
MouseWheelNothing 

Definition at line 230 of file options.h.

enum KWin::Options::MoveResizeMode

MoveResizeMode, either Tranparent or Opaque.

Enumerator:
Transparent 
Opaque 

Definition at line 159 of file options.h.


Constructor & Destructor Documentation

KWin::Options::Options (  ) 

Definition at line 47 of file options.cpp.

KWin::Options::~Options (  ) 

Definition at line 54 of file options.cpp.


Member Function Documentation

double KWin::Options::animationTimeFactor (  )  const

Definition at line 366 of file options.cpp.

bool KWin::Options::checkIgnoreFocusStealing ( const Client *  c  ) 

Definition at line 329 of file options.cpp.

MouseCommand KWin::Options::commandActiveTitlebar1 (  )  [inline]

Definition at line 247 of file options.h.

MouseCommand KWin::Options::commandActiveTitlebar2 (  )  [inline]

Definition at line 248 of file options.h.

MouseCommand KWin::Options::commandActiveTitlebar3 (  )  [inline]

Definition at line 249 of file options.h.

MouseCommand KWin::Options::commandAll1 (  )  [inline]

Definition at line 256 of file options.h.

MouseCommand KWin::Options::commandAll2 (  )  [inline]

Definition at line 257 of file options.h.

MouseCommand KWin::Options::commandAll3 (  )  [inline]

Definition at line 258 of file options.h.

MouseCommand KWin::Options::commandInactiveTitlebar1 (  )  [inline]

Definition at line 250 of file options.h.

MouseCommand KWin::Options::commandInactiveTitlebar2 (  )  [inline]

Definition at line 251 of file options.h.

MouseCommand KWin::Options::commandInactiveTitlebar3 (  )  [inline]

Definition at line 252 of file options.h.

MouseCommand KWin::Options::commandWindow1 (  )  [inline]

Definition at line 253 of file options.h.

MouseCommand KWin::Options::commandWindow2 (  )  [inline]

Definition at line 254 of file options.h.

MouseCommand KWin::Options::commandWindow3 (  )  [inline]

Definition at line 255 of file options.h.

bool KWin::Options::desktopTopMenu (  )  const [inline]

Definition at line 285 of file options.h.

int KWin::Options::electricBorderDelay (  ) 

Returns:
the activation delay for electric borders in milliseconds.

Definition at line 324 of file options.cpp.

int KWin::Options::electricBorders (  ) 

Returns:
true if electric borders are enabled. With electric borders you can change desktop by moving the mouse pointer towards the edge of the screen

Definition at line 319 of file options.cpp.

bool KWin::Options::focusPolicyIsReasonable (  )  [inline]

Definition at line 169 of file options.h.

uint KWin::Options::keyCmdAllModKey (  )  [inline]

Definition at line 259 of file options.h.

Options::MouseCommand KWin::Options::mouseCommand ( const QString &  name,
bool  restricted 
) [static]

Definition at line 280 of file options.cpp.

Options::MouseWheelCommand KWin::Options::mouseWheelCommand ( const QString &  name  )  [static]

Definition at line 302 of file options.cpp.

const char * KWin::Options::moveResizeModeToString ( MoveResizeMode  mode  )  [static]

Definition at line 361 of file options.cpp.

WindowOperation KWin::Options::operationTitlebarDblClick (  )  [inline]

Definition at line 212 of file options.h.

MouseCommand KWin::Options::operationTitlebarMouseWheel ( int  delta  )  [inline]

Definition at line 238 of file options.h.

MouseCommand KWin::Options::operationWindowMouseWheel ( int  delta  )  [inline]

Definition at line 242 of file options.h.

bool KWin::Options::showGeometryTip (  ) 

Returns:
true if the Geometry Tip should be shown during a window move/resize.

Definition at line 314 of file options.cpp.

Options::MoveResizeMode KWin::Options::stringToMoveResizeMode ( const QString &  s  )  [static]

Definition at line 356 of file options.cpp.

bool KWin::Options::topMenuEnabled (  )  const [inline]

Definition at line 284 of file options.h.

unsigned long KWin::Options::updateSettings (  )  [virtual]

Definition at line 58 of file options.cpp.

Options::WindowOperation KWin::Options::windowOperation ( const QString &  name,
bool  restricted 
) [static]

Definition at line 253 of file options.cpp.


Member Data Documentation

bool KWin::Options::activeMouseScreen

Definition at line 142 of file options.h.

AltTabStyle KWin::Options::altTabStyle

Definition at line 137 of file options.h.

bool KWin::Options::autoRaise

whether autoraise is enabled FocusFollowsMouse mode or not.

Definition at line 92 of file options.h.

int KWin::Options::autoRaiseInterval

autoraise interval

Definition at line 97 of file options.h.

int KWin::Options::borderSnapZone

the size of the zone that triggers snapping on desktop borders

Definition at line 177 of file options.h.

int KWin::Options::centerSnapZone

the size of the zone that triggers snapping on the screen center

Definition at line 187 of file options.h.

bool KWin::Options::clickRaise

Whether clicking on a window raises it in FocusFollowsMouse mode or not.

Definition at line 87 of file options.h.

CompositingType KWin::Options::compositingMode

Definition at line 295 of file options.h.

bool KWin::Options::delayFocus

whether delay focus is enabled or not.

Definition at line 102 of file options.h.

int KWin::Options::delayFocusInterval

delayed focus interval

Definition at line 107 of file options.h.

bool KWin::Options::disableCompositingChecks

Definition at line 298 of file options.h.

FocusPolicy KWin::Options::focusPolicy

Definition at line 80 of file options.h.

int KWin::Options::focusStealingPreventionLevel

Definition at line 203 of file options.h.

bool KWin::Options::glDirect

Definition at line 310 of file options.h.

GLMode KWin::Options::glMode

Definition at line 309 of file options.h.

bool KWin::Options::glStrictBinding

Definition at line 312 of file options.h.

bool KWin::Options::glVSync

Definition at line 311 of file options.h.

HiddenPreviews KWin::Options::hiddenPreviews

Definition at line 296 of file options.h.

bool KWin::Options::hideUtilityWindowsForInactive

Definition at line 291 of file options.h.

QStringList KWin::Options::ignorePositionClasses

List of window classes to ignore PPosition size hint.

Definition at line 208 of file options.h.

int KWin::Options::killPingTimeout

Definition at line 288 of file options.h.

MoveResizeMode KWin::Options::moveMode

Definition at line 162 of file options.h.

Placement::Policy KWin::Options::placement

Definition at line 167 of file options.h.

uint KWin::Options::refreshRate

Definition at line 300 of file options.h.

MoveResizeMode KWin::Options::resizeMode

Definition at line 161 of file options.h.

bool KWin::Options::rollOverDesktops

whether or not we roll over to the other edge when switching desktops past the edge

Definition at line 200 of file options.h.

bool KWin::Options::separateScreenFocus

Definition at line 140 of file options.h.

bool KWin::Options::shadeHover

Whether shade hover is enabled or not.

Definition at line 112 of file options.h.

int KWin::Options::shadeHoverInterval

shade hover interval

Definition at line 117 of file options.h.

bool KWin::Options::showDesktopIsMinimizeAll

Definition at line 195 of file options.h.

int KWin::Options::smoothScale

Definition at line 302 of file options.h.

bool KWin::Options::snapOnlyWhenOverlapping

snap only when windows will overlap

Definition at line 193 of file options.h.

bool KWin::Options::unredirectFullscreen

Definition at line 297 of file options.h.

bool KWin::Options::useCompositing

Definition at line 294 of file options.h.

int KWin::Options::windowSnapZone

the size of the zone that triggers snapping with other windows

Definition at line 182 of file options.h.

bool KWin::Options::xineramaEnabled

Xinerama options.

Definition at line 147 of file options.h.

bool KWin::Options::xineramaFullscreenEnabled

Definition at line 151 of file options.h.

bool KWin::Options::xineramaMaximizeEnabled

Definition at line 150 of file options.h.

bool KWin::Options::xineramaMovementEnabled

Definition at line 149 of file options.h.

bool KWin::Options::xineramaPlacementEnabled

Definition at line 148 of file options.h.

int KWin::Options::xineramaPlacementScreen

Definition at line 154 of file options.h.

bool KWin::Options::xrenderSmoothScale

Definition at line 306 of file options.h.


The documentation for this class was generated from the following files:
  • options.h
  • options.cpp

KWin

Skip menu "KWin"
  • Main Page
  • 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
  •   libsolidcontrol
  •   libtaskmanager
  • Plasma
  •   Animators
  •   Applets
  •   Engines
  • Solid Modules
Generated for API Reference by doxygen 1.5.7
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