1QWizard_Widgets(3) User Contributed Perl Documentation QWizard_Widgets(3)
2
6 QWizard_Widgets - Describes the Widgets available to QWizard Generators
7
9 This document describes the various QWizard backend widgets that can be
10 produced and what tags they support, and what the values of those tags
11 are expected to produce (either by direct value such as
12 tag => "string"
14 or as a result of a code execution like
16 tag => sub { return "string" }
18 or even:
20 tag => [sub { return $_[$#_] }, "string"]
22 Tag Value Expectations
24 The documentation to follow will reference a number of different value
25 types for various tags. These possible values are described below:
26 single
28 A single value is expected for this tag. If a subroutine returns
29 multiple values only the first will be used.
30 multi
32 The tag expects or can accept multiple values. These values should
33 be specified in the form of an array reference.
34 norecuse
36 This is a special form of "multi"... I need to go look at the code
37 again to remember exactly what it does.
38 values,labels
40 This is a special tag to indicate the widget needs both values and
41 labels associated with the multiple sub-widgets it can display
42 (radio boxes, menu items, check boxes, ...). The values tag (an
43 array ref) will indicate which values are used within the program.
44 The labels clause will map those values to human strings. The
45 labels clause can be either a hash mapping values to labels, or an
46 array where the even elements of the array (0, 2, 4, ...) will be
47 the values and the odd elements (1, 3, 5, ...) will be the labels
48 to associate with them. An array reference for labels allows the
49 order of label presentation to be specified, where as a hash will
50 display the labels/sub-widgets in a somewhat random order.
51 If the labels clause is left out, the values themselves will be
53 present to the user.
54 If the values clause is left out, the values will be pulled from
56 the labels.
57 It is likely a rare case that you need to specify both. This
59 special tag name specifically indicates you can specify both.
60 forced
62 This is a value which is forced for a particular tag for internal
63 use and can't be manipulated by the programmer. It's documented
64 here anyway for completeness.
65 Notes about this document.
67 1) This file is automatically generated from the Generator's own
68 expect ions of their supported widgets and the requirements. Thus,
69 not all widgets in all generators are perfectly equal. Some
70 generators have better support for extra options for certain
71 widgets, for example.
72 2) This document does not specify some of the other tags that every
74 question is allowed to have, such as "name", "text", "helpddesc",
75 "check_value", ... It only discusses the tags that the back end
76 generators make use of.
77
79 +--------------+----+----+--+--------+
80 | |HTML|Gtk2|Tk|ReadLine|
81 +--------------+----+----+--+--------+
82 |bar |X |X | | |
83 |button |X |X |X | |
84 |checkbox |X |X |X |X |
85 |filedownload |X |X |X | |
86 |fileupload |X |X |X |X |
87 |graph |X |X |X | |
88 |hidetext |X |X |X | |
89 |image |X |X |X | |
90 |label |X |X |X |X |
91 |link |X | | | |
92 |menu |X |X |X |X |
93 |multi_checkbox|X |X |X |X |
94 |paragraph |X |X |X |X |
95 |radio |X |X |X |X |
96 |table |X |X |X | |
97 |text |X |X |X |X |
98 |textbox |X |X |X |X |
99 |unknown |X |X |X |X |
100 +--------------+----+----+--+--------+
101
103 QWizard::Generator::HTML
104 These are the question types known to the QWizard::Generator::HTML
105 generator class:
106 bar
108 values => norecurse
109 button
110 values => single
111 checkbox
112 values => multi
113 default => single
114 submit => single
115 refresh_on_change => single
116 button_label => single
117 filedownload
118 name => single
119 default => single
120 data => single
121 datafn => noexpand
122 extension => single
123 linktext => single
124 fileupload
125 values => default
126 graph
127 values => norecurse
128 graph_options => norecursemulti
129 hidetext
130 name => single
131 default => single
132 size => single
133 maxsize => single
134 submit => single
135 refresh_on_change => single
136 image
137 imgdata => norecurse
138 image => norecurse
139 imagealt => single
140 height => single
141 width => single
142 label
143 values => multi
144 link
145 linktext => single
146 url => single
147 menu
148 => values,labels
149 default => single
150 submit => single
151 refresh_on_change => single
152 name => single
153 multi_checkbox
154 default => multi
155 values,labels => single
156 submit => single
157 refresh_on_change => single
158 paragraph
159 values => multi
160 preformatted => single
161 radio
162 values,labels => single
163 default => single
164 submit => single
165 refresh_on_change => single
166 name => single
167 icons => single
168 noiconpadding => single
169 table
170 values => norecurse
171 headers => norecurse
172 text
173 name => single
174 default => single
175 size => single
176 maxsize => single
177 submit => single
178 refresh_on_change => single
179 textbox
180 default => single
181 width => single
182 size => single
183 height => single
184 submit => single
185 refresh_on_change => single
186 unknown
187 QWizard::Generator::Gtk2
189 These are the question types known to the QWizard::Generator::Gtk2
190 generator class:
191 bar
193 values => norecurse
194 button
195 values => single
196 default => single
197 icon => single
198 padding => single
199 runcode => noexpand
200 checkbox
201 values => multi
202 default => single
203 name => single
204 submit => single
205 refresh_on_change => single
206 button_label => single
207 filedownload
208 name => single
209 default => single
210 data => single
211 datafn => noexpand
212 fileupload
213 name => single
214 default => single
215 graph
216 values => norecurse
217 graph_options => norecursemulti
218 hidetext
219 name => single
220 default => single
221 size => single
222 maxsize => single
223 submit => single
224 refresh_on_change => single
225 image
226 imgdata => norecurse
227 image => norecurse
228 imagealt => single
229 addscalebuttons => single
230 label
231 values => multi
232 menu
233 values,labels => single
234 default => single
235 name => single
236 submit => single
237 refresh_on_change => single
238 multi_checkbox
239 default => multi
240 values,labels => single
241 refresh_on_change => single
242 paragraph
243 values => multi
244 preformatted => single
245 width => single
246 radio
247 => values,labels
248 default => single
249 name => single
250 submit => single
251 refresh_on_change => single
252 icons => single
253 noiconpadding => single
254 table
255 values => norecurse
256 headers => norecurse
257 text
258 name => single
259 default => single
260 size => single
261 maxsize => single
262 submit => single
263 refresh_on_change => single
264 textbox
265 name => single
266 default => single
267 size => single
268 maxsize => single
269 submit => single
270 refresh_on_change => single
271 unknown
272 QWizard::Generator::Tk
274 These are the question types known to the QWizard::Generator::Tk
275 generator class:
276 button
278 values => single
279 default => single
280 checkbox
281 values => multi
282 default => single
283 button_label => single
284 filedownload
285 values => default
286 fileupload
287 values => default
288 graph
289 values => norecurse
290 graph_options => norecursemulti
291 hidetext
292 name => single
293 default => single
294 size => single
295 maxsize => single
296 submit => single
297 refresh_on_change => single
298 image
299 imgdata => norecurse
300 image => norecurse
301 imagealt => single
302 label
303 values => multi
304 menu
305 values,labels => single
306 default => single
307 name => single
308 multi_checkbox
309 default => multi
310 values,labels => single
311 paragraph
312 values => multi
313 preformatted => single
314 width => single
315 radio
316 => values,labels
317 default => single
318 name => single
319 table
320 values => norecurse
321 headers => norecurse
322 text
323 name => single
324 default => single
325 size => single
326 maxsize => single
327 submit => single
328 refresh_on_change => single
329 textbox
330 name => single
331 default => single
332 size => single
333 width => single
334 height => single
335 unknown
336 QWizard::Generator::ReadLine
338 These are the question types known to the QWizard::Generator::ReadLine
339 generator class:
340 checkbox
342 values => multi
343 default => single
344 name => single
345 fileupload
346 values => default
347 label
348 values => multi
349 menu
350 => values,labels
351 default => single
352 name => single
353 multi_checkbox
354 default => multi
355 values,labels => single
356 paragraph
357 values => multi
358 radio
359 => values,labels
360 default => single
361 name => single
362 text
363 name => single
364 default => single
365 textbox
366 name => single
367 default => single
368 size => single
369 maxsize => single
370 submit => single
371 unknown
372
374 Wes Hardaker, hardaker@users.sourceforge.net
375
377 QWizard, perl(1)
378 Net-Policy: http://net-policy.sourceforge.net/
380
382 Hey! The above document had some coding errors, which are explained
383 below:
384 Around line 75:
386 You forgot a '=back' before '=head2'
387 Around line 94:
389 You forgot a '=back' before '=head1'
390perl v5.12.0 2008-09-17 QWizard_Widgets(3)