summaryrefslogtreecommitdiffstats
path: root/twin/options.h
diff options
context:
space:
mode:
authorTimothy Pearson <kb9vqf@pearsoncomputing.net>2011-11-07 21:50:33 -0600
committerTimothy Pearson <kb9vqf@pearsoncomputing.net>2011-11-07 21:50:33 -0600
commit0b6057404f65218182ab27a9483a21065ef61fca (patch)
treeb8b06dfa2deb965bebfbe131a772124e3e693a96 /twin/options.h
parent43d99cc2477266cb9072e179137f0e8485370b3d (diff)
downloadtdebase-0b6057404f65218182ab27a9483a21065ef61fca.tar.gz
tdebase-0b6057404f65218182ab27a9483a21065ef61fca.zip
Rename kwin to twin (Part 2 of 2)
Diffstat (limited to 'twin/options.h')
-rw-r--r--twin/options.h405
1 files changed, 405 insertions, 0 deletions
diff --git a/twin/options.h b/twin/options.h
new file mode 100644
index 000000000..2c5341f81
--- /dev/null
+++ b/twin/options.h
@@ -0,0 +1,405 @@
+/*****************************************************************
+ KWin - the KDE window manager
+ This file is part of the KDE project.
+
+Copyright (C) 1999, 2000 Matthias Ettrich <ettrich@kde.org>
+Copyright (C) 2003 Lubos Lunak <l.lunak@kde.org>
+
+You can Freely distribute this program under the GNU General Public
+License. See the file "COPYING" for the exact licensing terms.
+******************************************************************/
+
+#ifndef KWIN_OPTIONS_H
+#define KWIN_OPTIONS_H
+
+#include <tqobject.h>
+#include <tqfont.h>
+#include <tqpalette.h>
+#include <tqstringlist.h>
+#include <kdecoration_p.h>
+
+#include "placement.h"
+
+namespace KWinInternal
+{
+
+class Client;
+
+class Options : public KDecorationOptions
+ {
+ public:
+
+ Options();
+ ~Options();
+
+ virtual unsigned long updateSettings();
+
+ /*!
+ Different focus policies:
+ <ul>
+
+ <li>ClickToFocus - Clicking into a window activates it. This is
+ also the default.
+
+ <li>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.
+
+ <li>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.
+
+ <li>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 ;-)
+
+ </ul>
+ */
+ enum FocusPolicy { ClickToFocus, FocusFollowsMouse, FocusUnderMouse, FocusStrictlyUnderMouse };
+ FocusPolicy focusPolicy;
+
+
+ /**
+ Whether clicking on a window raises it in FocusFollowsMouse
+ mode or not.
+ */
+ bool clickRaise;
+
+ /**
+ whether autoraise is enabled FocusFollowsMouse mode or not.
+ */
+ bool autoRaise;
+
+ /**
+ autoraise interval
+ */
+ int autoRaiseInterval;
+
+ /**
+ whether delay focus is enabled or not.
+ */
+ bool delayFocus;
+
+ /**
+ delayed focus interval
+ */
+ int delayFocusInterval;
+
+ /**
+ Whether shade hover is enabled or not
+ */
+ bool shadeHover;
+
+ /**
+ shade hover interval
+ */
+ int shadeHoverInterval;
+
+ /**
+ Different Alt-Tab-Styles:
+ <ul>
+
+ <li> 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.
+
+ <li> 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.
+
+ </ul>
+ */
+ enum AltTabStyle { KDE, CDE };
+ AltTabStyle altTabStyle;
+
+ // whether to see Xinerama screens separately for focus (in Alt+Tab, when activating next client)
+ bool separateScreenFocus;
+ // whether active Xinerama screen is the one with mouse (or with the active window)
+ bool activeMouseScreen;
+
+ /**
+ * Xinerama options
+ */
+ bool xineramaEnabled;
+ bool xineramaPlacementEnabled;
+ bool xineramaMovementEnabled;
+ bool xineramaMaximizeEnabled;
+ bool xineramaFullscreenEnabled;
+
+ // number, or -1 = active screen (Workspace::activeScreen())
+ int xineramaPlacementScreen;
+
+ /**
+ MoveResizeMode, either Tranparent or Opaque.
+ */
+ enum MoveResizeMode { Transparent, Opaque };
+
+ MoveResizeMode resizeMode;
+ MoveResizeMode moveMode;
+
+ static MoveResizeMode stringToMoveResizeMode( const TQString& s );
+ static const char* moveResizeModeToString( MoveResizeMode mode );
+
+ Placement::Policy placement;
+
+ bool focusPolicyIsReasonable()
+ {
+ return focusPolicy == ClickToFocus || focusPolicy == FocusFollowsMouse;
+ }
+
+ /**
+ * whether we animate the shading of windows to titlebar or not
+ */
+ bool animateShade;
+
+ /**
+ * the size of the zone that triggers snapping on desktop borders
+ */
+ int borderSnapZone;
+
+ /**
+ * the number of animation steps (would this be general?)
+ */
+ int windowSnapZone;
+
+
+ /**
+ * snap only when windows will overlap
+ */
+ bool snapOnlyWhenOverlapping;
+
+ /**
+ * whether we animate the minimization of windows or not
+ */
+ bool animateMinimize;
+
+ /**
+ * Animation speed (0 .. 10 )
+ */
+ int animateMinimizeSpeed;
+
+ bool showDesktopIsMinimizeAll;
+
+ /**
+ * whether or not we roll over to the other edge when switching desktops past the edge
+ */
+ bool rollOverDesktops;
+
+ // 0 - 4 , see Workspace::allowClientActivation()
+ int focusStealingPreventionLevel;
+
+ /**
+ * List of window classes to ignore PPosition size hint
+ */
+ TQStringList ignorePositionClasses;
+
+ bool checkIgnoreFocusStealing( const Client* c );
+
+ WindowOperation operationTitlebarDblClick() { return OpTitlebarDblClick; }
+
+ 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
+ };
+
+ MouseCommand operationTitlebarMouseWheel( int delta )
+ {
+ return wheelToMouseCommand( CmdTitlebarWheel, delta );
+ }
+ MouseCommand operationWindowMouseWheel( int delta )
+ {
+ return wheelToMouseCommand( CmdAllWheel, delta );
+ }
+
+ MouseCommand commandActiveTitlebar1() { return CmdActiveTitlebar1; }
+ MouseCommand commandActiveTitlebar2() { return CmdActiveTitlebar2; }
+ MouseCommand commandActiveTitlebar3() { return CmdActiveTitlebar3; }
+ MouseCommand commandInactiveTitlebar1() { return CmdInactiveTitlebar1; }
+ MouseCommand commandInactiveTitlebar2() { return CmdInactiveTitlebar2; }
+ MouseCommand commandInactiveTitlebar3() { return CmdInactiveTitlebar3; }
+ MouseCommand commandWindow1() { return CmdWindow1; }
+ MouseCommand commandWindow2() { return CmdWindow2; }
+ MouseCommand commandWindow3() { return CmdWindow3; }
+ MouseCommand commandAll1() { return CmdAll1; }
+ MouseCommand commandAll2() { return CmdAll2; }
+ MouseCommand commandAll3() { return CmdAll3; }
+ uint keyCmdAllModKey() { return CmdAllModKey; }
+
+
+ static WindowOperation windowOperation(const TQString &name, bool restricted );
+ static MouseCommand mouseCommand(const TQString &name, bool restricted );
+ static MouseWheelCommand mouseWheelCommand(const TQString &name);
+
+ /**
+ * @returns true if the Geometry Tip should be shown during a window move/resize.
+ * @since 3.2
+ */
+ bool showGeometryTip();
+
+ /**
+ * @returns A TQColor representing the colour that window drop shadows should
+ * be.
+ */
+ TQColor &shadowColour(bool active=true);
+
+ /**
+ * @returns true if shadows should be drawn around windows of the
+ * specified type
+ */
+ bool shadowWindowType(NET::WindowType t);
+
+ /**
+ * @returns true if window shadows should be drawn
+ */
+ bool shadowEnabled(bool active=true);
+
+ /**
+ * @returns Window shadow's opacity between 0.01 and 1.00.
+ */
+ double shadowOpacity(bool active=true);
+
+ /**
+ * @returns How thick a shadow should be to either side of of a window.
+ */
+ int shadowThickness(bool active=true);
+
+ /**
+ * @returns Number of pixels along the X-axis by which to offset window
+ * shadows.
+ */
+ int shadowXOffset(bool active=true);
+
+ /**
+ * @returns Number of pixels along the Y-axis by which to offset window
+ * shadows.
+ */
+ int shadowYOffset(bool active=true);
+
+ enum { ElectricDisabled = 0, ElectricMoveOnly = 1, ElectricAlways = 2 };
+ /**
+ * @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
+ */
+ int electricBorders();
+
+ /**
+ * @returns the activation delay for electric borders in milliseconds.
+ */
+ int electricBorderDelay();
+
+ bool topMenuEnabled() const { return topmenus; }
+ bool desktopTopMenu() const { return desktop_topmenu; }
+
+ // timeout before non-responding application will be killed after attempt to close
+ int killPingTimeout;
+
+ // Whether to hide utility windows for inactive applications.
+ bool hideUtilityWindowsForInactive;
+
+ //translucency settings
+ 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;
+ uint menuShadowSize;
+ bool onlyDecoTranslucent;
+ bool resetKompmgr;
+ bool tabboxOutline;
+
+ private:
+ WindowOperation OpTitlebarDblClick;
+
+ // mouse bindings
+ MouseCommand CmdActiveTitlebar1;
+ MouseCommand CmdActiveTitlebar2;
+ MouseCommand CmdActiveTitlebar3;
+ MouseCommand CmdInactiveTitlebar1;
+ MouseCommand CmdInactiveTitlebar2;
+ MouseCommand CmdInactiveTitlebar3;
+ MouseWheelCommand CmdTitlebarWheel;
+ MouseCommand CmdWindow1;
+ MouseCommand CmdWindow2;
+ MouseCommand CmdWindow3;
+ MouseCommand CmdAll1;
+ MouseCommand CmdAll2;
+ MouseCommand CmdAll3;
+ MouseWheelCommand CmdAllWheel;
+ uint CmdAllModKey;
+
+ int electric_borders;
+ int electric_border_delay;
+ bool show_geometry_tip;
+ bool topmenus;
+ bool desktop_topmenu;
+ TQColor shadow_colour;
+ TQColor shadow_inactive_colour;
+ bool shadow_docks;
+ bool shadow_menus;
+ bool shadow_overrides;
+ bool shadow_topMenus;
+ bool shadow_inactive_enabled;
+ bool shadow_enabled;
+ double shadow_inactive_opacity;
+ double shadow_opacity;
+ int shadow_inactive_thickness;
+ int shadow_thickness;
+ int shadow_inactive_x_offset;
+ int shadow_x_offset;
+ int shadow_inactive_y_offset;
+ int shadow_y_offset;
+ // List of window classes for which not to use focus stealing prevention
+ TQStringList ignoreFocusStealingClasses;
+
+ MouseCommand wheelToMouseCommand( MouseWheelCommand com, int delta );
+ };
+
+extern Options* options;
+
+} // namespace
+
+#endif