File: gtk-combo.ads

package info (click to toggle)
libgtkada2 2.8.1-6lenny3
  • links: PTS, VCS
  • area: main
  • in suites: lenny
  • size: 13,496 kB
  • ctags: 3,886
  • sloc: ada: 103,189; ansic: 45,411; perl: 5,500; sh: 2,812; makefile: 1,169; xml: 19
file content (236 lines) | stat: -rw-r--r-- 10,118 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
-----------------------------------------------------------------------
--               GtkAda - Ada95 binding for Gtk+/Gnome               --
--                                                                   --
--   Copyright (C) 1998-2000 E. Briot, J. Brobecker and A. Charlet   --
--                Copyright (C) 2000-2006 AdaCore                    --
--                                                                   --
-- This library is free software; you can redistribute it and/or     --
-- modify it under the terms of the GNU General Public               --
-- License as published by the Free Software Foundation; either      --
-- version 2 of the License, or (at your option) any later version.  --
--                                                                   --
-- This library is distributed in the hope that it will be useful,   --
-- but WITHOUT ANY WARRANTY; without even the implied warranty of    --
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU --
-- General Public License for more details.                          --
--                                                                   --
-- You should have received a copy of the GNU General Public         --
-- License along with this library; if not, write to the             --
-- Free Software Foundation, Inc., 59 Temple Place - Suite 330,      --
-- Boston, MA 02111-1307, USA.                                       --
--                                                                   --
-----------------------------------------------------------------------

--  <description>
--  The Gtk_Combo widget consists of a single-line text entry field and a
--  drop-down list. The drop-down list is displayed when the user clicks on a
--  small arrow button to the right of the entry field.
--
--  The drop-down list is a Gtk_List widget and can be accessed using the list
--  member of the Gtk_Combo. List elements can contain arbitrary widgets, but
--  if an element is not a plain label, then you must use the
--  Gtk_List.Set_Item_String function. This sets the string which will be
--  placed in the text entry field when the item is selected.
--
--  By default, the user can step through the items in the list using the arrow
--  (cursor) keys, though this behaviour can be turned off with Set_Use_Arrows.
--
--  Normally the arrow keys are only active when the contents of the text entry
--  field matches one of the items in the list. If the contents of the entry
--  field do not match any of the list items, then pressing the arrow keys does
--  nothing. However, by calling Set_Use_Arrows_Always you can specify that the
--  arrow keys are always active. If the contents of the entry field does not
--  match any of the items in the list, then pressing the up or down arrow key
--  will set the entry field to the last or first item in the list,
--  respectively.
--  </description>
--  <c_version>2.8.17</c_version>
--  <group>Obsolescent widgets</group>
--  <screenshot>gtk-combo</screenshot>
--  <see>Gtk.Combo_Box</see>

with Glib.Properties;
with Gtk.GEntry;
pragma Warnings (Off);  --  Gtk.List is obsolescent
with Gtk.List;
pragma Warnings (On);
with Gtk.Box;
with Gtk.Item;
with Gtk.Window;
with Gtk.Enums; use Gtk.Enums;

