← Back to branch summary

~ubuntu-branches/ubuntu/utopic/kde-workspace/utopic-proposed

« back to all changes in this revision

Viewing changes to doc/kcontrol/kwincompositing/index.docbook

  • Committer: Bazaar Package Importer
  • Author(s): Michał Zając
  • Date: 2011-07-09 08:31:15 UTC
  • Revision ID: james.westby@ubuntu.com-20110709083115-ohyxn6z93mily9fc
Tags: upstream-4.6.90
Import upstream version 4.6.90

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/kcontrol/kwincompositing/index.docbook
 
1
<?xml version="1.0" ?>
 
2
<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN"
 
3
"dtd/kdex.dtd" [
 
4
<!ENTITY % addindex "IGNORE">
 
5
<!ENTITY % English "INCLUDE" > <!-- change language only here -->
 
6
]>
 
7
 
 
8
<article lang="&language;">
 
9
<articleinfo>
 
10
 
 
11
<title>Desktop Effects</title>
 
12
<authorgroup>
 
13
<author>&Mike.McBride; &Mike.McBride.mail;</author>
 
14
<!-- TRANS:ROLES_OF_TRANSLATORS -->
 
15
</authorgroup>
 
16
 
 
17
<date>2009-02-10</date>
 
18
<releaseinfo>&kde; 4.2</releaseinfo>
 
19
 
 
20
<keywordset>
 
21
<keyword>KDE</keyword>
 
22
<keyword>KControl</keyword>
 
23
<keyword>desktop</keyword>
 
24
<keyword>effects</keyword>
 
25
</keywordset>
 
26
</articleinfo>
 
27
<sect1 id="desktop-effects">
 
28
<title>Desktop Effects</title>
 
29
 
 
30
<sect2 id="desktop-effects-intro">
 
31
<title>Introduction</title>
 
32
 
 
33
<para>This module is used to configure desktop effects
 
34
for &kde;.</para>
 
35
 
 
36
 
 
37
<para>This panel is divided into three tabs:  <guilabel>General</guilabel>, 
 
38
<guilabel>All Effects</guilabel> and <guilabel>Advanced</guilabel>.</para>
 
39
 
 
40
<sect3 id="desktop-effects-general">
 
41
<title><guilabel>General</guilabel> tab</title>
 
42
 
 
43
<para>At the top of this tab is a checkbox labeled <guilabel>Enable 
 
44
desktop effects</guilabel>.  If there is no mark in front of this checkbox, then all 
 
45
visual effects of this panel are disabled.  To edit any of these effects, simply 
 
46
place a mark in this checkbox.</para>
 
47
 
 
48
<para>Below that checkbox there are some common settings for the desktop effects like 
 
49
improved window management, shadows, various animations, effects for desktop and 
 
50
window switching and the animation speed.</para>
 
51
<!-- outdated needs a rewrite
 
52
<variablelist>
 
53
<varlistentry>
 
54
<term><guilabel>Combobox effect:</guilabel></term>
 
55
<listitem><para>This combobox has two options.  If this option is set to <guilabel>Animate</guilabel> 
 
56
then when a combo box is selected, it will appear to scroll down.  If <guilabel>Disable</guilabel> 
 
57
is selected, then the combobox list appears instantly.</para></listitem>
 
58
</varlistentry>
 
59
 
 
60
<varlistentry>
 
61
<term><guilabel>Tool tip effect:</guilabel></term>
 
62
<listitem><para>This combobox has three options.  If this option is set to <guilabel>Animate</guilabel> 
 
63
then when a tool tip appears, it will have a short animation.  If <guilabel>Fade</guilabel> is 
 
64
selected, the tool tip appears to fade from the background.  If <guilabel>Disable</guilabel> 
 
65
is selected, then the tool tip appears instantly.</para></listitem>
 
66
</varlistentry>
 
67
 
 
68
<varlistentry>
 
69
<term><guilabel>Menu effect:</guilabel></term>
 
70
<listitem><para>This combobox has four options.  If this option is set to <guilabel>Animate</guilabel> 
 
71
then when a menu list appears, it will appear to scroll downward.  If <guilabel>Fade</guilabel> is 
 
72
selected, the menu list appears to fade from the background.  If <guilabel>Make Transparent</guilabel> 
 
73
is selected, the menu list will have a transparent look to it.  The details of that transparency is 
 
74
configured in the next part of the dialog.  If <guilabel>Disable</guilabel> 
 
75
is selected, then the menu list appears instantly.</para></listitem>
 
76
</varlistentry>
 
77
 
 
78
<varlistentry>
 
