kwin Library API Documentation

KWinInternal::Options Class Reference

Inheritance diagram for KWinInternal::Options:

Inheritance graph
[legend]
Collaboration diagram for KWinInternal::Options:

Collaboration graph
[legend]
List of all members.

Public Types

enum  FocusPolicy { ClickToFocus, FocusFollowsMouse, FocusUnderMouse, FocusStrictlyUnderMouse }
enum  AltTabStyle { KDE, CDE }
enum  MoveResizeMode { Transparent, Opaque }
enum  MouseCommand {
  MouseRaise, MouseLower, MouseOperationsMenu, MouseToggleRaiseAndLower,
  MouseActivateAndRaise, MouseActivateAndLower, MouseActivate, MouseActivateRaiseAndPassClick,
  MouseActivateAndPassClick, MouseMove, MouseUnrestrictedMove, MouseActivateRaiseAndMove,
  MouseActivateRaiseAndUnrestrictedMove, MouseResize, MouseUnrestrictedResize, MouseShade,
  MouseMinimize, MouseNothing
}
enum  { ElectricDisabled = 0, ElectricMoveOnly = 1, ElectricAlways = 2 }

Public Member Functions

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

Static Public Member Functions

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

Public Attributes

FocusPolicy focusPolicy
bool clickRaise
bool autoRaise
int autoRaiseInterval
bool delayFocus
int delayFocusInterval
bool shadeHover
int shadeHoverInterval
AltTabStyle altTabStyle
bool xineramaEnabled
bool xineramaPlacementEnabled
bool xineramaMovementEnabled
bool xineramaMaximizeEnabled
bool xineramaFullscreenEnabled
MoveResizeMode resizeMode
MoveResizeMode moveMode
Placement::Policy placement
bool animateShade
int borderSnapZone
int windowSnapZone
bool snapOnlyWhenOverlapping
bool animateMinimize
int animateMinimizeSpeed
bool rollOverDesktops
int focusStealingPreventionLevel
QStringList ignorePositionClasses
int killPingTimeout
bool useTranslucency
bool translucentActiveWindows
uint activeWindowOpacity
bool translucentInactiveWindows
uint inactiveWindowOpacity
bool translucentMovingWindows
uint movingWindowOpacity
bool removeShadowsOnResize
bool removeShadowsOnMove
bool translucentDocks
uint dockOpacity
bool keepAboveAsActive
bool useTitleMenuSlider
uint activeWindowShadowSize
uint inactiveWindowShadowSize
uint dockShadowSize
bool resetKompmgr

Detailed Description

Definition at line 28 of file options.h.


Member Enumeration Documentation

enum KWinInternal::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 ;-)

Definition at line 68 of file options.h.

enum KWinInternal::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.

Definition at line 125 of file options.h.

enum KWinInternal::Options::MoveResizeMode
 

MoveResizeMode, either Tranparent or Opaque.

Definition at line 140 of file options.h.

anonymous enum
 

These flags specify which settings changed when rereading settings.

Each setting in class KDecorationOptions specifies its matching flag.

Reimplemented from KDecorationDefines.

Definition at line 240 of file options.h.


Member Function Documentation

bool KWinInternal::Options::showGeometryTip  ) 
 

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

Definition at line 269 of file options.cpp.

int KWinInternal::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 274 of file options.cpp.

Referenced by KWinInternal::Workspace::clientMoved().

int KWinInternal::Options::electricBorderDelay  ) 
 

Returns:
the activation delay for electric borders in milliseconds.

Definition at line 279 of file options.cpp.

Referenced by KWinInternal::Workspace::clientMoved().


Member Data Documentation

bool KWinInternal::Options::clickRaise
 

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

Definition at line 76 of file options.h.

Referenced by KWinInternal::Client::updateMouseGrab(), and updateSettings().

bool KWinInternal::Options::autoRaise
 

whether autoraise is enabled FocusFollowsMouse mode or not.

Definition at line 81 of file options.h.

Referenced by updateSettings().

int KWinInternal::Options::autoRaiseInterval
 

autoraise interval

Definition at line 86 of file options.h.

Referenced by updateSettings().

bool KWinInternal::Options::delayFocus
 

whether delay focus is enabled or not.

Definition at line 91 of file options.h.

Referenced by updateSettings().

int KWinInternal::Options::delayFocusInterval
 

delayed focus interval

Definition at line 96 of file options.h.

Referenced by KWinInternal::Workspace::requestDelayFocus(), and updateSettings().

bool KWinInternal::Options::shadeHover
 

Whether shade hover is enabled or not.

Definition at line 101 of file options.h.

Referenced by updateSettings().

int KWinInternal::Options::shadeHoverInterval
 

shade hover interval

Definition at line 106 of file options.h.

Referenced by updateSettings().

bool KWinInternal::Options::xineramaEnabled
 

Xinerama options.

Definition at line 131 of file options.h.

Referenced by updateSettings().

bool KWinInternal::Options::animateShade
 

whether we animate the shading of windows to titlebar or not

Definition at line 158 of file options.h.

Referenced by KWinInternal::Client::setShade(), and updateSettings().

int KWinInternal::Options::borderSnapZone
 

the size of the zone that triggers snapping on desktop borders

Definition at line 163 of file options.h.

Referenced by KWinInternal::Workspace::adjustClientPosition(), KWinInternal::Workspace::adjustClientSize(), and updateSettings().

int KWinInternal::Options::windowSnapZone
 

the number of animation steps (would this be general?)

Definition at line 168 of file options.h.

Referenced by KWinInternal::Workspace::adjustClientPosition(), KWinInternal::Workspace::adjustClientSize(), and updateSettings().

bool KWinInternal::Options::snapOnlyWhenOverlapping
 

snap only when windows will overlap

Definition at line 174 of file options.h.

Referenced by KWinInternal::Workspace::adjustClientPosition(), KWinInternal::Workspace::adjustClientSize(), and updateSettings().

bool KWinInternal::Options::animateMinimize
 

whether we animate the minimization of windows or not

Definition at line 179 of file options.h.

Referenced by updateSettings().

int KWinInternal::Options::animateMinimizeSpeed
 

Animation speed (0 .

. 10 )

Definition at line 184 of file options.h.

Referenced by updateSettings().

bool KWinInternal::Options::rollOverDesktops
 

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

Definition at line 189 of file options.h.

Referenced by updateSettings().

QStringList KWinInternal::Options::ignorePositionClasses
 

List of window classes to ignore PPosition size hint.

Definition at line 197 of file options.h.

Referenced by KWinInternal::Client::manage(), and updateSettings().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kwin Library Version 3.4.3.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Jun 14 01:54:29 2006 by doxygen 1.4.4 written by Dimitri van Heesch, © 1997-2003