Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-release > by-pkgid > 3cd8ed2ba8c8318377f50d8a76dbe3c4 > files > 186

kdebase-devel-doc-3.5.9-36mdv2008.1.x86_64.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en_US" xml:lang="en_US">

<head>
  <title>kwin: options.h Source File (kwin)</title>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

  <meta http-equiv="Content-Style-Type" content="text/css" />

  <meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org"  r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org"  r (n 0 s 0 v 0 l 0))' />

  <meta name="trademark" content="KDE e.V." />
  <meta name="description" content="K Desktop Environment Homepage, KDE.org" />
  <meta name="MSSmartTagsPreventParsing" content="true" />
  <meta name="robots" content="all" />

  <link rel="shortcut icon" href="../../favicon.ico" />

<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />



</head>

<body>

<div id="nav_header_top" align="right">
  <a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>

  <a href="../.."><img id="nav_header_logo" alt="Home" align="left" src="../../kde_gear_64.png" border="0" /></a>
  <span class="doNotDisplay">::</span>

  <div id="nav_header_title" align="left">KDE API Reference</div>


</div>

<div id="nav_header_bottom" align="right">
  <span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
  <div id="nav_header_bottom_right" style="text-align: left;">
/ <a href="../..">API Reference</a>
 / <a href=".">kwin</a>
  </div>
</div>


<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
      <td valign="top" class="menuheader" height="0"></td>

  <td id="contentcolumn" valign="top" rowspan="2" >
    <div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
    <a name="content"></a>


