ComboBox

Object Hierarchy:

Description:

combobox
├── box.linked
│   ╰── button.combo
│       ╰── box
│           ├── cellview
│           ╰── arrow
╰── window.popup

combobox
├── box.linked
│   ├── entry.combo
│   ╰── button.combo
│       ╰── box
│           ╰── arrow
╰── window.popup

public class Application : Gtk.Window {
	public Application () {
		// Prepare Gtk.Window:
		this.title = "My Gtk.ComboBox";
		this.window_position = Gtk.WindowPosition.CENTER;
		this.destroy.connect (Gtk.main_quit);

		// Create & fill a ListStore:
		Gtk.ListStore list_store = new Gtk.ListStore (2, typeof (string), typeof (int));
		Gtk.TreeIter iter;

		list_store.append (out iter);
		list_store.set (iter, 0, "Burgenland", 1, 13);
		list_store.append (out iter);
		list_store.set (iter, 0, "Carinthia", 1, 17);

		// The Box:
		Gtk.ComboBox box = new Gtk.ComboBox.with_model (list_store);
		this.add (box);

		Gtk.CellRendererText renderer = new Gtk.CellRendererText ();
		box.pack_start (renderer, true);
		box.add_attribute (renderer, "text", 0);
		box.active = 0;

		renderer = new Gtk.CellRendererText ();
		box.pack_start (renderer, true);
		box.add_attribute (renderer, "text", 1);
		box.active = 0;

		box.changed.connect (() => {
			Value val1;
			Value val2;

			box.get_active_iter (out iter);
			list_store.get_value (iter, 0, out val1);
			list_store.get_value (iter, 1, out val2);

			print ("Selection: %s, %d\n", (string) val1, (int) val2);
		});
	}

	public static int main (string[] args) {
		Gtk.init (ref args);

		Application app = new Application ();
		app.show_all ();
		Gtk.main ();
		return 0;
	}
}

valac --pkg gtk+-3.0 Gtk.ComboBox.vala

Content:

Properties:

• public int active { get; set; }
  The item which is currently active.
• public string? active_id { get; set; }
  The value of the ID column of the active row.
• public bool add_tearoffs { get; set; }
  The add-tearoffs property controls whether generated menus have tearoff menu items.
• public SensitivityType button_sensitivity { get; set; }
  Whether the dropdown button is sensitive when the model is empty.
• public CellArea cell_area { owned get; construct; }
  The CellArea used to layout cell renderers for this combo box.
• public int column_span_column { get; set; }
  If this is set to a non-negative value, it must be the index of a column of type g_type_int in the model.
• public int entry_text_column { get; set; }
  The column in the combo box's model to associate with strings from the entry if the combo was created with has_entry = true.
• public bool has_entry { get; construct; }
  Whether the combo box has an entry.
• public bool has_frame { get; set; }
  The has-frame property controls whether a frame is drawn around the entry.
• public int id_column { get; set; }
  The column in the combo box's model that provides string IDs for the values in the model, if != -1.
• public TreeModel model { get; set; }
  The model from which the combo box takes the values shown in the list.
• public bool popup_fixed_width { get; set; }
  Whether the popup's width should be a fixed width matching the allocated width of the combo box.
• public bool popup_shown { get; }
  Whether the combo boxes dropdown is popped up.
• public int row_span_column { get; set; }
  If this is set to a non-negative value, it must be the index of a column of type g_type_int in the model.
• public string tearoff_title { owned get; set; }
  A title that may be displayed by the window manager when the popup is torn-off.
• public int wrap_width { get; set; }
  If wrap-width is set to a positive value, items in the popup will be laid out along multiple columns, starting a new row on reaching the wrap width.

Creation methods:

• public ComboBox ()
  Creates a new empty ComboBox.
• public ComboBox.with_area (CellArea area)
  Creates a new empty ComboBox using area to layout cells.
• public ComboBox.with_area_and_entry (CellArea area)
  Creates a new empty ComboBox with an entry.
• public ComboBox.with_entry ()
  Creates a new empty ComboBox with an entry.
• public ComboBox.with_model (TreeModel model)
  Creates a new ComboBox with the model initialized to model.
