1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3 <!--Converted with LaTeX2HTML 2002-2-1 (1.71)
4 original version by: Nikos Drakos, CBLU, University of Leeds
5 * revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
6 * with significant contributions from:
7 Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
10 <TITLE>4. Graphical styles</TITLE>
11 <META NAME="description" CONTENT="4. Graphical styles">
12 <META NAME="keywords" CONTENT="ionconf">
13 <META NAME="resource-type" CONTENT="document">
14 <META NAME="distribution" CONTENT="global">
16 <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
17 <META NAME="Generator" CONTENT="LaTeX2HTML v2002-2-1">
18 <META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
20 <LINK REL="STYLESHEET" HREF="ionconf.css">
22 <LINK REL="next" HREF="node6.html">
23 <LINK REL="previous" HREF="node4.html">
24 <LINK REL="up" HREF="ionconf.html">
25 <LINK REL="next" HREF="node6.html">
30 <DIV CLASS="navigation"><!--Navigation Panel-->
33 <IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
36 <IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
39 <IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
42 <IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
45 <IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index" SRC="index.png"></A>
47 <B> Next:</B> <A NAME="tex2html331"
48 HREF="node6.html">5. Scripting</A>
49 <B> Up:</B> <A NAME="tex2html325"
50 HREF="ionconf.html">Configuring and extending Ion3</A>
51 <B> Previous:</B> <A NAME="tex2html319"
52 HREF="node4.html">3. Basic configuration</A>
53 <B> <A NAME="tex2html327"
54 HREF="node1.html">Contents</A></B>
55 <B> <A NAME="tex2html329"
56 HREF="node11.html">Index</A></B>
59 <!--End of Navigation Panel-->
60 <!--Table of Child-Links-->
61 <A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A>
63 <UL CLASS="ChildLinks">
64 <LI><A NAME="tex2html332"
65 HREF="node5.html#SECTION00510000000000000000"><SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">1</SPAN> Drawing engines, style specifications and sub-styles</A>
67 <LI><A NAME="tex2html333"
68 HREF="node5.html#SECTION00511000000000000000"><SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">1</SPAN> Known styles and substyles</A>
70 <LI><A NAME="tex2html334"
71 HREF="node5.html#SECTION00511100000000000000"><SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">1</SPAN> Frames</A>
72 <LI><A NAME="tex2html335"
73 HREF="node5.html#SECTION00511200000000000000"><SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">2</SPAN> Tabs and menu entries</A>
74 <LI><A NAME="tex2html336"
75 HREF="node5.html#SECTION00511300000000000000"><SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">3</SPAN> The rest</A>
79 <LI><A NAME="tex2html337"
80 HREF="node5.html#SECTION00520000000000000000"><SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">2</SPAN> Defining styles for the default drawing engine</A>
82 <LI><A NAME="tex2html338"
83 HREF="node5.html#SECTION00521000000000000000"><SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">2</SPAN>.<SPAN CLASS="arabic">1</SPAN> The structure of the configuration files</A>
84 <LI><A NAME="tex2html339"
85 HREF="node5.html#SECTION00522000000000000000"><SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">2</SPAN>.<SPAN CLASS="arabic">2</SPAN> Defining the styles</A>
87 <LI><A NAME="tex2html340"
88 HREF="node5.html#SECTION00522100000000000000"><SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">2</SPAN>.<SPAN CLASS="arabic">2</SPAN>.<SPAN CLASS="arabic">1</SPAN> Colours</A>
89 <LI><A NAME="tex2html341"
90 HREF="node5.html#SECTION00522200000000000000"><SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">2</SPAN>.<SPAN CLASS="arabic">2</SPAN>.<SPAN CLASS="arabic">2</SPAN> Borders and widths</A>
91 <LI><A NAME="tex2html342"
92 HREF="node5.html#SECTION00522300000000000000"><SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">2</SPAN>.<SPAN CLASS="arabic">2</SPAN>.<SPAN CLASS="arabic">3</SPAN> Text</A>
93 <LI><A NAME="tex2html343"
94 HREF="node5.html#SECTION00522400000000000000"><SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">2</SPAN>.<SPAN CLASS="arabic">2</SPAN>.<SPAN CLASS="arabic">4</SPAN> Miscellaneous</A>
95 <LI><A NAME="tex2html344"
96 HREF="node5.html#SECTION00522500000000000000"><SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">2</SPAN>.<SPAN CLASS="arabic">2</SPAN>.<SPAN CLASS="arabic">5</SPAN> Substyles</A>
98 <LI><A NAME="tex2html345"
99 HREF="node5.html#SECTION00523000000000000000"><SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">2</SPAN>.<SPAN CLASS="arabic">3</SPAN> An example</A>
102 <LI><A NAME="tex2html346"
103 HREF="node5.html#SECTION00530000000000000000"><SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">3</SPAN> Miscellaneous settings</A>
105 <LI><A NAME="tex2html347"
106 HREF="node5.html#SECTION00531000000000000000"><SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">3</SPAN>.<SPAN CLASS="arabic">1</SPAN> Frame user attributes</A>
107 <LI><A NAME="tex2html348"
108 HREF="node5.html#SECTION00532000000000000000"><SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">3</SPAN>.<SPAN CLASS="arabic">2</SPAN> Extra fields for style `<TT>frame</TT>'</A>
109 <LI><A NAME="tex2html349"
110 HREF="node5.html#SECTION00533000000000000000"><SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">3</SPAN>.<SPAN CLASS="arabic">3</SPAN> Extra fields for style `<TT>dock</TT>'</A>
112 <!--End of Table of Child-Links-->
115 <H1><A NAME="SECTION00500000000000000000"></A>
116 <A NAME="chap:gr"></A>
118 <SPAN CLASS="arabic">4</SPAN>. Graphical styles
122 This chapter first gives in section <A HREF="#sec:engines">4.1</A> a general outline
123 of how drawing engines are used, of style specifications and then
124 in section <A HREF="#sec:defaultde">4.2</A> describes how to specify styles
125 for the default drawing engine. Some additional settings and
126 user attributes are explained in Sections <A HREF="#sec:grmisc">4.3</A>.
130 <H2><A NAME="SECTION00510000000000000000"></A>
131 <A NAME="sec:engines"></A><A NAME="1906"></A><A NAME="1907"></A>
133 <SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">1</SPAN> Drawing engines, style specifications and sub-styles
137 Ion's drawing routines are abstracted into so-called drawing engine
138 modules that can, again depending on the system, be dynamically
139 loaded as needed. The drawing engine modules provide ``brushes''
140 that objects can use to draw some high-level primitives such
141 as borders and text boxes (in addition to simple text and rectangle
142 drawing) on their windows and configure e.g. the shape and
143 background of the window. While the drawing engines therefore
144 do not directly implement looks for each possible object (that
145 would hardly be maintainable), different brush styles can be
146 used to give a distinctive look to different objects and engines
147 could interpret some styles as special cases. Style specifications
148 are strings of the form
152 element1-element2-...-elementn
156 An example of such a style specification is `<TT>tab-frame</TT>';
157 see the table in subsection <A HREF="#sec:styles">4.1.1</A> for more styles.
160 When an object asks for a brush of certain style, the selected
161 drawing engine will attempt to find the closest match to this
162 specification. The styles/brushes defined by the drawing engines
163 may have asterisks (`<TT>*</TT>') as some of the elements indicating
164 a match to anything. Exact matches are preferred to asterisk
165 matches and longer matches to shorter. For example, let a brush
166 for style `<TT>foo-bar-baz</TT>' be queried, then the following
167 brushes are in order of preference:
178 Some of the drawing primitives allow extra attributes to be
179 specified, also in the form
181 attr1-attr2-...-attrn
183 These extra attributes are called <SPAN CLASS="textit">substyles</SPAN><A NAME="1919"></A>
184 and allow, for example, the state of the object to be indicated
185 by different colour sets while keeping the interface at an
186 abstract level and the drawing engine completely ignorant
187 of the semantics - only the writer of the drawing engine
188 configuration file has to know them. However the drawing
189 engine can again interpret known substyles as special cases
190 and the default engine indeed does so with frame tab
191 tag and drag states.)
195 <H3><A NAME="SECTION00511000000000000000"></A>
196 <A NAME="sec:styles"></A>
198 <SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">1</SPAN> Known styles and substyles
203 <H4><A NAME="SECTION00511100000000000000">
204 <SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">1</SPAN> Frames</A>
208 <TABLE CELLPADDING=3 BORDER="1" WIDTH="100%">
209 <TR><TD ALIGN="LEFT">Style name</TD>
210 <TD ALIGN="LEFT">Description</TD>
212 <TR><TD ALIGN="LEFT">`<TT>frame</TT>'</TD>
213 <TD ALIGN="LEFT">Style for frames.
214 Substyle attributes: `<TT>active</TT>'/`<TT>inactive</TT>'
215 (mutually exclusive), and
216 `<TT>quasiactive</TT>'.
217 A frame is ``quasiactive'' when an active region
218 has a back-link to it, such as a detached window.</TD>
220 <TR><TD ALIGN="LEFT">`<TT>frame-tiled</TT>'</TD>
221 <TD ALIGN="LEFT">A more specific style for tiled frames.
222 Substyle attributes as for `<TT>frame</TT>'.</TD>
224 <TR><TD ALIGN="LEFT">`<TT>frame-tiled-alt</TT>'</TD>
225 <TD ALIGN="LEFT">An alternative style for tiled frames.
226 Often used to disable the tab-bar.</TD>
228 <TR><TD ALIGN="LEFT">`<TT>frame-floating</TT>'</TD>
229 <TD ALIGN="LEFT">A more specific style for floating
232 <TR><TD ALIGN="LEFT">`<TT>frame-transient</TT>'</TD>
233 <TD ALIGN="LEFT">A more specific style for frames
234 containing transient windows.</TD>
240 <H4><A NAME="SECTION00511200000000000000">
241 <SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">2</SPAN> Tabs and menu entries</A>
245 <TABLE CELLPADDING=3 BORDER="1" WIDTH="100%">
246 <TR><TD ALIGN="LEFT">Style name</TD>
247 <TD ALIGN="LEFT">Description</TD>
249 <TR><TD ALIGN="LEFT">`<TT>tab</TT>'</TD>
250 <TD ALIGN="LEFT">Style for frames' tabs and menu entries.
252 `<TT>active</TT>'/`<TT>inactive</TT>' and
253 `<TT>selected</TT>'/`<TT>unselected</TT>'</TD>
255 <TR><TD ALIGN="LEFT">`<TT>tab-frame</TT>'</TD>
256 <TD ALIGN="LEFT">A more specific style for frames' tabs.
257 Additional substyle attributes include those of
258 the `<TT>frame</TT>' style, as well as tab-specific
259 `<TT>tagged</TT>'/`<TT>not_tagged</TT>',
260 `<TT>dragged</TT>'/`<TT>not_dragged</TT>', and
261 `<TT>activity</TT>'/`<TT>no_activity</TT>'.</TD>
263 <TR><TD ALIGN="LEFT">`<TT>tab-frame-tiled</TT>',</TD>
264 <TD ALIGN="LEFT"> </TD>
266 <TR><TD ALIGN="LEFT">`<TT>tab-frame-tiled-alt</TT>',</TD>
267 <TD ALIGN="LEFT"> </TD>
269 <TR><TD ALIGN="LEFT">`<TT>tab-frame-floating</TT>',</TD>
270 <TD ALIGN="LEFT"> </TD>
272 <TR><TD ALIGN="LEFT">`<TT>tab-frame-transient</TT>'</TD>
273 <TD ALIGN="LEFT">More specific styles for frames in the
274 different modes.</TD>
276 <TR><TD ALIGN="LEFT">`<TT>tab-menuentry</TT>'</TD>
277 <TD ALIGN="LEFT">A more specific style for entries in WMenus.
278 Additional substyle attributes include `<TT>submenu</TT>' and
279 occasionally also `<TT>activity</TT>' is used.</TD>
281 <TR><TD ALIGN="LEFT">`<TT>tab-menuentry-bigmenu</TT>'</TD>
282 <TD ALIGN="LEFT">An alternate style for entries in WMenus.</TD>
284 <TR><TD ALIGN="LEFT">`<TT>tab-info</TT>'</TD>
285 <TD ALIGN="LEFT">Extra information tab (displayed e.g. for tagged workspaces).</TD>
291 <H4><A NAME="SECTION00511300000000000000">
292 <SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">3</SPAN> The rest</A>
296 <TABLE CELLPADDING=3 BORDER="1" WIDTH="100%">
297 <TR><TD ALIGN="LEFT">Style name</TD>
298 <TD ALIGN="LEFT">Description</TD>
300 <TR><TD ALIGN="LEFT">`<TT>input</TT>'</TD>
301 <TD ALIGN="LEFT">A style for WInputs.</TD>
303 <TR><TD ALIGN="LEFT">`<TT>input-edln</TT>'</TD>
304 <TD ALIGN="LEFT">A more specific style for WEdlns.
305 Substyle attributes: `<TT>selection</TT>' for selected text and
306 `<TT>cursor</TT>' for the cursor indicating current editing point.</TD>
308 <TR><TD ALIGN="LEFT">`<TT>input-message</TT>'</TD>
309 <TD ALIGN="LEFT">A more specific style for WMessages.</TD>
311 <TR><TD ALIGN="LEFT">`<TT>input-menu</TT>'</TD>
312 <TD ALIGN="LEFT">A more specific style for WMenus.</TD>
314 <TR><TD ALIGN="LEFT">`<TT>input-menu-bigmenu</TT>'</TD>
315 <TD ALIGN="LEFT">An alternate style for WMenus.</TD>
317 <TR><TD ALIGN="LEFT">`<TT>moveres_display</TT>'</TD>
318 <TD ALIGN="LEFT">The box displaying position/size when
319 moving or resizing frames.</TD>
321 <TR><TD ALIGN="LEFT">`<TT>actnotify</TT>'</TD>
322 <TD ALIGN="LEFT">Actification notification box.</TD>
324 <TR><TD ALIGN="LEFT">`<TT>stdisp</TT>'</TD>
325 <TD ALIGN="LEFT">Any status display.</TD>
327 <TR><TD ALIGN="LEFT">`<TT>stdisp-dock</TT>'</TD>
328 <TD ALIGN="LEFT">The dock.</TD>
330 <TR><TD ALIGN="LEFT">`<TT>stdisp-statusbar</TT>'</TD>
331 <TD ALIGN="LEFT">The statusbar. Substyles include:
332 the name of any monitor/meter (such as `<TT>date</TT>'), and
333 the supplied hint. Typical hints are: `<TT>normal</TT>',
334 `<TT>important</TT>', and `<TT>critical</TT>'.</TD>
340 <H2><A NAME="SECTION00520000000000000000"></A>
341 <A NAME="sec:defaultde"></A>
343 <SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">2</SPAN> Defining styles for the default drawing engine
347 Drawing engine style files are usually named
348 <SPAN CLASS="textit">look_foo.lua</SPAN> where <SPAN CLASS="textit">foo</SPAN> is the name of the
349 style. The file that Ion loads on startup or when
350 <A HREF="node7.html#fn:gr.read_config"><TT>gr.read_config</TT></A> is called, however, is <SPAN CLASS="textit">look.lua</SPAN>
351 and should usually be symlinked to or a copy of of some
352 <SPAN CLASS="textit">look_foo.lua</SPAN>.
356 <H3><A NAME="SECTION00521000000000000000">
357 <SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">2</SPAN>.<SPAN CLASS="arabic">1</SPAN> The structure of the configuration files</A>
361 The first thing to do in a style file is to choose the drawing
362 engine, possibly loading the module as well. This is done
363 with the following chunk of code.
367 if not gr.select_engine("de") then
373 The <A HREF="node7.html#fn:gr.select_engine"><TT>gr.select_engine</TT></A> function sees if the engine
374 given as argument is registered (the default drawing engine is
375 simply called ``de''). If the engine could not be found, it
376 tries to load a module of the same name. If the engine still
377 is not registered, <A HREF="node7.html#fn:gr.select_engine"><TT>gr.select_engine</TT></A> returns `<TT>false</TT>'
378 and in this case we also exit the style setup script.
379 If the engine was found, <A HREF="node7.html#fn:gr.select_engine"><TT>gr.select_engine</TT></A> sees that
380 further requests for brushes are forwarded to that engine
381 and returns `<TT>true</TT>'.
384 Before defining new styles it may be a good idea to clear old
385 styles from memory so if the old configuration defines more
386 specific styles than the new, the old styles don't override
387 those specified by the new configuration. That can be done by
396 After this the new styles can be defined with <A HREF="node7.html#fn:de.defstyle"><TT>de.defstyle</TT></A>
397 as explained in the next subsection. Finally, after the styles have
398 been defined we must ask objects on the screen to look up new brushes
399 to reflect the changes in configuration. This is done with
408 <H3><A NAME="SECTION00522000000000000000">
409 <SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">2</SPAN>.<SPAN CLASS="arabic">2</SPAN> Defining the styles</A>
413 Styles for the default drawing engine are defined with the
414 function <A HREF="node7.html#fn:de.defstyle"><TT>de.defstyle</TT></A>. It has two arguments the first being
415 a style specification as explained in previous sections and the second
416 a table whose fields describe the style:
420 de.defstyle("some-style", {
427 The supported attributes are described in tables below. The different
428 border elements and styles referred to there are explained in Figure
429 <A HREF="#fig:borders">4.1</A>.
433 <DIV ALIGN="CENTER"><A NAME="fig:borders"></A><A NAME="2022"></A>
435 <CAPTION ALIGN="BOTTOM"><STRONG>Figure 4.1:</STRONG>
436 Sketch of different border styles and elements</CAPTION>
438 Elevated: Inlaid: Ridge: Groove:
439 hhhhhhhhhhhs ............ hhhhhhhhhhhs sssssssssssh
440 h..........s .sssssssssh. h..........s s..........h
441 h. .s .s h. h.sssssssh.s s.hhhhhhhs.h
442 h. .s .s h. h.s h.s s.h s.h
443 h. .s .s h. h.shhhhhhh.s s.hsssssss.h
444 h..........s .shhhhhhhhh. h..........s s..........h
445 hsssssssssss ............ hsssssssssss shhhhhhhhhhh
447 h = highlight, s = shadow, . = padding
454 <H4><A NAME="SECTION00522100000000000000">
455 <SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">2</SPAN>.<SPAN CLASS="arabic">2</SPAN>.<SPAN CLASS="arabic">1</SPAN> Colours</A>
459 Each of these fields a string of the form that can be
460 passed to <TT>XAllocNamedColor</TT>. Valid strings are e.g.
461 hexadecimal RGB specifications of the form
462 <TT>#RRGGBB</TT> and colour names as specified
463 in <SPAN CLASS="textit">/usr/X11R6/lib/X11/rgb.txt</SPAN> (exact path varying).
466 <TABLE CELLPADDING=3 BORDER="1" WIDTH="100%">
467 <TR><TD ALIGN="LEFT">Field</TD>
468 <TD ALIGN="LEFT">Description</TD>
470 <TR><TD ALIGN="LEFT"><TT>highlight_colour</TT></TD>
471 <TD ALIGN="LEFT">Colour for the ``highlight'' part of a border.</TD>
473 <TR><TD ALIGN="LEFT"><TT>shadow_colour</TT></TD>
474 <TD ALIGN="LEFT">Colour for the ``shadow'' part of a border.</TD>
476 <TR><TD ALIGN="LEFT"><TT>foreground_colour</TT></TD>
477 <TD ALIGN="LEFT">Colour for the normal drawing operations, e.g. text.</TD>
479 <TR><TD ALIGN="LEFT"><TT>background_colour</TT></TD>
480 <TD ALIGN="LEFT">Window background colour (unless transparency is enabled) and
481 background colour boxes.</TD>
483 <TR><TD ALIGN="LEFT"><TT>padding_colour</TT></TD>
484 <TD ALIGN="LEFT">Colour for the ``padding'' part of a border border. Set to
485 <TT>background_colour</TT> if unset.</TD>
491 <H4><A NAME="SECTION00522200000000000000">
492 <SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">2</SPAN>.<SPAN CLASS="arabic">2</SPAN>.<SPAN CLASS="arabic">2</SPAN> Borders and widths</A>
496 All other fields below except <TT>border_style</TT> are non-negative integers
497 indicating a number of pixels.
500 <TABLE CELLPADDING=3 BORDER="1" WIDTH="100%">
501 <TR><TD ALIGN="LEFT">Field</TD>
502 <TD ALIGN="LEFT">Description</TD>
504 <TR><TD ALIGN="LEFT"><TT>border_style</TT></TD>
505 <TD ALIGN="LEFT">A string indicating the style of border; one of
506 `<TT>elevated</TT>'/`<TT>inlaid</TT>'/`<TT>ridge</TT>'/`<TT>groove</TT>'
507 as seen in the above sketch.</TD>
509 <TR><TD ALIGN="LEFT"><TT>border_sides</TT></TD>
510 <TD ALIGN="LEFT">A string indicating which sides of the border
511 to draw: `<TT>all</TT>'/`<TT>tb</TT>'/`<TT>lr</TT>' for all,
512 top and bottom, and left and right. To control between
513 left/right and top/bottom, use the pixel options below.</TD>
515 <TR><TD ALIGN="LEFT"><TT>highlight_pixels</TT></TD>
516 <TD ALIGN="LEFT">Width of the highlight part of the border in pixels.</TD>
518 <TR><TD ALIGN="LEFT"><TT>shadow_pixels</TT></TD>
519 <TD ALIGN="LEFT">Width of the shadow part of the border in pixels.</TD>
521 <TR><TD ALIGN="LEFT"><TT>padding_pixels</TT></TD>
522 <TD ALIGN="LEFT">Width of the padding part of the border in pixels.</TD>
524 <TR><TD ALIGN="LEFT"><TT>spacing</TT></TD>
525 <TD ALIGN="LEFT">Space to be left between all kinds of boxes.</TD>
531 <H4><A NAME="SECTION00522300000000000000">
532 <SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">2</SPAN>.<SPAN CLASS="arabic">2</SPAN>.<SPAN CLASS="arabic">3</SPAN> Text</A>
536 <TABLE CELLPADDING=3 BORDER="1" WIDTH="100%">
537 <TR><TD ALIGN="LEFT">Field</TD>
538 <TD ALIGN="LEFT">Description</TD>
540 <TR><TD ALIGN="LEFT"><TT>font</TT></TD>
541 <TD ALIGN="LEFT">Font to be used in text-drawing operations; standard X font
544 <TR><TD ALIGN="LEFT"><TT>text_align</TT></TD>
545 <TD ALIGN="LEFT">How text is to be aligned in text boxes/tabs; one of
546 the strings `<TT>left</TT>'/`<TT>right</TT>'/`<TT>center</TT>'.</TD>
552 <H4><A NAME="SECTION00522400000000000000">
553 <SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">2</SPAN>.<SPAN CLASS="arabic">2</SPAN>.<SPAN CLASS="arabic">4</SPAN> Miscellaneous</A>
557 <TABLE CELLPADDING=3 BORDER="1" WIDTH="100%">
558 <TR><TD ALIGN="LEFT">Field</TD>
559 <TD ALIGN="LEFT">Description</TD>
561 <TR><TD ALIGN="LEFT"><TT>transparent_background</TT></TD>
562 <TD ALIGN="LEFT">Should windows' that use this style
563 background be transparent? true/false.</TD>
565 <TR><TD ALIGN="LEFT"><TT>based_on</TT></TD>
566 <TD ALIGN="LEFT">The name of a previously defined style that this
567 style should be based on.</TD>
573 <H4><A NAME="SECTION00522500000000000000">
574 <SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">2</SPAN>.<SPAN CLASS="arabic">2</SPAN>.<SPAN CLASS="arabic">5</SPAN> Substyles</A>
578 As discussed in previous sections, styles may have substyles to e.g.
579 indicate different states of the object being drawn. The ``de'' engine
580 limits what can be configured in substyles to the set of colours in the
581 first table above, but also specifically interprets for the main style
582 `<TT>tab-frame</TT>' the substyles `<TT>*-*-tagged</TT>' and `<TT>*-*-*-dragged</TT>'
583 by, respectively, drawing a right angle shape at the top right corner
584 of a tab and by shading the tab with a stipple pattern. Also for
585 menus the substyles `<TT>*-*-submenu</TT>' are handled as a special case.
588 Substyles are defined with the function <A HREF="node7.html#fn:de.substyle"><TT>de.substyle</TT></A> within the
589 table defining the main style. The parameters to this function are
590 similar to those of <A HREF="node7.html#fn:de.defstyle"><TT>de.defstyle</TT></A>.
594 de.defstyle("some-style", {
596 de.substyle("some-substyle", {
605 <H3><A NAME="SECTION00523000000000000000">
606 <SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">2</SPAN>.<SPAN CLASS="arabic">3</SPAN> An example</A>
610 The following shortened segment from <SPAN CLASS="textit">look_cleanviolet.lua</SPAN>
611 should help to clarify the matters discussed in the previous
618 highlight_colour = "#eeeeee",
619 shadow_colour = "#eeeeee",
620 background_colour = "#aaaaaa",
621 foreground_colour = "#000000",
624 highlight_pixels = 1,
627 border_style = "elevated",
629 font = "-*-helvetica-medium-r-normal-*-12-*-*-*-*-*-*-*",
630 text_align = "center",
633 de.defstyle("tab-frame", {
636 de.substyle("active-selected", {
638 highlight_colour = "#aaaacc",
639 shadow_colour = "#aaaacc",
640 background_colour = "#666699",
641 foreground_colour = "#eeeeee",
644 -- More substyles would follow ...
650 <H2><A NAME="SECTION00530000000000000000"></A>
651 <A NAME="sec:grmisc"></A>
653 <SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">3</SPAN> Miscellaneous settings
658 <H3><A NAME="SECTION00531000000000000000">
659 <SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">3</SPAN>.<SPAN CLASS="arabic">1</SPAN> Frame user attributes</A>
663 The function <A HREF="node7.html#fn:WFrame.set_grattr"><TT>WFrame.set_grattr</TT></A> may be used to give frames
664 (and their tabs) arbitrary extra attributes to be passed to the
665 drawing engine. Hence, by configuring such substyles in the style
666 configuration files, and turning on the attribute when needed,
667 scripts may display visual cues related to the frame. There is
668 also one extra attribute specially interpreted by the default
669 drawing engine: the `<TT>numbered</TT>' attribute, which causes
670 numbers to be displayed on the tabs.
674 <H3><A NAME="SECTION00532000000000000000">
675 <SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">3</SPAN>.<SPAN CLASS="arabic">2</SPAN> Extra fields for style `<TT>frame</TT>'</A>
679 The following style fields are independent of the drawing engine used,
680 but are related to objects' styles and therefore configured in the drawing
681 engine configuration file.
684 <TABLE CELLPADDING=3 BORDER="1" WIDTH="100%">
685 <TR><TD ALIGN="LEFT">Field</TD>
686 <TD ALIGN="LEFT">Description</TD>
688 <TR><TD ALIGN="LEFT"><TT>bar</TT></TD>
689 <TD ALIGN="LEFT">Controls the style of the tab-bar. Possible values
690 are the strings `<TT>none</TT>', `<TT>inside</TT>', `<TT>outside</TT>'
691 and `<TT>shaped</TT>', with the last providing the PWM-style
692 tab-bars for floating frames.</TD>
694 <TR><TD ALIGN="LEFT"><TT>floatframe_tab_min_w</TT></TD>
695 <TD ALIGN="LEFT">Minimum tab width in pixels for
696 the shaped style, given that this number times number of tabs
697 doesn't exceed frame width.</TD>
699 <TR><TD ALIGN="LEFT"><TT>floatframe_bar_max_w_q</TT></TD>
700 <TD ALIGN="LEFT">Maximum tab-bar width quotient of
701 frame width for the shaped styles. A number in the
702 interval <SPAN CLASS="MATH"><IMG
703 WIDTH="41" HEIGHT="36" ALIGN="MIDDLE" BORDER="0"
705 ALT="$(0, 1]$"></SPAN>.</TD>
711 <H3><A NAME="SECTION00533000000000000000">
712 <SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">3</SPAN>.<SPAN CLASS="arabic">3</SPAN> Extra fields for style `<TT>dock</TT>'</A>
716 <TABLE CELLPADDING=3 BORDER="1" WIDTH="100%">
717 <TR><TD ALIGN="LEFT">Field</TD>
718 <TD ALIGN="LEFT">Description</TD>
720 <TR><TD ALIGN="LEFT"><TT>outline_style</TT></TD>
721 <TD ALIGN="LEFT">How borders are drawn:
722 `<TT>none</TT>' - no border,
723 `<TT>all</TT>' - border around whole dock,
724 `<TT>each</TT>' - border around each dockapp.</TD>
726 <TR><TD ALIGN="LEFT"><TT>tile_size</TT></TD>
727 <TD ALIGN="LEFT">A table with entries `<TT>width</TT>' and `<TT>height</TT>',
728 indicating the width and height of tiles in pixels.</TD>
733 Hopefully that's enough to get you started in writing new style
734 configuration files for Ion. When in doubt, study the existing
735 style configuration files.
739 <DIV CLASS="navigation"><HR>
740 <!--Navigation Panel-->
741 <A NAME="tex2html330"
743 <IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
744 <A NAME="tex2html324"
746 <IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
747 <A NAME="tex2html318"
749 <IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
750 <A NAME="tex2html326"
752 <IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
753 <A NAME="tex2html328"
755 <IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index" SRC="index.png"></A>
757 <B> Next:</B> <A NAME="tex2html331"
758 HREF="node6.html">5. Scripting</A>
759 <B> Up:</B> <A NAME="tex2html325"
760 HREF="ionconf.html">Configuring and extending Ion3</A>
761 <B> Previous:</B> <A NAME="tex2html319"
762 HREF="node4.html">3. Basic configuration</A>
763 <B> <A NAME="tex2html327"
764 HREF="node1.html">Contents</A></B>
765 <B> <A NAME="tex2html329"
766 HREF="node11.html">Index</A></B> </DIV>
767 <!--End of Navigation Panel-->