Make a branch to make krunner Good Enough For Aaron™.
[kdebase/uwolfer.git] / runtime / doc / kcontrol / kcmstyle / index.docbook
blob4d38cf2fcf04d5b164f386ae2b6b30671e1f29e6
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 ]>
8 <article lang="&language;">
9 <articleinfo>
11 <authorgroup>
12 <author>&Mike.McBride; &Mike.McBride.mail;</author>
13 <!-- TRANS:ROLES_OF_TRANSLATORS -->
14 </authorgroup>
16 <date>2005-02-20</date>
17 <releaseinfo>3.4</releaseinfo>
19 <keywordset>
20 <keyword>KDE</keyword>
21 <keyword>KControl</keyword>
22 <keyword>style</keyword>
23 </keywordset>
24 </articleinfo>
25 <sect1 id="style">
26 <title>Style</title>
28 <sect2 id="style-intro">
29 <title>Introduction</title>
31 <para>This module is used to configure how the individual widgets are
32 drawn by &kde;.</para>
34 <note><para>A <emphasis>Widget</emphasis> is a commonly-used
35 programmer's term for referring to User Interface elements such as
36 buttons, menus, and scroll bars. You can think of them as the
37 fundamental pieces that are assembled to make your
38 application.</para></note>
40 <para>You can configure how the widgets are drawn with this module,
41 but to change the color of the widgets, you should refer to the
42 section entitled <ulink
43 url="help:/kcontrol/color/index.html">Colors</ulink>.</para>
45 <para>This panel is divided into three tabs: <guilabel>Style</guilabel>,
46 <guilabel>Effects</guilabel>, <guilabel>Toolbar</guilabel>.</para>
48 <sect3 id="style-style">
49 <title><guilabel>Style</guilabel> tab</title>
51 <para>The top list box, labeled <guilabel>Widget Style</guilabel>
52 contains a list of the pre-defined styles.
53 Each style has a name, and a brief description.</para>
55 <para>To change styles, simply click on the style name, and a preview
56 of the style will be displayed in the preview box below the style list.</para>
58 <para>The other options available here are:</para>
60 <variablelist>
61 <varlistentry>
62 <term><guilabel>Show icons on buttons</guilabel></term>
63 <listitem>
64 <para>If this option is selected, action buttons (like <guibutton>OK</guibutton> and
65 <guibutton>Apply</guibutton>) will have a small icon located within them to act
66 as a visual reference. If this option is not selected, then only text
67 will appear on the button.</para>
68 </listitem>
69 </varlistentry>
71 <varlistentry>
72 <term><guilabel>Enable tooltips</guilabel></term>
73 <listitem>
74 <para>This will toggle tooltips off and on.</para>
75 </listitem>
76 </varlistentry>
77 </variablelist>
78 <!--
79 <varlistentry>
80 <term><guilabel>Menubar on the top of
81 the screen in the style of MacOS</guilabel></term>
82 <listitem>
83 <para>This will turn on a menubar at the top of the screen.
84 This menubar will reflect the menu options of the active
85 application.</para>
86 </listitem>
87 </varlistentry>
88 </variablelist>
89 -->
90 </sect3>
92 <sect3 id="style-effects">
93 <title><guilabel>Effects</guilabel> tab</title>
95 <para>If you click on the <guilabel>Effects</guilabel> tab, you will see the panel is divided
96 into two sections.</para>
97 <para>At the top of the first section, is a checkbox labeled <guilabel>Enable
98 GUI effects</guilabel>. If there is no mark in front of this checkbox, then all
99 visual effects of this panel are disabled. To edit any of these effects, simply
100 place a mark in this checkbox.</para>
102 <para>Below that checkbox, are the following choices: </para>
103 <variablelist>
104 <varlistentry>
105 <term><guilabel>Combobox effect:</guilabel></term>
106 <listitem><para>This combobox has two options. If this option is set to <guilabel>Animate</guilabel>
107 then when a combo box is selected, it will appear to scroll down. If <guilabel>Disable</guilabel>
108 is selected, then the combobox list appears instantly.</para></listitem>
109 </varlistentry>
111 <varlistentry>
112 <term><guilabel>Tool tip effect:</guilabel></term>
113 <listitem><para>This combobox has three options. If this option is set to <guilabel>Animate</guilabel>
114 then when a tool tip appears, it will have a short animation. If <guilabel>Fade</guilabel> is
115 selected, the tool tip appears to fade from the background. If <guilabel>Disable</guilabel>
116 is selected, then the tool tip appears instantly.</para></listitem>
117 </varlistentry>
119 <varlistentry>
120 <term><guilabel>Menu effect:</guilabel></term>
121 <listitem><para>This combobox has four options. If this option is set to <guilabel>Animate</guilabel>
122 then when a menu list appears, it will appear to scroll downward. If <guilabel>Fade</guilabel> is
123 selected, the menu list appears to fade from the background. If <guilabel>Make Transparent</guilabel>
124 is selected, the menu list will have a transparent look to it. The details of that transparency is
125 configured in the next part of the dialog. If <guilabel>Disable</guilabel>
126 is selected, then the menu list appears instantly.</para></listitem>
127 </varlistentry>
129 <varlistentry>
130 <term><guilabel>Menu tear-off handles:</guilabel></term>
131 <listitem><para>If this option is set to <guilabel>Disable</guilabel>, then no menus can be separated
132 from the application. If <guilabel>Application Level</guilabel> is selected, then it is left up
133 to each individual application to determine which menus can be torn separated from the application.</para>
134 <note><para>Many applications do not have tear off menus. You cannot tell &kde; to force an
135 application to allow tear off menus. This is determined by the authors of the application.</para></note></listitem>
136 </varlistentry>
137 </variablelist>
139 <para>The next checkbox, labeled <guilabel>Menu drop shadow</guilabel> is used to toggle the drop shadow behind all
140 &kde; menus. A drop shadow is a dark, soft line on the bottom and right sides of the menu, which give the menus the
141 appearance that the menu is lifted off the application, and the menu is creating a shadow on the application.</para>
143 <para>The next section only applies if the combobox labeled <guilabel>Menu Effect</guilabel> is set to
144 <guilabel>Make Transparent</guilabel>. You can use the combo box labeled <guilabel>Menu transparency type:</guilabel>
145 to select the method &kde; uses to generate the transparency. You can use the slider to determine the level of
146 transparency in menus. A preview is visible on the right side of this section.</para>
148 </sect3>
150 <sect3 id="style-misc">
151 <title><guilabel>Toolbar</guilabel> tab</title>
153 <variablelist>
155 <varlistentry>
156 <term><guilabel>Highlight buttons under mouse.</guilabel></term>
157 <listitem>
158 <para>If there is a mark in this checkbox, when the mouse pointer is above a toolbar
159 button, that button will be highlighted with a square around the button. This is a good visual
160 indicator of which button will be selected with a mouse click.</para>
161 </listitem>
162 </varlistentry>
164 <varlistentry>
165 <term><guilabel>Transparent toolbars when moving</guilabel></term>
166 <listitem>
167 <para>As the title suggests, if this option is selected, the toolbars will be transparent when
168 you are moving them around on the screen.</para>
169 </listitem>
170 </varlistentry>
172 <varlistentry>
173 <term><guilabel>Text position</guilabel></term>
174 <listitem>
175 <para>This combo box lets you determine where on the button the text name of the button will appear as the default.
176 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>
177 <tip><para>This option only specifies the <emphasis>default</emphasis> location. Each application can override the setting used in this panel.</para></tip>
178 </listitem>
179 </varlistentry>
181 </variablelist>
183 </sect3>
185 </sect2>
187 </sect1>
189 </article>