Combo Box

GTK+ 2.0 Tutorial
<<< Previous | Miscellaneous Widgets | Next >>>

# Combo Box

The combo box is another fairly simple widget that is really just a collection of other widgets. From the user's point of view, the widget consists of a text entry box and a pull down menu from which the user can select one of a set of predefined entries. Alternatively, the user can type a different option directly into the text box.

The following extract from the structure that defines a Combo Box identifies several of the components:

    struct _GtkCombo {
            GtkHBox hbox;
            GtkWidget *entry;
            GtkWidget *button;
            GtkWidget *popup;
            GtkWidget *popwin;
            GtkWidget *list;
    	...  };

As you can see, the Combo Box has two principal parts that you really care about: an entry and a list.

First off, to create a combo box, use:

    GtkWidget *gtk_combo_new( void );

Now, if you want to set the string in the entry section of the combo box, this is done by manipulating the `entry` widget directly:

        gtk_entry_set_text (GTK_ENTRY (GTK_COMBO (combo)->entry), "My String.");

To set the values in the popdown list, one uses the function:

    void gtk_combo_set_popdown_strings( GtkCombo *combo,
                                        GList    *strings );

Before you can do this, you have to assemble a GList of the strings that you want. GList is a linked list implementation that is part of GLib, a library supporting GTK. For the moment, the quick and dirty explanation is that you need to set up a GList pointer, set it equal to NULL, then append strings to it with

    GList *g_list_append( GList *glist,
                          gpointer data );

It is important that you set the initial GList pointer to NULL. The value returned from the g_list_append() function must be used as the new pointer to the GList.

Here's a typical code segment for creating a set of options:

        GList *glist = NULL;

        glist = g_list_append (glist, "String 1");
        glist = g_list_append (glist, "String 2");
        glist = g_list_append (glist, "String 3");
        glist = g_list_append (glist, "String 4");

        gtk_combo_set_popdown_strings (GTK_COMBO (combo), glist);

        /* can free glist now, combo takes a copy */

The combo widget makes a copy of the strings passed to it in the glist structure. As a result, you need to make sure you free the memory used by the list if that is appropriate for your application.

At this point you have a working combo box that has been set up. There are a few aspects of its behavior that you can change. These are accomplished with the functions:

    void gtk_combo_set_use_arrows( GtkCombo *combo,
                                   gboolean  val );

    void gtk_combo_set_use_arrows_always( GtkCombo *combo,
                                          gboolean  val );

    void gtk_combo_set_case_sensitive( GtkCombo *combo,
                                       gboolean  val );

gtk_combo_set_use_arrows() lets the user change the value in the entry using the up/down arrow keys. This doesn't bring up the list, but rather replaces the current text in the entry with the next list entry (up or down, as your key choice indicates). It does this by searching in the list for the item corresponding to the current value in the entry and selecting the previous/next item accordingly. Usually in an entry the arrow keys are used to change focus (you can do that anyway using TAB). Note that when the current item is the last of the list and you press arrow-down it changes the focus (the same applies with the first item and arrow-up).

If the current value in the entry is not in the list, then the function of gtk_combo_set_use_arrows() is disabled.

gtk_combo_set_use_arrows_always() similarly allows the use the the up/down arrow keys to cycle through the choices in the dropdown list, except that it wraps around the values in the list, completely disabling the use of the up and down arrow keys for changing focus.

gtk_combo_set_case_sensitive() toggles whether or not GTK searches for entries in a case sensitive manner. This is used when the Combo widget is asked to find a value from the list using the current entry in the text box. This completion can be performed in either a case sensitive or insensitive manner, depending upon the use of this function. The Combo widget can also simply complete the current entry if the user presses the key combination MOD-1 and "Tab". MOD-1 is often mapped to the "Alt" key, by the `xmodmap` utility. Note, however that some window managers also use this key combination, which will override its use within GTK.

Now that we have a combo box, tailored to look and act how we want it, all that remains is being able to get data from the combo box. This is relatively straightforward. The majority of the time, all you are going to care about getting data from is the entry. The entry is accessed simply by `GTK_ENTRY (GTK_COMBO (combo)->entry)`. The two principal things that you are going to want to do with it are connect to the activate signal, which indicates that the user has pressed the Return or Enter key, and read the text. The first is accomplished using something like:

        g_signal_connect (GTK_COMBO (combo)->entry, "activate",
                          G_CALLBACK (my_callback_function), my_data);

Getting the text at any arbitrary time is accomplished by simply using the entry function:

    gchar *gtk_entry_get_text( GtkEntry *entry );

Such as:

        gchar *string;

        string = gtk_entry_get_text (GTK_ENTRY (GTK_COMBO (combo)->entry));

That's about all there is to it. There is a function

    void gtk_combo_disable_activate( GtkCombo *combo );

that will disable the activate signal on the entry widget in the combo box. Personally, I can't think of why you'd want to use it, but it does exist.

<<< Previous | Home | Next >>>
Spin Buttons | Up | Calendar