1Gtk2::ComboBox(3) User Contributed Perl Documentation Gtk2::ComboBox(3)
2
6 Gtk2::ComboBox - A widget used to choose from a list of items
7
9 # the easy way:
10 $combobox = Gtk2::ComboBox->new_text;
11 foreach (@strings) {
12 $combobox->append_text ($_);
13 }
14 $combobox->prepend_text ($another_string);
15 $combobox->insert_text ($index, $yet_another_string);
16 $combobox->remove_text ($index);
17 $text = $combobox->get_active_text;
18 # the full-featured way.
20 # a combo box that shows stock ids and their images:
21 use constant ID_COLUMN => 0;
22 $model = Gtk2::ListStore->new ('Glib::String');
23 foreach (qw(gtk-ok gtk-cancel gtk-yes gtk-no gtk-save gtk-open)) {
24 $model->set ($model->append, ID_COLUMN, $_);
25 }
26 $combo_box = Gtk2::ComboBox->new ($model);
27 # to display anything, you must pack cell renderers into
28 # the combobox, which implements the Gtk2::CellLayout interface.
29 $renderer = Gtk2::CellRendererPixbuf->new;
30 $combo_box->pack_start ($renderer, FALSE);
31 $combo_box->add_attribute ($renderer, stock_id => ID_COLUMN);
32 $renderer = Gtk2::CellRendererText->new;
33 $combo_box->pack_start ($renderer, TRUE);
34 $combo_box->add_attribute ($renderer, text => ID_COLUMN);
35 # select by index
37 $combo_box->set_active ($index);
38 $active_index = $combo_box->get_active;
39 # or by iter
41 $combo_box->set_active_iter ($iter);
42 $active_iter = $combo_box->get_active_iter;
43
45 Gtk2::ComboBox is a widget that allows the user to choose from a list
46 of valid choices. The ComboBox displays the selected choice. When
47 activated, the ComboBox displays a popup which allows the user to make
48 a new choice.
49 Unlike its predecessors Gtk2::Combo and Gtk2::OptionMenu, the
51 Gtk2::ComboBox uses the model-view pattern; the list of valid choices
52 is specified in the form of a tree model, and the display of the
53 choices can be adapted to the data in the model by using cell render‐
54 ers, as you would in a tree view. This is possible since ComboBox
55 implements the Gtk2::CellLayout interface. The tree model holding the
56 valid choices is not restricted to a flat list; it can be a real tree,
57 and the popup will reflect the tree structure.
58 In addition to the model-view API, ComboBox offers a simple API which
60 is suitable for text-only combo boxes, and hides the complexity of man‐
61 aging the data in a model. It consists of the methods "new_text",
62 "append_text", "insert_text", "prepend_text", "remove_text" and
63 "get_active_text".
64
66 Glib::Object
67 +----Glib::InitiallyUnowned
68 +----Gtk2::Object
69 +----Gtk2::Widget
70 +----Gtk2::Container
71 +----Gtk2::Bin
72 +----Gtk2::ComboBox
73
75 Glib::Object::_Unregistered::AtkImplementorIface
76 Gtk2::CellEditable
77 Gtk2::CellLayout
78
80 widget = Gtk2::ComboBox->new ($model=undef)
81 * $model (Gtk2::TreeModel)
83 widget = Gtk2::ComboBox->new_text
85 widget = Gtk2::ComboBox->new_with_model ($model=undef)
87 * $model (Gtk2::TreeModel)
89 integer = $combo_box->get_active
91 treeiter = $combo_box->get_active_iter
93 $combo_box->set_active_iter ($iter)
95 * $iter (Gtk2::TreeIter)
97 $combo_box->set_active ($index)
99 * $index (integer)
101 string = $combo_box->get_active_text
103 boolean = $combo_box->get_add_tearoffs
105 $combo_box->set_add_tearoffs ($add_tearoffs)
107 * $add_tearoffs (boolean)
109 $combo_box->append_text ($text)
111 * $text (string)
113 integer = $combo_box->get_column_span_column
115 $combo_box->set_column_span_column ($column_span)
117 * $column_span (integer)
119 boolean = $combo_box->get_focus_on_click
121 $combo_box->set_focus_on_click ($focus_on_click)
123 * $focus_on_click (boolean)
125 $combo_box->insert_text ($position, $text)
127 * $position (integer)
129 * $text (string)
130 treemodel = $combo_box->get_model
132 $combo_box->set_model ($model)
134 * $model (Gtk2::TreeModel)
136 $combo_box->popdown
138 $combo_box->popup
140 $combo_box->prepend_text ($text)
142 * $text (string)
144 $combo_box->remove_text ($position)
146 * $position (integer)
148 $combo_box->set_row_separator_func ($func, $data=undef)
150 * $func (scalar)
152 * $data (scalar)
153 integer = $combo_box->get_row_span_column
155 $combo_box->set_row_span_column ($row_span)
157 * $row_span (integer)
159 string = $combo_box->get_title
161 $combo_box->set_title ($title)
163 * $title (string)
165 integer = $combo_box->get_wrap_width
167 $combo_box->set_wrap_width ($width)
169 * $width (integer)
171
173 'active' (integer : readable / writable / private)
174 The item which is currently active
175 'add-tearoffs' (boolean : readable / writable / private)
177 Whether dropdowns should have a tearoff menu item
178 'column-span-column' (integer : readable / writable / private)
180 TreeModel column containing the column span values
181 'focus-on-click' (boolean : readable / writable / private)
183 Whether the combo box grabs focus when it is clicked with the mouse
184 'has-frame' (boolean : readable / writable / private)
186 Whether the combo box draws a frame around the child
187 'model' (Gtk2::TreeModel : readable / writable / private)
189 The model for the combo box
190 'popup-shown' (boolean : readable / private)
192 Whether the combo's dropdown is shown
193 'row-span-column' (integer : readable / writable / private)
195 TreeModel column containing the row span values
196 'tearoff-title' (string : readable / writable / private)
198 A title that may be displayed by the window manager when the popup
199 is torn-off
200 'wrap-width' (integer : readable / writable / private)
202 Wrap width for laying out the items in a grid
203
205 changed (Gtk2::ComboBox)
206
208 Gtk2, Glib::Object, Glib::InitiallyUnowned, Gtk2::Object, Gtk2::Widget,
209 Gtk2::Container, Gtk2::Bin
210
212 Copyright (C) 2003-2007 by the gtk2-perl team.
213 This software is licensed under the LGPL. See Gtk2 for a full notice.
215perl v5.8.8 2007-03-18 Gtk2::ComboBox(3)