<!-- Generated by Doxygen 1.5.5 -->
<h1>options.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*****************************************************************</span>
<a name="l00002"></a>00002 <span class="comment"> KWin - the KDE window manager</span>
<a name="l00003"></a>00003 <span class="comment"> This file is part of the KDE project.</span>
<a name="l00004"></a>00004 <span class="comment"></span>
<a name="l00005"></a>00005 <span class="comment">Copyright (C) 1999, 2000 Matthias Ettrich &lt;ettrich@kde.org&gt;</span>
<a name="l00006"></a>00006 <span class="comment">Copyright (C) 2003 Lubos Lunak &lt;l.lunak@kde.org&gt;</span>
<a name="l00007"></a>00007 <span class="comment"></span>
<a name="l00008"></a>00008 <span class="comment">You can Freely distribute this program under the GNU General Public</span>
<a name="l00009"></a>00009 <span class="comment">License. See the file "COPYING" for the exact licensing terms.</span>
<a name="l00010"></a>00010 <span class="comment">******************************************************************/</span>
<a name="l00011"></a>00011 
<a name="l00012"></a>00012 <span class="preprocessor">#ifndef KWIN_OPTIONS_H</span>
<a name="l00013"></a>00013 <span class="preprocessor"></span><span class="preprocessor">#define KWIN_OPTIONS_H</span>
<a name="l00014"></a>00014 <span class="preprocessor"></span>
<a name="l00015"></a>00015 <span class="preprocessor">#include &lt;qobject.h&gt;</span>
<a name="l00016"></a>00016 <span class="preprocessor">#include &lt;qfont.h&gt;</span>
<a name="l00017"></a>00017 <span class="preprocessor">#include &lt;qpalette.h&gt;</span>
<a name="l00018"></a>00018 <span class="preprocessor">#include &lt;qstringlist.h&gt;</span>
<a name="l00019"></a>00019 <span class="preprocessor">#include &lt;kdecoration_p.h&gt;</span>
<a name="l00020"></a>00020 
<a name="l00021"></a>00021 <span class="preprocessor">#include "placement.h"</span>
<a name="l00022"></a>00022 
<a name="l00023"></a>00023 <span class="keyword">namespace </span>KWinInternal
<a name="l00024"></a>00024 {
<a name="l00025"></a>00025 
<a name="l00026"></a>00026 <span class="keyword">class </span>Client;
<a name="l00027"></a>00027 
<a name="l00028"></a>00028 <span class="keyword">class </span>Options : <span class="keyword">public</span> KDecorationOptions 
<a name="l00029"></a>00029     {
<a name="l00030"></a>00030     <span class="keyword">public</span>:
<a name="l00031"></a>00031 
<a name="l00032"></a>00032         Options();
<a name="l00033"></a>00033         ~Options();
<a name="l00034"></a>00034 
<a name="l00035"></a>00035         <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> updateSettings();
<a name="l00036"></a>00036 
<a name="l00068"></a>00068         <span class="keyword">enum</span> FocusPolicy { ClickToFocus, FocusFollowsMouse, FocusUnderMouse, FocusStrictlyUnderMouse };
<a name="l00069"></a>00069         FocusPolicy focusPolicy;
<a name="l00070"></a>00070 
<a name="l00071"></a>00071 
<a name="l00076"></a>00076         <span class="keywordtype">bool</span> clickRaise;
<a name="l00077"></a>00077 
<a name="l00081"></a>00081         <span class="keywordtype">bool</span> autoRaise;
<a name="l00082"></a>00082 
<a name="l00086"></a>00086         <span class="keywordtype">int</span> autoRaiseInterval;
<a name="l00087"></a>00087 
<a name="l00091"></a>00091         <span class="keywordtype">bool</span> delayFocus;
<a name="l00092"></a>00092 
<a name="l00096"></a>00096         <span class="keywordtype">int</span> delayFocusInterval;
<a name="l00097"></a>00097 
<a name="l00101"></a>00101         <span class="keywordtype">bool</span> shadeHover;
<a name="l00102"></a>00102 
<a name="l00106"></a>00106         <span class="keywordtype">int</span> shadeHoverInterval;
<a name="l00107"></a>00107 
<a name="l00125"></a>00125         <span class="keyword">enum</span> AltTabStyle { KDE, CDE };
<a name="l00126"></a>00126         AltTabStyle altTabStyle;
<a name="l00127"></a>00127 
<a name="l00131"></a>00131         <span class="keywordtype">bool</span> xineramaEnabled;
<a name="l00132"></a>00132         <span class="keywordtype">bool</span> xineramaPlacementEnabled;
<a name="l00133"></a>00133         <span class="keywordtype">bool</span> xineramaMovementEnabled;
<a name="l00134"></a>00134         <span class="keywordtype">bool</span> xineramaMaximizeEnabled;
<a name="l00135"></a>00135         <span class="keywordtype">bool</span> xineramaFullscreenEnabled;
<a name="l00136"></a>00136 
<a name="l00140"></a>00140         <span class="keyword">enum</span> MoveResizeMode { Transparent, Opaque };
<a name="l00141"></a>00141 
<a name="l00142"></a>00142         MoveResizeMode resizeMode;
<a name="l00143"></a>00143         MoveResizeMode moveMode;
<a name="l00144"></a>00144         
<a name="l00145"></a>00145         <span class="keyword">static</span> MoveResizeMode stringToMoveResizeMode( <span class="keyword">const</span> QString&amp; s );
<a name="l00146"></a>00146         <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* moveResizeModeToString( MoveResizeMode mode );
<a name="l00147"></a>00147 
<a name="l00148"></a>00148         Placement::Policy placement;
<a name="l00149"></a>00149 
<a name="l00150"></a>00150         <span class="keywordtype">bool</span> focusPolicyIsReasonable() 
<a name="l00151"></a>00151             {
<a name="l00152"></a>00152             <span class="keywordflow">return</span> focusPolicy == ClickToFocus || focusPolicy == FocusFollowsMouse;
<a name="l00153"></a>00153             }
<a name="l00154"></a>00154 
<a name="l00158"></a>00158         <span class="keywordtype">bool</span> animateShade;
<a name="l00159"></a>00159 
<a name="l00163"></a>00163         <span class="keywordtype">int</span> borderSnapZone;
<a name="l00164"></a>00164 
<a name="l00168"></a>00168         <span class="keywordtype">int</span> windowSnapZone;
<a name="l00169"></a>00169 
<a name="l00170"></a>00170 
<a name="l00174"></a>00174         <span class="keywordtype">bool</span> snapOnlyWhenOverlapping;
<a name="l00175"></a>00175 
<a name="l00179"></a>00179         <span class="keywordtype">bool</span>  animateMinimize;
<a name="l00180"></a>00180 
<a name="l00184"></a>00184         <span class="keywordtype">int</span> animateMinimizeSpeed;
<a name="l00185"></a>00185         
<a name="l00186"></a>00186         <span class="keywordtype">bool</span> showDesktopIsMinimizeAll;
<a name="l00187"></a>00187 
<a name="l00191"></a>00191         <span class="keywordtype">bool</span> rollOverDesktops;
<a name="l00192"></a>00192 
<a name="l00193"></a>00193         <span class="comment">// 0 - 4 , see Workspace::allowClientActivation()</span>
<a name="l00194"></a>00194         <span class="keywordtype">int</span> focusStealingPreventionLevel;
<a name="l00195"></a>00195 
<a name="l00199"></a>00199         QStringList ignorePositionClasses;
<a name="l00200"></a>00200         
<a name="l00201"></a>00201         <span class="keywordtype">bool</span> checkIgnoreFocusStealing( <span class="keyword">const</span> Client* c );
<a name="l00202"></a>00202 
<a name="l00203"></a>00203         WindowOperation operationTitlebarDblClick() { <span class="keywordflow">return</span> OpTitlebarDblClick; }
<a name="l00204"></a>00204 
<a name="l00205"></a>00205         <span class="keyword">enum</span> MouseCommand 
<a name="l00206"></a>00206             {
<a name="l00207"></a>00207             MouseRaise, MouseLower, MouseOperationsMenu, MouseToggleRaiseAndLower,
<a name="l00208"></a>00208             MouseActivateAndRaise, MouseActivateAndLower, MouseActivate,
<a name="l00209"></a>00209             MouseActivateRaiseAndPassClick, MouseActivateAndPassClick,
<a name="l00210"></a>00210             MouseMove, MouseUnrestrictedMove,
<a name="l00211"></a>00211             MouseActivateRaiseAndMove, MouseActivateRaiseAndUnrestrictedMove,
<a name="l00212"></a>00212             MouseResize, MouseUnrestrictedResize,
<a name="l00213"></a>00213             MouseShade, MouseSetShade, MouseUnsetShade,
<a name="l00214"></a>00214             MouseMaximize, MouseRestore, MouseMinimize,
<a name="l00215"></a>00215             MouseNextDesktop, MousePreviousDesktop,
<a name="l00216"></a>00216             MouseAbove, MouseBelow,
<a name="l00217"></a>00217             MouseOpacityMore, MouseOpacityLess,
<a name="l00218"></a>00218             MouseNothing
<a name="l00219"></a>00219             };
<a name="l00220"></a>00220             
<a name="l00221"></a>00221         <span class="keyword">enum</span> MouseWheelCommand
<a name="l00222"></a>00222             {
<a name="l00223"></a>00223             MouseWheelRaiseLower, MouseWheelShadeUnshade, MouseWheelMaximizeRestore,
<a name="l00224"></a>00224             MouseWheelAboveBelow, MouseWheelPreviousNextDesktop,
<a name="l00225"></a>00225             MouseWheelChangeOpacity,
<a name="l00226"></a>00226             MouseWheelNothing
<a name="l00227"></a>00227             };
<a name="l00228"></a>00228 
<a name="l00229"></a>00229         MouseCommand operationTitlebarMouseWheel( <span class="keywordtype">int</span> delta )
<a name="l00230"></a>00230             {
<a name="l00231"></a>00231             <span class="keywordflow">return</span> wheelToMouseCommand( CmdTitlebarWheel, delta );
<a name="l00232"></a>00232             }
<a name="l00233"></a>00233         MouseCommand operationWindowMouseWheel( <span class="keywordtype">int</span> delta )
<a name="l00234"></a>00234             {
<a name="l00235"></a>00235             <span class="keywordflow">return</span> wheelToMouseCommand( CmdAllWheel, delta );
<a name="l00236"></a>00236             }
<a name="l00237"></a>00237 
<a name="l00238"></a>00238         MouseCommand commandActiveTitlebar1() { <span class="keywordflow">return</span> CmdActiveTitlebar1; }
<a name="l00239"></a>00239         MouseCommand commandActiveTitlebar2() { <span class="keywordflow">return</span> CmdActiveTitlebar2; }
<a name="l00240"></a>00240         MouseCommand commandActiveTitlebar3() { <span class="keywordflow">return</span> CmdActiveTitlebar3; }
<a name="l00241"></a>00241         MouseCommand commandInactiveTitlebar1() { <span class="keywordflow">return</span> CmdInactiveTitlebar1; }
<a name="l00242"></a>00242         MouseCommand commandInactiveTitlebar2() { <span class="keywordflow">return</span> CmdInactiveTitlebar2; }
<a name="l00243"></a>00243         MouseCommand commandInactiveTitlebar3() { <span class="keywordflow">return</span> CmdInactiveTitlebar3; }
<a name="l00244"></a>00244         MouseCommand commandWindow1() { <span class="keywordflow">return</span> CmdWindow1; }
<a name="l00245"></a>00245         MouseCommand commandWindow2() { <span class="keywordflow">return</span> CmdWindow2; }
<a name="l00246"></a>00246         MouseCommand commandWindow3() { <span class="keywordflow">return</span> CmdWindow3; }
<a name="l00247"></a>00247         MouseCommand commandAll1() { <span class="keywordflow">return</span> CmdAll1; }
<a name="l00248"></a>00248         MouseCommand commandAll2() { <span class="keywordflow">return</span> CmdAll2; }
<a name="l00249"></a>00249         MouseCommand commandAll3() { <span class="keywordflow">return</span> CmdAll3; }
<a name="l00250"></a>00250         uint keyCmdAllModKey() { <span class="keywordflow">return</span> CmdAllModKey; }
<a name="l00251"></a>00251 
<a name="l00252"></a>00252 
<a name="l00253"></a>00253         <span class="keyword">static</span> WindowOperation windowOperation(<span class="keyword">const</span> QString &amp;name, <span class="keywordtype">bool</span> restricted );
<a name="l00254"></a>00254         <span class="keyword">static</span> MouseCommand mouseCommand(<span class="keyword">const</span> QString &amp;name, <span class="keywordtype">bool</span> restricted );
<a name="l00255"></a>00255         <span class="keyword">static</span> MouseWheelCommand mouseWheelCommand(<span class="keyword">const</span> QString &amp;name);
<a name="l00256"></a>00256 
<a name="l00261"></a>00261         <span class="keywordtype">bool</span> showGeometryTip();
<a name="l00262"></a>00262 
<a name="l00263"></a>00263         <span class="keyword">enum</span> { ElectricDisabled = 0, ElectricMoveOnly = 1, ElectricAlways = 2 };
<a name="l00269"></a>00269         <span class="keywordtype">int</span> electricBorders();
<a name="l00270"></a>00270 
<a name="l00274"></a>00274         <span class="keywordtype">int</span> electricBorderDelay();
<a name="l00275"></a>00275         
<a name="l00276"></a>00276         <span class="keywordtype">bool</span> topMenuEnabled()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> topmenus; }
<a name="l00277"></a>00277         <span class="keywordtype">bool</span> desktopTopMenu()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> desktop_topmenu; }
<a name="l00278"></a>00278         
<a name="l00279"></a>00279         <span class="comment">// timeout before non-responding application will be killed after attempt to close</span>
<a name="l00280"></a>00280         <span class="keywordtype">int</span> killPingTimeout;
<a name="l00281"></a>00281         
<a name="l00282"></a>00282         <span class="comment">// Whether to hide utility windows for inactive applications.</span>
<a name="l00283"></a>00283         <span class="keywordtype">bool</span> hideUtilityWindowsForInactive;
<a name="l00284"></a>00284 
<a name="l00285"></a>00285         <span class="comment">//translucency settings</span>
<a name="l00286"></a>00286         <span class="keywordtype">bool</span> useTranslucency;
<a name="l00287"></a>00287         <span class="keywordtype">bool</span> translucentActiveWindows;
<a name="l00288"></a>00288         uint activeWindowOpacity;
<a name="l00289"></a>00289         <span class="keywordtype">bool</span> translucentInactiveWindows;
<a name="l00290"></a>00290         uint inactiveWindowOpacity;
<a name="l00291"></a>00291         <span class="keywordtype">bool</span> translucentMovingWindows;
<a name="l00292"></a>00292         uint movingWindowOpacity;
<a name="l00293"></a>00293         <span class="keywordtype">bool</span> removeShadowsOnResize;
<a name="l00294"></a>00294         <span class="keywordtype">bool</span> removeShadowsOnMove;
<a name="l00295"></a>00295         <span class="keywordtype">bool</span> translucentDocks;
<a name="l00296"></a>00296         uint dockOpacity;
<a name="l00297"></a>00297         <span class="keywordtype">bool</span> keepAboveAsActive;
<a name="l00298"></a>00298         <span class="keywordtype">bool</span> useTitleMenuSlider;
<a name="l00299"></a>00299         uint activeWindowShadowSize;
<a name="l00300"></a>00300         uint inactiveWindowShadowSize;
<a name="l00301"></a>00301         uint dockShadowSize;
<a name="l00302"></a>00302         <span class="keywordtype">bool</span> onlyDecoTranslucent;
<a name="l00303"></a>00303         <span class="keywordtype">bool</span> resetKompmgr;
<a name="l00304"></a>00304         <span class="keywordtype">bool</span> tabboxOutline;
<a name="l00305"></a>00305 
<a name="l00306"></a>00306     <span class="keyword">private</span>:
<a name="l00307"></a>00307         WindowOperation OpTitlebarDblClick;
<a name="l00308"></a>00308 
<a name="l00309"></a>00309     <span class="comment">// mouse bindings</span>
<a name="l00310"></a>00310         MouseCommand CmdActiveTitlebar1;
<a name="l00311"></a>00311         MouseCommand CmdActiveTitlebar2;
<a name="l00312"></a>00312         MouseCommand CmdActiveTitlebar3;
<a name="l00313"></a>00313         MouseCommand CmdInactiveTitlebar1;
<a name="l00314"></a>00314         MouseCommand CmdInactiveTitlebar2;
<a name="l00315"></a>00315         MouseCommand CmdInactiveTitlebar3;
<a name="l00316"></a>00316         MouseWheelCommand CmdTitlebarWheel;
<a name="l00317"></a>00317         MouseCommand CmdWindow1;
<a name="l00318"></a>00318         MouseCommand CmdWindow2;
<a name="l00319"></a>00319         MouseCommand CmdWindow3;
<a name="l00320"></a>00320         MouseCommand CmdAll1;
<a name="l00321"></a>00321         MouseCommand CmdAll2;
<a name="l00322"></a>00322         MouseCommand CmdAll3;
<a name="l00323"></a>00323         MouseWheelCommand CmdAllWheel;
<a name="l00324"></a>00324         uint CmdAllModKey;
<a name="l00325"></a>00325 
<a name="l00326"></a>00326         <span class="keywordtype">int</span> electric_borders;
<a name="l00327"></a>00327         <span class="keywordtype">int</span> electric_border_delay;
<a name="l00328"></a>00328         <span class="keywordtype">bool</span> show_geometry_tip;
<a name="l00329"></a>00329         <span class="keywordtype">bool</span> topmenus;
<a name="l00330"></a>00330         <span class="keywordtype">bool</span> desktop_topmenu;
<a name="l00331"></a>00331         <span class="comment">// List of window classes for which not to use focus stealing prevention</span>
<a name="l00332"></a>00332         QStringList ignoreFocusStealingClasses;
<a name="l00333"></a>00333 
<a name="l00334"></a>00334         MouseCommand wheelToMouseCommand( MouseWheelCommand com, <span class="keywordtype">int</span> delta );
<a name="l00335"></a>00335     };
<a name="l00336"></a>00336 
<a name="l00337"></a>00337 <span class="keyword">extern</span> Options* options;
<a name="l00338"></a>00338 
<a name="l00339"></a>00339 } <span class="comment">// namespace</span>
<a name="l00340"></a>00340 
<a name="l00341"></a>00341 <span class="preprocessor">#endif</span>
</pre></div></div>
    </div></div>


      </td>
  </tr>
  <tr>
    <td valign="top" id="leftmenu" width="25%">
      <a name="navigation"></a>
      <div class="menu_box"><h2>kwin</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="functions.html">Class Members</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
  <option value="classKWinInternal_1_1Client.html">kwininternal::client</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../kate/html/index.html">kate</a></li><li><a href="../../kwin/html/index.html">kwin</a></li><li>&nbsp;&nbsp;<a href="../../kwin/lib/html/index.html">lib</a></li><li><a href="../../libkonq/html/index.html">libkonq</a></li>
</ul></div></div>


        </td>
</tr>
</table>

<span class="doNotDisplay">
  <a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
  <a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
  <a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>


<div style="height: 8px"></div>

<div id="footer">
  <div id="footer_left">
    Maintained by <a href="&#109;&#97;&#105;&#108;&#116;&#111;&#58;groo&#116;&#64;kde&#46;or&#x67;">Adriaan de Groot</a>
and
<a href="&#109;a&#105;&#108;&#116;&#111;&#58;w&#105;nter&#64;kde&#46;or&#x67">Allen Winter</a>.
<br/>
    KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
    <a href="http://www.kde.org/contact/impressum.php">Legal</a>
  </div>
  <div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>

<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->

</body>
</html>