79
<term><guilabel>Menu tear-off handles:</guilabel></term>
 
80
<listitem><para>If this option is set to <guilabel>Disable</guilabel>, then no menus can be separated 
 
81
from the application. If <guilabel>Application Level</guilabel> is selected, then it is left up 
 
82
to each individual application to determine which menus can be torn separated from the application.</para>
 
83
<note><para>Many applications do not have tear off menus.  You cannot tell &kde; to force an 
 
84
application to allow tear off menus.  This is determined by the authors of the application.</para></note></listitem>
 
85
</varlistentry>
 
86
</variablelist>
 
87
 
 
88
<para>The next checkbox, labeled <guilabel>Menu drop shadow</guilabel> is used to toggle the drop shadow behind all 
 
89
&kde; menus.  A drop shadow is a dark, soft line on the bottom and right sides of the menu, which give the menus the 
 
90
appearance that the menu is lifted off the application, and the menu is creating a shadow on the application.</para>
 
91
 
 
92
<para>The next section only applies if the combobox labeled <guilabel>Menu Effect</guilabel> is set to 
 
93
<guilabel>Make Transparent</guilabel>.  You can use the combo box labeled <guilabel>Menu transparency type:</guilabel> 
 
94
to select the method &kde; uses to generate the transparency.  You can use the slider to determine the level of 
 
95
transparency in menus.  A preview is visible on the right side of this section.</para>
 
96
-->
 
97
</sect3>
 
98
 
 
99
<sect3 id="desktop-alleffects">
 
100
<title><guilabel>All Effects</guilabel> tab</title>
 
101
 
 
102
<para>The main part of this page is a list of all available effects grouped 
 
103
by <guilabel>Accessibility</guilabel>, <guilabel>Appearance</guilabel>, 
 
104
<guilabel>Candy</guilabel>, <guilabel>Focus</guilabel> and <guilabel>Tools</guilabel>.
 
105
Use the incremental search bar above the list window to find items in the list.</para>
 
106
 
 
107
<para>Check an effect in the list to enable it. Display the <guilabel>About</guilabel> 
 
108
dialog by clicking the info button at the right side of the list item. 
 
109
Some effects have settings options, in this case there is a tool button 
 
110
at the left of the info button. Click it to open a configuration dialog.</para>
 
111
<!--
 
112
<variablelist> 
 
113
 
 
114
<varlistentry> 
 
115
<term><guilabel>Highlight buttons under mouse.</guilabel></term>
 
116
<listitem>
 
117
<para>If there is a mark in this checkbox, when the mouse pointer is above a toolbar 
 
118
button, that button will be highlighted with a square around the button.  This is a good visual 
 
119
indicator of which button will be selected with a mouse click.</para>
 
120
</listitem> 
 
121
</varlistentry> 
 
122
 
 
123
<varlistentry> 
 
124
<term><guilabel>Transparent toolbars when moving</guilabel></term>
 
125
<listitem>
 
126
<para>As the title suggests, if this option is selected, the toolbars will be transparent when 
 
127
you are moving them around on the screen.</para>
 
128
</listitem> 
 
129
</varlistentry> 
 
130
 
 
131
<varlistentry> 
 
132
<term><guilabel>Text position</guilabel></term>
 
133
<listitem>
 
134
<para>This combo box lets you determine where on the button the text name of the button will appear as the default.  
 
135
If <guilabel>Icon Only</guilabel> is selected, then there is no text on the toolbar buttons.  If  <guilabel>Text Only</guilabel> is selected, then the button's icon is replaced with a text name of  the button. If <guilabel>Text Alongside Icons</guilabel> is selected, then the name of the button will be placed to the <emphasis>right</emphasis> of the icon. If <guilabel>Text Under Icons</guilabel> is selected, the default will be to have the text of the button <emphasis>below</emphasis> the icon.</para>
 
136
<tip><para>This option only specifies the <emphasis>default</emphasis> location.  Each application can override the setting used in this panel.</para></tip>
 
137
</listitem> 
 
138
</varlistentry> 
 
139
 
 
140
</variablelist>
 
141
-->
 
142
</sect3>
 
143
 
 
144
<sect3 id="desktop-advanced">
 
145
<title><guilabel>Advanced</guilabel> tab</title>
 
146
 
 
147
<para>On this tab you can select a <guilabel>Compositing type</guilabel> (<guilabel>OpenGL</guilabel> or <guilabel>XRender</guilabel>) 
 
148
and set some options for the selected type.
 
149
</para>
 
150
</sect3>
 
151
 
 
152
 
 
153
</sect2>
 
154
 
 
155
</sect1>
 
156
 
 
157
</article>