1QWizard_Widgets(3)    User Contributed Perl Documentation   QWizard_Widgets(3)
2
3
4

NAME

6       QWizard_Widgets - Describes the Widgets available to QWizard Generators
7

OVERVIEW

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
13         tag => "string"
14
15       or as a result of a code execution like
16
17         tag => sub { return "string" }
18
19       or even:
20
21         tag => [sub { return $_[$#_] }, "string"]
22
23   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
27       single
28           A single value is expected for this tag.  If a subroutine returns
29           multiple values only the first will be used.
30
31       multi
32           The tag expects or can accept multiple values.  These values should
33           be specified in the form of an array reference.
34
35       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
39       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
52           If the labels clause is left out, the values themselves will be
53           present to the user.
54
55           If the values clause is left out, the values will be pulled from
56           the labels.
57
58           It is likely a rare case that you need to specify both.  This
59           special tag name specifically indicates you can specify both.
60
61       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
66   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
73       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

WIDGET SUPPORT SUMMARY MATRIX

79       ';
80
81       }
82
83       sub print_trailer {
84           print '
85

AUTHOR

87       Wes Hardaker, hardaker@users.sourceforge.net
88

SEE ALSO

90       QWizard, perl(1)
91
92       Net-Policy: http://net-policy.sourceforge.net/
93

POD ERRORS

95       Hey! The above document had some coding errors, which are explained
96       below:
97
98       Around line 155:
99           You forgot a '=back' before '=head2'
100
101       Around line 174:
102           You forgot a '=back' before '=head1'
103
104
105
106perl v5.28.0                      2007-06-22                QWizard_Widgets(3)
Impressum