1Gtk2::Ex::FormFactory::ULsiesrt(C3o)ntributed Perl DocumGetnkt2a:t:iEoxn::FormFactory::List(3)
2
3
4

NAME

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

SYNOPSIS

9         Gtk2::Ex::FormFactory::List->new (
10           attr_select        => Attribute name for selection tracking,
11           attr_select_column => Use this column's value to store in attr_select
12           columns            => Titles of the list columns,
13           types              => Types of the list columns,
14           editable           => Which columns are editable?,
15           visible            => Which columns are visible?
16           selection_mode     => Selection mode of this list,
17           no_header          => Omit header?
18           update_selection_only => Boolean, whether updates should only
19                                    change the selection, not the list
20                                    of values,
21           ...
22           Gtk2::Ex::FormFactory::Widget attributes
23         );
24

DESCRIPTION

26       This class implements a List in a Gtk2::Ex::FormFactory framework
27       (based on Gtk2::Ex::Simple::List). The value of the associated
28       application object attribute needs to be a reference to a two
29       dimensional array with the content of the list.
30

OBJECT HIERARCHY

32         Gtk2::Ex::FormFactory::Intro
33
34         Gtk2::Ex::FormFactory::Widget
35         +--- Gtk2::Ex::FormFactory::List
36
37         Gtk2::Ex::FormFactory::Layout
38         Gtk2::Ex::FormFactory::Rules
39         Gtk2::Ex::FormFactory::Context
40         Gtk2::Ex::FormFactory::Proxy
41

ATTRIBUTES

43       Attributes are handled through the common get_ATTR(), set_ATTR() style
44       accessors, but they are mostly passed once to the object constructor
45       and must not be altered after the associated FormFactory was built.
46
47       attr_select = SCALAR [optional]
48           If you want to track the selection state of the List set the name
49           of the attribute of the associated application object here. An
50           array reference with the indicies of the selected rows (or specific
51           column values if attr_select_column is set) will be managed
52           automatically and stored in this attribute.
53
54       attr_select_column
55           Normally indicies of the selected rows are stored in the attribute
56           passed with attr_select. Specify a column number here and the
57           corresponding values will be stored instead (e.g. an internal
58           database ID of an invisible column). If you use this you may use
59           the select_row_by_attr() method as well, which is described below.
60
61       columns = ARRAYREF [mandatory]
62           This is a reference to an array containing the column titles of
63           this list.
64
65       types = ARRAYREF [optional]
66           You may define types for the columns of the list. The type of a
67           column defaults to 'text'. Other possible types are:
68
69             text    normal text strings
70             markup  pango markup strings
71             int     integer values
72             double  double-precision floating point values
73             bool    boolean values, displayed as toggle-able checkboxes
74             scalar  a perl scalar, displayed as a text string by default
75             pixbuf  a Gtk2::Gdk::Pixbuf
76
77       editable = ARRAYREF [optional]
78           This an array reference of boolean values, one value for each
79           column. Changes to columns marked editable are synchronized
80           automatically with the associated application object attribute.
81
82       visible = ARRAYREF [optional]
83           This an array reference of boolean values, one value for each
84           column and controls the visibility of the corresponding columns.
85           Default is to display all columns.
86
87       selection_mode = 'none'|'single'|'browse'|'multiple' [optional]
88           You may specify a selection mode for the list. Please refer to the
89           Gtk+ documentation of GtkSelectionMode for details about the
90           possible selection modes.
91
92       update_selection_only = BOOL [optional]
93           If you know the values of your list don't change at runtime, and
94           only the actual selection is important, you should set this to a
95           true value, because updating will be significantly faster, since
96           only the actual selection is affected.
97
98       For more attributes refer to Gtk2::Ex::FormFactory::Widget.
99

METHODS

101       $rows = $widget->get_selected_rows ()
102           Returns a list reference of selected row indicies.
103
104       $data_lref = $widget->get_data ()
105           Returns the data array of the underlying Gtk2::SimpleList. It's a
106           two dimensional array of rows and columns. All manipulations affect
107           the GUI immediately but bypasses all Gtk2::Ex::FormFactory
108           automatic object value update magic, so be careful with this.
109
110       $widget->select_row_by_attr ($value)
111           Selects a row by a given select_attr attribute value. Works only if
112           select_attr is set for this list.
113

AUTHORS

115        Jörn Reder <joern at zyn dot de>
116
118       Copyright 2004-2006 by Jörn Reder.
119
120       This library is free software; you can redistribute it and/or modify it
121       under the terms of the GNU Library General Public License as published
122       by the Free Software Foundation; either version 2.1 of the License, or
123       (at your option) any later version.
124
125       This library is distributed in the hope that it will be useful, but
126       WITHOUT ANY WARRANTY; without even the implied warranty of
127       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
128       Library General Public License for more details.
129
130       You should have received a copy of the GNU Library General Public
131       License along with this library; if not, write to the Free Software
132       Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307
133       USA.
134

POD ERRORS

136       Hey! The above document had some coding errors, which are explained
137       below:
138
139       Around line 402:
140           Non-ASCII character seen before =encoding in 'Jörn'. Assuming UTF-8
141
142
143
144perl v5.32.1                      2021-01-27    Gtk2::Ex::FormFactory::List(3)
Impressum