1Gtk2::Ex::FormFactory::UPsoeprupC(o3n)tributed Perl DocuGmtekn2t:a:tEixo:n:FormFactory::Popup(3)
2
3
4

NAME

6       Gtk2::Ex::FormFactory::Popup - A Popup in a FormFactory framework
7

SYNOPSIS

9         Gtk2::Ex::FormFactory::Popup->new (
10           ...
11           Gtk2::Ex::FormFactory::Widget attributes
12         );
13

DESCRIPTION

15       This class implements a Popup in a Gtk2::Ex::FormFactory framework.
16       The selected entry of the Popup is controlled by the value of the
17       associated application object attribute, which is either an index in an
18       array of possible Popup entries or a key of a hash of possible Popup
19       entries.
20
21       Refer to the chapter REQUIREMENTS FOR ASSOCIATED APPLICATION OBJECTS
22       for details.
23

OBJECT HIERARCHY

25         Gtk2::Ex::FormFactory::Intro
26
27         Gtk2::Ex::FormFactory::Widget
28         +--- Gtk2::Ex::FormFactory::Popup
29
30         Gtk2::Ex::FormFactory::Layout
31         Gtk2::Ex::FormFactory::Rules
32         Gtk2::Ex::FormFactory::Context
33         Gtk2::Ex::FormFactory::Proxy
34

ATTRIBUTES

36       Attributes are handled through the common get_ATTR(), set_ATTR() style
37       accessors, but they are mostly passed once to the object constructor
38       and must not be altered after the associated FormFactory was built.
39
40       items = ARRAYREF|HASHREF [optional]
41           This attribute takes a static list of popup items, if the popup
42           shouldn't be controlled dynamically by an associated application
43           object. Refer to the next chapter for details of the data structure
44           applied here.
45

REQUIREMENTS FOR ASSOCIATED APPLICATION OBJECTS

47       Application objects represented by a Gtk2::Ex::FormFactory::Popup must
48       define additional methods, unless their content is static by setting
49       items.
50
51       The naming of the methods listed beyond uses the standard get_ prefix
52       for the attribute read accessor. ATTR needs to be replaced by the
53       actual name of the attribute associated with the widget.
54
55       get_ATTR_list
56           This returns the entries of the Popup. Three data models are
57           supported here:
58
59           Simple ARRAY
60                  If the method returns a reference to a simple array, the
61                  popup will be filled with the array values in the original
62                  array order.
63
64                  The index of the actually selected popup entry is stored in
65                  the attribute of the associated application object.
66
67           Two dimensional ARRAY
68                  The method may return a reference to a two dimensional
69                  array. Each row needs to have the attribute value in the
70                  first column and the label for the corresponding item in the
71                  second.
72
73           HASH   If the method returns a reference to a hash, the popup will
74                  be filled with the alphanumerically sorted hash values.
75
76                  In turn the hash key of the actually selected popup entry is
77                  stored in the attribute of the associated application
78                  object.
79

AUTHORS

81        Jörn Reder <joern at zyn dot de>
82

84       Copyright 2004-2006 by Jörn Reder.
85
86       This library is free software; you can redistribute it and/or modify it
87       under the terms of the GNU Library General Public License as published
88       by the Free Software Foundation; either version 2.1 of the License, or
89       (at your option) any later version.
90
91       This library is distributed in the hope that it will be useful, but
92       WITHOUT ANY WARRANTY; without even the implied warranty of
93       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
94       Library General Public License for more details.
95
96       You should have received a copy of the GNU Library General Public
97       License along with this library; if not, write to the Free Software
98       Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307
99       USA.
100

POD ERRORS

102       Hey! The above document had some coding errors, which are explained
103       below:
104
105       Around line 245:
106           Non-ASCII character seen before =encoding in 'Jörn'. Assuming UTF-8
107
108
109
110perl v5.28.1                      2006-07-02   Gtk2::Ex::FormFactory::Popup(3)
Impressum