]> git.decadent.org.uk Git - ion3.git/blob - doc/ionconf/node1.html
b243cb3c3a5a6b5cc6bdb6bd5964bcd49d9c3ed8
[ion3.git] / doc / ionconf / node1.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2
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 -->
8 <HTML>
9 <HEAD>
10 <TITLE>Contents</TITLE>
11 <META NAME="description" CONTENT="Contents">
12 <META NAME="keywords" CONTENT="ionconf">
13 <META NAME="resource-type" CONTENT="document">
14 <META NAME="distribution" CONTENT="global">
15
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">
19
20 <LINK REL="STYLESHEET" HREF="ionconf.css">
21
22 <LINK REL="next" HREF="node2.html">
23 <LINK REL="previous" HREF="ionconf.html">
24 <LINK REL="up" HREF="ionconf.html">
25 <LINK REL="next" HREF="node2.html">
26 </HEAD>
27
28 <BODY >
29
30 <DIV CLASS="navigation"><!--Navigation Panel-->
31 <A NAME="tex2html133"
32   HREF="node2.html">
33 <IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A> 
34 <A NAME="tex2html129"
35   HREF="ionconf.html">
36 <IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A> 
37 <A NAME="tex2html123"
38   HREF="ionconf.html">
39 <IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>  
40 <A NAME="tex2html131"
41   HREF="node11.html">
42 <IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index" SRC="index.png"></A> 
43 <BR>
44 <B> Next:</B> <A NAME="tex2html134"
45   HREF="node2.html">1. Introduction</A>
46 <B> Up:</B> <A NAME="tex2html130"
47   HREF="ionconf.html">Configuring and extending Ion3</A>
48 <B> Previous:</B> <A NAME="tex2html124"
49   HREF="ionconf.html">Configuring and extending Ion3</A>
50  &nbsp; <B>  <A NAME="tex2html132"
51   HREF="node11.html">Index</A></B> 
52 <BR>
53 <BR></DIV>
54 <!--End of Navigation Panel-->
55 <BR>
56
57 <H2><A NAME="SECTION00100000000000000000">
58 Contents</A>
59 </H2>
60 <!--Table of Contents-->
61
62 <UL CLASS="TofC">
63 <LI><A NAME="tex2html135"
64   HREF="node2.html">1. Introduction</A>
65 <LI><A NAME="tex2html136"
66   HREF="node3.html">2. Preliminaries: Key concepts and relations</A>
67 <UL>
68 <LI><A NAME="tex2html137"
69   HREF="node3.html#SECTION00310000000000000000">2.1 Modules</A>
70 <LI><A NAME="tex2html138"
71   HREF="node3.html#SECTION00320000000000000000">2.2 Class and object hierarchies</A>
72 <UL>
73 <LI><A NAME="tex2html139"
74   HREF="node3.html#SECTION00321000000000000000">2.2.1 Class hierarchy</A>
75 <LI><A NAME="tex2html140"
76   HREF="node3.html#SECTION00322000000000000000">2.2.2 Object hierarchies: WRegion parents and managers</A>
77 <LI><A NAME="tex2html141"
78   HREF="node3.html#SECTION00323000000000000000">2.2.3 Summary</A>
79 </UL>
80 </UL>
81 <BR>
82 <LI><A NAME="tex2html142"
83   HREF="node4.html">3. Basic configuration</A>
84 <UL>
85 <LI><A NAME="tex2html143"
86   HREF="node4.html#SECTION00410000000000000000">3.1 The configuration files</A>
87 <LI><A NAME="tex2html144"
88   HREF="node4.html#SECTION00420000000000000000">3.2 A walk through cfg_ion.lua</A>
89 <LI><A NAME="tex2html145"
90   HREF="node4.html#SECTION00430000000000000000">3.3 Keys and rodents</A>
91 <UL>
92 <LI><A NAME="tex2html146"
93   HREF="node4.html#SECTION00431000000000000000">3.3.1 Binding handlers and special variables</A>
94 <LI><A NAME="tex2html147"
95   HREF="node4.html#SECTION00432000000000000000">3.3.2 Guards</A>
96 <LI><A NAME="tex2html148"
97   HREF="node4.html#SECTION00433000000000000000">3.3.3 Defining the bindings</A>
98 <LI><A NAME="tex2html149"
99   HREF="node4.html#SECTION00434000000000000000">3.3.4 Examples</A>
100 <LI><A NAME="tex2html150"
101   HREF="node4.html#SECTION00435000000000000000">3.3.5 Key specifications</A>
102 <LI><A NAME="tex2html151"
103   HREF="node4.html#SECTION00436000000000000000">3.3.6 Button specifications</A>
104 <LI><A NAME="tex2html152"
105   HREF="node4.html#SECTION00437000000000000000">3.3.7 A further note on the default binding configuration</A>
106 </UL>
107 <LI><A NAME="tex2html153"
108   HREF="node4.html#SECTION00440000000000000000">3.4 Menus</A>
109 <UL>
110 <LI><A NAME="tex2html154"
111   HREF="node4.html#SECTION00441000000000000000">3.4.1 Defining menus</A>
112 <LI><A NAME="tex2html155"
113   HREF="node4.html#SECTION00442000000000000000">3.4.2 Special menus</A>
114 <LI><A NAME="tex2html156"
115   HREF="node4.html#SECTION00443000000000000000">3.4.3 Defining context menus</A>
116 <LI><A NAME="tex2html157"
117   HREF="node4.html#SECTION00444000000000000000">3.4.4 Displaying menus</A>
118 </UL>
119 <LI><A NAME="tex2html158"
120   HREF="node4.html#SECTION00450000000000000000">3.5 Winprops</A>
121 <UL>
122 <LI><A NAME="tex2html159"
123   HREF="node4.html#SECTION00451000000000000000">3.5.1 Sizehint winprops</A>
124 <LI><A NAME="tex2html160"
125   HREF="node4.html#SECTION00452000000000000000">3.5.2 Classes, roles and instances</A>
126 <LI><A NAME="tex2html161"
127   HREF="node4.html#SECTION00453000000000000000">3.5.3 Finding window identification</A>
128 <LI><A NAME="tex2html162"
129   HREF="node4.html#SECTION00454000000000000000">3.5.4 Some common examples</A>
130 </UL>
131 </UL>
132 <BR>
133 <LI><A NAME="tex2html163"
134   HREF="node5.html">4. Graphical styles</A>
135 <UL>
136 <LI><A NAME="tex2html164"
137   HREF="node5.html#SECTION00510000000000000000">4.1 Drawing engines, style specifications and sub-styles</A>
138 <UL>
139 <LI><A NAME="tex2html165"
140   HREF="node5.html#SECTION00511000000000000000">4.1.1 Known styles and substyles</A>
141 </UL>
142 <LI><A NAME="tex2html166"
143   HREF="node5.html#SECTION00520000000000000000">4.2 Defining styles for the default drawing engine</A>
144 <UL>
145 <LI><A NAME="tex2html167"
146   HREF="node5.html#SECTION00521000000000000000">4.2.1 The structure of the configuration files</A>
147 <LI><A NAME="tex2html168"
148   HREF="node5.html#SECTION00522000000000000000">4.2.2 Defining the styles</A>
149 <LI><A NAME="tex2html169"
150   HREF="node5.html#SECTION00523000000000000000">4.2.3 An example</A>
151 </UL>
152 <LI><A NAME="tex2html170"
153   HREF="node5.html#SECTION00530000000000000000">4.3 Miscellaneous settings</A>
154 <UL>
155 <LI><A NAME="tex2html171"
156   HREF="node5.html#SECTION00531000000000000000">4.3.1 Extra fields for style frame</A>
157 <LI><A NAME="tex2html172"
158   HREF="node5.html#SECTION00532000000000000000">4.3.2 Extra fields for style dock</A>
159 </UL>
160 </UL>
161 <BR>
162 <LI><A NAME="tex2html173"
163   HREF="node6.html">5. Scripting</A>
164 <UL>
165 <LI><A NAME="tex2html174"
166   HREF="node6.html#SECTION00610000000000000000">5.1 Hooks</A>
167 <LI><A NAME="tex2html175"
168   HREF="node6.html#SECTION00620000000000000000">5.2 Referring to regions</A>
169 <UL>
170 <LI><A NAME="tex2html176"
171   HREF="node6.html#SECTION00621000000000000000">5.2.1 Direct object references</A>
172 <LI><A NAME="tex2html177"
173   HREF="node6.html#SECTION00622000000000000000">5.2.2 Name-based lookups</A>
174 </UL>
175 <LI><A NAME="tex2html178"
176   HREF="node6.html#SECTION00630000000000000000">5.3 Alternative winprop selection criteria</A>
177 <LI><A NAME="tex2html179"
178   HREF="node6.html#SECTION00640000000000000000">5.4 Writing ion-statusd monitors</A>
179 </UL>
180 <BR>
181 <LI><A NAME="tex2html180"
182   HREF="node7.html">6. Function reference</A>
183 <UL>
184 <LI><A NAME="tex2html181"
185   HREF="node7.html#SECTION00710000000000000000">6.1 Functions defined in ioncore</A>
186 <UL>
187 <LI><A NAME="tex2html182"
188   HREF="node7.html#SECTION00711000000000000000">6.1.1 WClientWin functions</A>
189 <LI><A NAME="tex2html183"
190   HREF="node7.html#SECTION00712000000000000000">6.1.2 WFrame functions</A>
191 <LI><A NAME="tex2html184"
192   HREF="node7.html#SECTION00713000000000000000">6.1.3 WGroup functions</A>
193 <LI><A NAME="tex2html185"
194   HREF="node7.html#SECTION00714000000000000000">6.1.4 WGroupCW functions</A>
195 <LI><A NAME="tex2html186"
196   HREF="node7.html#SECTION00715000000000000000">6.1.5 WGroupWS functions</A>
197 <LI><A NAME="tex2html187"
198   HREF="node7.html#SECTION00716000000000000000">6.1.6 WInfoWin functions</A>
199 <LI><A NAME="tex2html188"
200   HREF="node7.html#SECTION00717000000000000000">6.1.7 WMPlex functions</A>
201 <LI><A NAME="tex2html189"
202   HREF="node7.html#SECTION00718000000000000000">6.1.8 WMoveresMode functions</A>
203 <LI><A NAME="tex2html190"
204   HREF="node7.html#SECTION00719000000000000000">6.1.9 WRegion functions</A>
205 <LI><A NAME="tex2html191"
206   HREF="node7.html#SECTION007110000000000000000">6.1.10 WRootWin functions</A>
207 <LI><A NAME="tex2html192"
208   HREF="node7.html#SECTION007111000000000000000">6.1.11 WScreen functions</A>
209 <LI><A NAME="tex2html193"
210   HREF="node7.html#SECTION007112000000000000000">6.1.12 WWindow functions</A>
211 <LI><A NAME="tex2html194"
212   HREF="node7.html#SECTION007113000000000000000">6.1.13 global functions</A>
213 <LI><A NAME="tex2html195"
214   HREF="node7.html#SECTION007114000000000000000">6.1.14 gr functions</A>
215 <LI><A NAME="tex2html196"
216   HREF="node7.html#SECTION007115000000000000000">6.1.15 string functions</A>
217 <LI><A NAME="tex2html197"
218   HREF="node7.html#SECTION007116000000000000000">6.1.16 table functions</A>
219 </UL>
220 <LI><A NAME="tex2html198"
221   HREF="node7.html#SECTION00720000000000000000">6.2 Functions defined in mod_tiling</A>
222 <UL>
223 <LI><A NAME="tex2html199"
224   HREF="node7.html#SECTION00721000000000000000">6.2.1 WSplit functions</A>
225 <LI><A NAME="tex2html200"
226   HREF="node7.html#SECTION00722000000000000000">6.2.2 WSplitInner functions</A>
227 <LI><A NAME="tex2html201"
228   HREF="node7.html#SECTION00723000000000000000">6.2.3 WSplitRegion functions</A>
229 <LI><A NAME="tex2html202"
230   HREF="node7.html#SECTION00724000000000000000">6.2.4 WSplitSplit functions</A>
231 <LI><A NAME="tex2html203"
232   HREF="node7.html#SECTION00725000000000000000">6.2.5 WTiling functions</A>
233 </UL>
234 <LI><A NAME="tex2html204"
235   HREF="node7.html#SECTION00730000000000000000">6.3 Functions defined in mod_query</A>
236 <UL>
237 <LI><A NAME="tex2html205"
238   HREF="node7.html#SECTION00731000000000000000">6.3.1 WComplProxy functions</A>
239 <LI><A NAME="tex2html206"
240   HREF="node7.html#SECTION00732000000000000000">6.3.2 WEdln functions</A>
241 <LI><A NAME="tex2html207"
242   HREF="node7.html#SECTION00733000000000000000">6.3.3 WInput functions</A>
243 </UL>
244 <LI><A NAME="tex2html208"
245   HREF="node7.html#SECTION00740000000000000000">6.4 Functions defined in mod_menu</A>
246 <UL>
247 <LI><A NAME="tex2html209"
248   HREF="node7.html#SECTION00741000000000000000">6.4.1 WMenu functions</A>
249 </UL>
250 <LI><A NAME="tex2html210"
251   HREF="node7.html#SECTION00750000000000000000">6.5 Functions defined in mod_dock</A>
252 <UL>
253 <LI><A NAME="tex2html211"
254   HREF="node7.html#SECTION00751000000000000000">6.5.1 WDock functions</A>
255 </UL>
256 <LI><A NAME="tex2html212"
257   HREF="node7.html#SECTION00760000000000000000">6.6 Functions defined in mod_sp</A>
258 <LI><A NAME="tex2html213"
259   HREF="node7.html#SECTION00770000000000000000">6.7 Functions defined in mod_statusbar</A>
260 <UL>
261 <LI><A NAME="tex2html214"
262   HREF="node7.html#SECTION00771000000000000000">6.7.1 WStatusBar functions</A>
263 </UL>
264 <LI><A NAME="tex2html215"
265   HREF="node7.html#SECTION00780000000000000000">6.8 Functions defined in de</A>
266 <LI><A NAME="tex2html216"
267   HREF="node7.html#SECTION00790000000000000000">6.9 Hooks</A>
268 </UL>
269 <BR>
270 <LI><A NAME="tex2html217"
271   HREF="node8.html">A. The GNU General Public License</A>
272 <LI><A NAME="tex2html218"
273   HREF="node9.html">B. Full class hierarchy visible to Lua-side</A>
274 <LI><A NAME="tex2html219"
275   HREF="node11.html">Index</A>
276 </UL>
277 <!--End of Table of Contents-->
278 <P>
279
280 <P>
281 <BR><HR>
282
283 </BODY>
284 </HTML>