package Gtk.Combo is
   pragma Obsolescent;

   type Gtk_Combo_Record is new Gtk.Box.Gtk_Box_Record with private;
   type Gtk_Combo is access all Gtk_Combo_Record'Class;

   procedure Gtk_New (Combo_Box : out Gtk_Combo);
   --  Create a new Gtk_Combo.

   procedure Initialize (Combo_Box : access Gtk_Combo_Record'Class);
   --  Internal initialization function.
   --  See the section "Creating your own widgets" in the documentation.

   function Get_Type return Gtk.Gtk_Type;
   --  Return the internal value associated with a Gtk_Combo.

   procedure Set_Value_In_List
     (Combo_Box   : access Gtk_Combo_Record;
      Val         : Boolean := True;
      Ok_If_Empty : Boolean := False);
   --  Specify whether the value entered in the text entry field must match one
   --  of the values in the list. If this is set then the user will not be able
   --  to perform any other action until a valid value has been entered.
   --  If an empty field is acceptable, the Ok_If_Empty parameter should be
   --  True.
   --  If the value entered must match one of the values in the list, val
   --  should be True.

   procedure Set_Use_Arrows
     (Combo_Box : access Gtk_Combo_Record; Val : Boolean := True);
   --  Specify if the arrow (cursor) keys can be used to step through the
   --  items in the list. This is on by default.

   procedure Set_Use_Arrows_Always
     (Combo_Box : access Gtk_Combo_Record; Val : Boolean := True);
   --  Specify if the arrow keys will still work even if the current contents
   --  of the Gtk_Entry field do not match any of the list items.

   procedure Set_Case_Sensitive
     (Combo_Box : access Gtk_Combo_Record; Val : Boolean := True);
   --  Specify whether the text entered into the Gtk_Entry field and the text
   --  in the list items are case sensitive.
   --  This may be useful, for example, when you have called Set_Value_In_List
   --  to limit the values entered, but you are not worried about differences
   --  in case.

   procedure Set_Item_String
     (Combo_Box  : access Gtk_Combo_Record;
      Item       : Gtk.Item.Gtk_Item;
      Item_Value : UTF8_String);
   --  Set the string to place in the Gtk_Entry field when a particular list
   --  item is selected. This is needed if the list item is not a simple label.

   procedure Set_Popdown_Strings
     (Combo_Box : access Gtk_Combo_Record;
      Strings   : String_List.Glist);
   --  Set all the items in the popup list.

   procedure Disable_Activate (Combo_Box : access Gtk_Combo_Record);
   --  Disable the standard handler for the <return> key in the entry field.
   --  The default behavior is to popdown the combo box list, so that the user
   --  can choose from it. However, if you want to add your own callback
   --  for the return key, you need to call this subprogram, and connect
   --  a handler to the "activate" signal for the entry.

   procedure Set_Entry
     (Combo_Box : access Gtk_Combo_Record;
      GEntry    : Gtk.GEntry.Gtk_Entry);
   function Get_Entry
     (Combo_Box : access Gtk_Combo_Record) return Gtk.GEntry.Gtk_Entry;
   --  Set the entry field for the combo box.

   pragma Warnings (Off); --  Gtk_List is obsolescent
   function Get_List
     (Combo_Box : access Gtk_Combo_Record) return Gtk.List.Gtk_List;
   --  Return the list of items associated with a Combo_Box.
   --  Add (Gtk.Container.Add) Gtk_List_Items to this list to insert new
   --  entries in the popdown menu.
   pragma Warnings (On);

   function Get_Popup_Window
     (Combo_Box : access Gtk_Combo_Record) return Gtk.Window.Gtk_Window;
   --  Return the popup window associated with a Combo_Box.

   ----------------
   -- Properties --
   ----------------

   --  <properties>
   --  The following properties are defined for this widget. See
   --  Glib.Properties for more information on properties.
   --
   --  Name:  Enable_Arrow_Keys_Property
   --  Type:  Boolean
   --  Flags: read-write
   --  Descr: Whether the arrow keys move through the list of items
   --  See also:  Set_Use_Arrows
   --
   --  Name:  Enable_Arrow_Always_Property
   --  Type:  Boolean
   --  Flags: read-write
   --  Descr: Whether the arrow keys work, even if the entry contents are
   --         not in the list
   --  See also:  Set_Use_Arrows_Always
   --
   --  Name:  Case_Sensitive_Property
   --  Type:  Boolean
   --  Flags: read-write
   --  Descr: Whether list item matching is case sensitive
   --  See also:  Set_Case_Sensitive
   --
   --  Name:  Allow_Empty_Property
   --  Type:  Boolean
   --  Descr: Whether an empty value may be entered in this field
   --
   --  Name:  Enable_Arrows_Always_Property
   --  Type:  Boolean
   --  Descr: Obsolete property, ignored
   --
   --  Name:  Value_In_List_Property
   --  Type:  Boolean
   --  Descr: Whether entered values must already be present in the list
   --
   --  </properties>

   Enable_Arrow_Keys_Property    : constant Glib.Properties.Property_Boolean;
   Enable_Arrow_Always_Property  : constant Glib.Properties.Property_Boolean;
   Case_Sensitive_Property       : constant Glib.Properties.Property_Boolean;
   Allow_Empty_Property          : constant Glib.Properties.Property_Boolean;
   Enable_Arrows_Always_Property : constant Glib.Properties.Property_Boolean;
   Value_In_List_Property        : constant Glib.Properties.Property_Boolean;

   -------------
   -- Signals --
   -------------

   --  <signals>
   --  The following new signals are defined for this widget:
   --  </signals>

private
   type Gtk_Combo_Record is new Gtk.Box.Gtk_Box_Record with null record;

   Enable_Arrow_Keys_Property   : constant Glib.Properties.Property_Boolean :=
     Glib.Properties.Build ("enable_arrow_keys");
   Enable_Arrow_Always_Property : constant Glib.Properties.Property_Boolean :=
     Glib.Properties.Build ("enable_arrow_always");
   Case_Sensitive_Property      : constant Glib.Properties.Property_Boolean :=
     Glib.Properties.Build ("case_sensitive");
   Allow_Empty_Property : constant Glib.Properties.Property_Boolean :=
     Glib.Properties.Build ("allow-empty");
   Enable_Arrows_Always_Property : constant Glib.Properties.Property_Boolean :=
     Glib.Properties.Build ("enable-arrows-always");
   Value_In_List_Property : constant Glib.Properties.Property_Boolean :=
     Glib.Properties.Build ("value-in-list");

   pragma Import (C, Get_Type, "gtk_combo_get_type");
end Gtk.Combo;

--  <example>
--  Creating a Gtk_Combo widget with simple text items.
--
--    Combo : Gtk_Combo;
--    Items : String_List.Glist;
--
--    String_List.Append (Items, "First Item");
--    String_List.Append (Items, "Second Item");
--    String_List.Append (Items, "Third Item");
--    String_List.Append (Items, "Fourth Item");
--    String_List.Append (Items, "Fifth Item");
--
--    Gtk_New (Combo);
--    Set_Popdown_Strings (Combo, Items);
--    Free (Items);
--  </example>