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