• public ComboBox.with_model_and_entry (TreeModel model)
  Creates a new empty ComboBox with an entry and with the model initialized to model.

Methods:

• public int get_active ()
  Returns the index of the currently active item, or -1 if there’s no active item.
• public unowned string? get_active_id ()
  Returns the ID of the active row of this.
• public bool get_active_iter (out TreeIter iter)
  Sets iter to point to the currently active item, if any item is active.
• public bool get_add_tearoffs ()
  Gets the current value of the add_tearoffs property.
• public SensitivityType get_button_sensitivity ()
  Returns whether the combo box sets the dropdown button sensitive or not when there are no items in the model.
• public int get_column_span_column ()
  Returns the column with column span information for this.
• public int get_entry_text_column ()
  Returns the column which this is using to get the strings from to display in the internal entry.
• public bool get_focus_on_click ()
  Returns whether the combo box grabs focus when it is clicked with the mouse.
• public bool get_has_entry ()
  Returns whether the combo box has an entry.
• public int get_id_column ()
  Returns the column which this is using to get string IDs for values from.
• public unowned TreeModel get_model ()
  Returns the TreeModel which is acting as data source for this.
• public unowned Object get_popup_accessible ()
  Gets the accessible object corresponding to the combo box’s popup.
• public bool get_popup_fixed_width ()
  Gets whether the popup uses a fixed width matching the allocated width of the combo box.
• public unowned TreeViewRowSeparatorFunc get_row_separator_func ()
  Returns the current row separator function.
• public int get_row_span_column ()
  Returns the column with row span information for this.
• public unowned string get_title ()
  Gets the current title of the menu in tearoff mode.
• public int get_wrap_width ()
  Returns the wrap width which is used to determine the number of columns for the popup menu.
• public void popup_for_device (Device device)
  Pops up the menu or dropdown list of this, the popup window will be grabbed so only device and its associated pointer/keyboard are the only Devices able to send events to it.
• public void set_active (int index_)
  Sets the active item of this to be the item at index.
• public bool set_active_id (string? active_id)
  Changes the active row of this to the one that has an ID equal to active_id, or unsets the active row if active_id is null .
• public void set_active_iter (TreeIter? iter)
  Sets the current active item to be the one referenced by iter, or unsets the active item if iter is null.
• public void set_add_tearoffs (bool add_tearoffs)
  Sets whether the popup menu should have a tearoff menu item.
• public void set_button_sensitivity (SensitivityType sensitivity)
  Sets whether the dropdown button of the combo box should be always sensitive (gtk_sensitivity_on), never sensitive (gtk_sensitivity_off) or only if there is at least one item to display (gtk_sensitivity_auto).
• public void set_column_span_column (int column_span)
  Sets the column with column span information for this to be column_span.
• public void set_entry_text_column (int text_column)
  Sets the model column which this should use to get strings from to be text_column.
• public void set_focus_on_click (bool focus_on_click)
  Sets whether the combo box will grab focus when it is clicked with the mouse.
• public void set_id_column (int id_column)
  Sets the model column which this should use to get string IDs for values from.
• public void set_model (TreeModel? model)
  Sets the model used by this to be model.
• public void set_popup_fixed_width (bool fixed)
  Specifies whether the popup’s width should be a fixed width matching the allocated width of the combo box.
• public void set_row_separator_func (owned TreeViewRowSeparatorFunc func)
  Sets the row separator function, which is used to determine whether a row should be drawn as a separator.
• public void set_row_span_column (int row_span)
  Sets the column with row span information for this to be row_span.
• public void set_title (string title)
  Sets the menu’s title in tearoff mode.
• public void set_wrap_width (int width)
  Sets the wrap width of this to be width.

Signals:

• public virtual signal void changed ()
  The changed signal is emitted when the active item is changed.
• public virtual signal string format_entry_text (string path)
  For combo boxes that are created with an entry (See GtkComboBox:has-entry).
• public signal void move_active (ScrollType scroll_type)
  The move_active signal is a keybinding signal which gets emitted to move the active selection.
• public signal bool popdown ()
  The popdown signal is a keybinding signal which gets emitted to popdown the combo box list.
• public signal void popup ()
  The popup signal is a keybinding signal which gets emitted to popup the combo box list.

Inherited Members: