gtkmm: Gtk::ComboBox Class Reference

A widget used to choose from a list of items. More...

#include <gtkmm/combobox.h>

Inheritance diagram for Gtk::ComboBox:

Public Types

typedef TreeView::SlotRowSeparator SlotRowSeparator
 
- Public Types inherited from Gtk::Container
typedef sigc::slot< void, Widget& > ForeachSlot
 For instance, void on_foreach(Gtk::Widget* widget);. More...

 
- Public Types inherited from Glib::Object
typedef void(*)(gpointer data DestroyNotify)
 
- Public Types inherited from sigc::trackable
typedef internal::func_destroy_notify func_destroy_notify
 
- Public Types inherited from Gtk::CellLayout
typedef sigc::slot< void, const TreeModel::const_iterator& > SlotCellData
 

Public Member Functions

 ComboBox (ComboBox&& src) noexcept
 
ComboBoxoperator= (ComboBox&& src) noexcept
 
 ComboBox (const ComboBox&)=delete
 
ComboBoxoperator= (const ComboBox&)=delete
 
 ~ComboBox () noexceptoverride
 
GtkComboBox* gobj ()
 Provides access to the underlying C GtkObject. More...

 
const GtkComboBox* gobj () const
 Provides access to the underlying C GtkObject. More...

 
 ComboBox (bool has_entry=false)
 Creates a new empty ComboBox, optionally with an entry. More...

 
 ComboBox (const Glib::RefPtr< TreeModel >& model, bool has_entry=false)
 Creates a new ComboBox with the model initialized to model, optionally with an entry. More...

 
 ComboBox (const Glib::RefPtr< CellArea >& cell_area, bool has_entry=false)
 Creates a new empty ComboBox using cell_area to layout cells, optionally with an entry. More...

 
void set_wrap_width (int width)
 Sets the wrap width of combo_box to be width. More...

 
int get_wrap_width () const
 Returns the wrap width which is used to determine the number of columns for the popup menu. More...

 
void set_row_span_column (int row_span)
 Sets the column with row span information for combo_box to be row_span. More...

 
int get_row_span_column () const
 Returns the column with row span information for combo_box. More...

 
void set_column_span_column (int column_span)
 Sets the column with column span information for combo_box to be column_span. More...

 
int get_column_span_column () const
 Returns the column with column span information for combo_box. More...

 
bool get_add_tearoffs () const
 Gets the current value of the :add-tearoffs property. More...

 
void set_add_tearoffs (bool add_tearoffs=true)
 Sets whether the popup menu should have a tearoff menu item. More...

 
Glib::ustring get_title () const
 Gets the current title of the menu in tearoff mode. More...

 
void set_title (const Glib::ustring& title)
 Sets the menu’s title in tearoff mode. More...

 
bool get_focus_on_click () const
 Returns whether the combo box grabs focus when it is clicked with the mouse. More...

 
void set_focus_on_click (bool focus_on_click=true)
 Sets whether the combo box will grab focus when it is clicked with the mouse. More...

 
int get_active_row_number () const
 Returns the index of the currently active item, or -1 if there’s no active item. More...

 
TreeModel::iterator get_active ()
 Gets an iterator that points to the current active item, if it exists. More...

 
TreeModel::const_iterator get_active () const
 Gets an iterator that points to the current active item, if it exists. More...

 
void set_active (int index)
 Sets the active item of combo_box to be the item at index. More...

 
void set_active (const TreeModel::iterator& iter)
 Sets the current active item to be the one referenced by iter, or unsets the active item if iter is nullptr. More...

 
Glib::ustring get_entry_text () const
 Get the text in the entry, if there is an entry. More...

 
void unset_active ()
 Causes no item to be active. More...

 
Glib::RefPtr< TreeModelget_model ()
 Returns the Gtk::TreeModel which is acting as data source for combo_box. More...

 
Glib::RefPtr< const TreeModelget_model () const
 Returns the Gtk::TreeModel which is acting as data source for combo_box. More...

 
void set_model (const Glib::RefPtr< TreeModel >& model)
 Sets the model used by combo_box to be model. More...

 
void unset_model ()
 Remove the model from the ComboBox. More...

 
void set_row_separator_func (const SlotRowSeparator& slot)
 Sets the row separator function, which is used to determine whether a row should be drawn as a separator. More...

 
void unset_row_separator_func ()
 Causes no separators to be drawn. More...

 
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). More...

 
SensitivityType get_button_sensitivity () const
 Returns whether the combo box sets the dropdown button sensitive or not when there are no items in the model. More...

 
bool get_has_entry () const
 Returns whether the combo box has an entry. More...

 
void set_entry_text_column (const TreeModelColumnBase& text_column) const
 Sets the model column which combo_box should use to get strings from to be text_column. More...

 
void set_entry_text_column (int text_column)
 Sets the model column which combo_box should use to get strings from to be text_column. More...

 
int get_entry_text_column () const
 Returns the column which combo_box is using to get the strings from to display in the internal entry. More...

 
void set_popup_fixed_width (bool fixed=true)
 Specifies whether the popup’s width should be a fixed width matching the allocated width of the combo box. More...

 
bool get_popup_fixed_width () const
 Gets whether the popup uses a fixed width matching the allocated width of the combo box. More...

 
void popup ()
 Pops up the menu or dropdown list of combo_box. More...

 
void popup (const Glib::RefPtr< Gdk::Device >& device)
 Pops up the menu or dropdown list of combo_box, the popup window will be grabbed so only device and its associated pointer/keyboard are the only Gdk::Devices able to send events to it. More...

 
void popdown ()
 Hides the menu or dropdown list of combo_box. More...

 
Glib::RefPtr< Atk::Objectget_popup_accessible ()
 Gets the accessible object corresponding to the combo box’s popup. More...

 
Glib::RefPtr< const Atk::Objectget_popup_accessible () const
 Gets the accessible object corresponding to the combo box’s popup. More...

 
int get_id_column () const
 Returns the column which combo_box is using to get string IDs for values from. More...

 
void set_id_column (int id_column)
 Sets the model column which combo_box should use to get string IDs for values from. More...

 
Glib::ustring get_active_id () const
 Returns the ID of the active row of combo_box. More...

 
void get_active_id (const Glib::ustring& active_id)
 Changes the active row of combo_box to the one that has an ID equal to active_id, or unsets the active row if active_id is nullptr. More...

 
bool set_active_id (const Glib::ustring& active_id)
 Changes the active row of the combo box to the one that has an ID equal to active_id. More...

 
Entryget_entry ()
 
const Entryget_entry () const
 
Glib::PropertyProxy< Glib::RefPtr< TreeModel > > property_model ()
 The model from which the combo box takes the values shown in the list. More...

 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< TreeModel > > property_model () const
 The model from which the combo box takes the values shown in the list. More...

 
Glib::PropertyProxy< int > property_wrap_width ()
 If wrap-width is set to a positive value, the list will be displayed in multiple columns, the number of columns is determined by wrap-width. More...

 
Glib::PropertyProxy_ReadOnly< int > property_wrap_width () const
 If wrap-width is set to a positive value, the list will be displayed in multiple columns, the number of columns is determined by wrap-width. More...

 
Glib::PropertyProxy< int > property_row_span_column ()
 If this is set to a non-negative value, it must be the index of a column of type TYPE_INT in the model. More...

 
Glib::PropertyProxy_ReadOnly< int > property_row_span_column () const
 If this is set to a non-negative value, it must be the index of a column of type TYPE_INT in the model. More...

 
Glib::PropertyProxy< int > property_column_span_column ()
 If this is set to a non-negative value, it must be the index of a column of type TYPE_INT in the model. More...

 
Glib::PropertyProxy_ReadOnly< int > property_column_span_column () const
 If this is set to a non-negative value, it must be the index of a column of type TYPE_INT in the model. More...

 
Glib::PropertyProxy< int > property_active ()
 The item which is currently active. More...

 
Glib::PropertyProxy_ReadOnly< int > property_active () const
 The item which is currently active. More...

 
Glib::PropertyProxy< bool > property_add_tearoffs ()
 The add-tearoffs property controls whether generated menus have tearoff menu items. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_add_tearoffs () const
 The add-tearoffs property controls whether generated menus have tearoff menu items. More...

 
Glib::PropertyProxy< bool > property_has_frame ()
 The has-frame property controls whether a frame is drawn around the entry. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_has_frame () const
 The has-frame property controls whether a frame is drawn around the entry. More...

 
Glib::PropertyProxy< bool > property_focus_on_click ()
 Whether the combo box grabs focus when it is clicked with the mouse. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_focus_on_click () const
 Whether the combo box grabs focus when it is clicked with the mouse. More...

 
Glib::PropertyProxy< Glib::ustringproperty_tearoff_title ()
 A title that may be displayed by the window manager when the popup is torn-off. More...

 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_tearoff_title () const
 A title that may be displayed by the window manager when the popup is torn-off. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_popup_shown () const
 Whether the combo boxes dropdown is popped up. More...

 
Glib::PropertyProxy< SensitivityTypeproperty_button_sensitivity ()
 Whether the dropdown button is sensitive when the model is empty. More...

 
Glib::PropertyProxy_ReadOnly< SensitivityTypeproperty_button_sensitivity () const
 Whether the dropdown button is sensitive when the model is empty. More...

 
Glib::PropertyProxy< bool > property_popup_fixed_width ()
 Whether the popup's width should be a fixed width matching the allocated width of the combo box. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_popup_fixed_width () const
 Whether the popup's width should be a fixed width matching the allocated width of the combo box. More...

 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< CellArea > > property_cell_area () const
 The Gtk::CellArea used to layout cell renderers for this combo box. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_has_entry () const
 Whether the combo box has an entry. More...

 
Glib::PropertyProxy< int > property_entry_text_column ()
 The column in the combo box's model to associate with strings from the entry if the combo was created with Gtk::ComboBox::property_has_entry() = true. More...

 
Glib::PropertyProxy_ReadOnly< int > property_entry_text_column () const
 The column in the combo box's model to associate with strings from the entry if the combo was created with Gtk::ComboBox::property_has_entry() = true. More...

 
Glib::PropertyProxy< int > property_id_column ()
 The column in the combo box's model that provides string IDs for the values in the model, if != -1. More...

 
Glib::PropertyProxy_ReadOnly< int > property_id_column () const
 The column in the combo box's model that provides string IDs for the values in the model, if != -1. More...

 
Glib::PropertyProxy< Glib::ustringproperty_active_id ()
 The value of the ID column of the active row. More...

 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_active_id () const
 The value of the ID column of the active row. More...

 
Glib::SignalProxy< void > signal_changed ()
 
Glib::SignalProxy< Glib::ustring, const TreeModel::Path& > signal_format_entry_text ()
 
- Public Member Functions inherited from Gtk::Bin
 Bin (Bin&& src) noexcept
 
Binoperator= (Bin&& src) noexcept
 
 Bin (const Bin&)=delete
 
Binoperator= (const Bin&)=delete
 
 ~Bin () noexceptoverride
 
GtkBin* gobj ()
 Provides access to the underlying C GtkObject. More...

 
const GtkBin* gobj () const
 Provides access to the underlying C GtkObject. More...

 
Gtk::Widgetget_child ()
 Gets the child of the Gtk::Bin, or nullptr if the bin contains no child widget. More...

 
const Gtk::Widgetget_child () const
 Gets the child of the Gtk::Bin, or nullptr if the bin contains no child widget. More...

 
void remove ()
 Remove the contained widget. More...

 
void add_label (const Glib::ustring& label, bool mnemonic=false, double x_align=0.5, double y_align=0.5)
 Add a Label object. More...

 
void add_label (const Glib::ustring& label, bool mnemonic, Align x_align, Align y_align=ALIGN_CENTER)
 Add a Label object. More...

 
void add_pixlabel (const std::string& pixfile, const Glib::ustring& label, double x_align=0.5, double y_align=0.5)
 Add Image and Label objects. More...

 
void add_pixlabel (const std::string& pixfile, const Glib::ustring& label, Align x_align, Align y_align=ALIGN_CENTER)
 Add Image and Label objects. More...

 
- Public Member Functions inherited from Gtk::Container
 Container (Container&& src) noexcept
 
Containeroperator= (Container&& src) noexcept
 
 Container (const Container&)=delete
 
Containeroperator= (const Container&)=delete
 
 ~Container () noexceptoverride
 
GtkContainer* gobj ()
 Provides access to the underlying C GtkObject. More...

 
const GtkContainer* gobj () const
 Provides access to the underlying C GtkObject. More...

 
void set_border_width (guint border_width)
 Sets the border width of the container. More...

 
guint get_border_width () const
 Retrieves the border width of the container. More...

 
virtual void add (Widget& widget)
 Adds widget to container. More...

 
void remove (Widget& widget)
 Removes widget from the container. More...

 
void set_resize_mode (ResizeMode resize_mode)
 Sets the resize mode for the container. More...

 
ResizeMode get_resize_mode () const
 Returns the resize mode for the container. More...

 
void check_resize ()
 Request that contained widgets check their size. More...

 
void foreach (const ForeachSlot& slot)
 Operate on contained items. More...

 
void forall (const ForeachSlot& slot)
 Operate on contained items, including internal children. More...

 
std::vector< Widget* > get_children ()
 Returns the container’s non-internal children. More...

 
std::vector< const Widget* > get_children () const
 Returns the container’s non-internal children. More...

 
void propagate_draw (Widget& child, const ::Cairo::RefPtr< ::Cairo::Context >& cr)
 When a container receives a call to the draw function, it must send synthetic Gtk::Widget::signal_draw() calls to all children that don’t have their own Gdk::Windows. More...

 
void set_focus_chain (const std::vector< Widget* >& focusable_widgets)
 Sets a focus chain, overriding the one computed automatically by GTK+. More...

 
bool has_focus_chain () const
 
std::vector< Widget* > get_focus_chain ()
 
std::vector< const Widget* > get_focus_chain () const
 
void unset_focus_chain ()
 Removes a focus chain explicitly set with set_focus_chain(). More...

 
void set_reallocate_redraws (bool needs_redraws=true)
 Sets the reallocate_redraws flag of the container to the given value. More...

 
void set_focus_child (Widget& widget)
 Sets the focus on a child. More...

 
Widgetget_focus_child ()
 Returns the current focus child widget inside container. More...

 
const Widgetget_focus_child () const
 Returns the current focus child widget inside container. More...

 
void set_focus_vadjustment (const Glib::RefPtr< Adjustment >& adjustment)
 Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. More...

 
Glib::RefPtr< Adjustmentget_focus_vadjustment ()
 Retrieves the vertical focus adjustment for the container. More...

 
Glib::RefPtr< const Adjustmentget_focus_vadjustment () const
 Retrieves the vertical focus adjustment for the container. More...

 
void set_focus_hadjustment (const Glib::RefPtr< Adjustment >& adjustment)
 Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. More...

 
Glib::RefPtr< Adjustmentget_focus_hadjustment ()
 Retrieves the horizontal focus adjustment for the container. More...

 
Glib::RefPtr< const Adjustmentget_focus_hadjustment () const
 Retrieves the horizontal focus adjustment for the container. More...

 
void resize_children ()
 
GType child_type () const
 Returns the type of the children supported by the container. More...

 
WidgetPath get_path_for_child (const Widget& child) const
 Returns a newly created widget path representing all the widget hierarchy from the toplevel down to and including child. More...

 
Glib::SignalProxy< void, Widget* > signal_add ()
 
Glib::SignalProxy< void, Widget* > signal_remove ()
 
Glib::SignalProxy< void > signal_check_resize ()
 
Glib::SignalProxy< void, Widget* > signal_set_focus_child ()
 
void show_all_children (bool recursive=true)
 
- Public Member Functions inherited from Gtk::Widget
 Widget (Widget&& src) noexcept
 
Widgetoperator= (Widget&& src) noexcept
 
 Widget (const Widget&)=delete
 
Widgetoperator= (const Widget&)=delete
 
 ~Widget () noexceptoverride
 Destroys the widget. More...

 
GtkWidget* gobj ()
 Provides access to the underlying C GtkObject. More...

 
const GtkWidget* gobj () const
 Provides access to the underlying C GtkObject. More...

 
void show ()
 Flags a widget to be displayed. More...

 
void show_now ()
 Shows a widget. More...

 
void hide ()
 Reverses the effects of show(), causing the widget to be hidden (invisible to the user). More...

 
void show_all ()
 Recursively shows a widget, and any child widgets (if the widget is a container). More...

 
void queue_draw ()
 Equivalent to calling queue_draw_area() for the entire area of a widget. More...

 
void queue_draw_area (int x, int y, int width, int height)
 Convenience function that calls queue_draw_region() on the region created from the given coordinates. More...

 
void queue_draw_region (const ::Cairo::RefPtr< const ::Cairo::Region >& region)
 Invalidates the area of widget defined by region by calling gdk_window_invalidate_region() on the widget’s window and all its child windows. More...

 
void queue_resize ()
 This function is only for use in widget implementations. More...

 
void queue_allocate ()
 This function is only for use in widget implementations. More...

 
void size_allocate (const Allocation& allocation)
 This function is only used by Gtk::Container subclasses, to assign a size and position to their child widgets. More...

 
void size_allocate (const Allocation& allocation, int baseline)
 This function is only used by Gtk::Container subclasses, to assign a size, position and (optionally) baseline to their child widgets. More...

 
SizeRequestMode get_request_mode () const
 Gets whether the widget prefers a height-for-width layout or a width-for-height layout. More...

 
void get_preferred_width (int& minimum_width, int& natural_width) const
 Retrieves a widget’s initial minimum and natural width. More...

 
void get_preferred_height_for_width (int width, int& minimum_height, int& natural_height) const
 Retrieves a widget’s minimum and natural height if it would be given the specified width. More...

 
void get_preferred_height_for_width (int width, int& minimum_height, int& natural_height, int& minimum_baseline, int& natural_baseline) const
 Retrieves a widget’s minimum and natural height and the corresponding baselines if it would be given the specified width, or the default height if width is -1. More...

 
void get_preferred_height (int& minimum_height, int& natural_height) const
 Retrieves a widget’s initial minimum and natural height. More...

 
void get_preferred_width_for_height (int height, int& minimum_width, int& natural_width) const
 Retrieves a widget’s minimum and natural width if it would be given the specified height. More...

 
void get_preferred_size (Requisition& minimum_size, Requisition& natural_size) const
 Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management. More...

 
void add_accelerator (const Glib::ustring& accel_signal, const Glib::RefPtr< AccelGroup >& accel_group, guint accel_key, Gdk::ModifierType accel_mods, AccelFlags accel_flags)
 Installs an accelerator for this widget in accel_group that causes accel_signal to be emitted if the accelerator is activated. More...

 
bool remove_accelerator (const Glib::RefPtr< AccelGroup >& accel_group, guint accel_key, Gdk::ModifierType accel_mods)
 Removes an accelerator from widget, previously installed with add_accelerator(). More...

 
void set_accel_path (const Glib::ustring& accel_path, const Glib::RefPtr< AccelGroup >& accel_group)
 Given an accelerator group, accel_group, and an accelerator path, accel_path, sets up an accelerator in accel_group so whenever the key binding that is defined for accel_path is pressed, widget will be activated. More...

 
bool mnemonic_activate (bool group_cycling)
 Emits the Gtk::Widget::signal_mnemonic_activate() signal. More...

 
bool event (GdkEvent* gdk_event)
 Rarely-used function. More...

 
int send_expose (GdkEvent* gdk_event)
 Very rarely-used function. More...

 
bool send_focus_change (GdkEvent* gdk_event)
 Sends the focus change gdk_event to widget. More...

 
bool activate ()
 For widgets that can be “activated” (buttons, menu items, etc.) this function activates them. More...

 
void reparent (Widget& new_parent)
 Moves a widget from one Gtk::Container to another, handling reference count issues to avoid destroying the widget. More...

 
bool intersect (const Gdk::Rectangle& area) const
 
bool intersect (const Gdk::Rectangle& area, Gdk::Rectangle& intersection) const
 Computes the intersection of a widget’s area and area, storing the intersection in intersection, and returns true if there was an intersection. More...

 
::Cairo::RefPtr< ::Cairo::Regionregion_intersect (const ::Cairo::RefPtr< ::Cairo::Region >& region) const
 Computes the intersection of a widget’s area and region, returning the intersection. More...

 
void freeze_child_notify ()
 Stops emission of Gtk::Widget::signal_child_notify() signals on widget. More...

 
void child_notify (const Glib::ustring& child_property)
 Emits a Gtk::Widget::signal_child_notify() signal for the [child property][child-properties] child_property on widget. More...

 
void thaw_child_notify ()
 Reverts the effect of a previous call to freeze_child_notify(). More...

 
void set_can_focus (bool can_focus=true)
 Specifies whether widget can own the input focus. More...

 
bool get_can_focus () const
 Determines whether widget can own the input focus. More...

 
bool has_focus () const
 Determines if the widget has the global input focus. More...

 
bool is_focus () const
 Determines if the widget is the focus widget within its toplevel. More...

 
bool has_visible_focus () const
 Determines if the widget should show a visible indication that it has the global input focus. More...

 
void grab_focus ()
 Causes widget to have the keyboard focus for the Gtk::Window it's inside. More...

 
void set_focus_on_click (bool focus_on_click=true)
 Sets whether the widget should grab focus when it is clicked with the mouse. More...

 
bool get_focus_on_click () const
 Returns whether the widget should grab focus when it is clicked with the mouse. More...

 
void set_can_default (bool can_default=true)
 Specifies whether widget can be a default widget. More...

 
bool get_can_default () const
 Determines whether widget can be a default widget. More...

 
bool has_default () const
 Determines whether widget is the current default widget within its toplevel. More...

 
void grab_default ()
 Causes widget to become the default widget. More...

 
void set_receives_default (bool receives_default=true)
 Specifies whether widget will be treated as the default widget within its toplevel when it has the focus, even if another widget is the default. More...

 
bool get_receives_default () const
 Determines whether widget is always treated as the default widget within its toplevel when it has the focus, even if another widget is the default. More...

 
bool has_grab () const
 Determines whether the widget is currently grabbing events, so it is the only widget receiving input events (keyboard and mouse). More...

 
bool device_is_shadowed (const Glib::RefPtr< const Gdk::Device >& device)
 Returns true if device has been shadowed by a GTK+ device grab on another widget, so it would stop sending events to widget. More...

 
void add_modal_grab ()
 Block events to everything else than this widget and its children. More...

 
void remove_modal_grab ()
 Remove the modal grab of the widget in case it was previously grabbed. More...

 
void set_name (const Glib::ustring& name)
 Widgets can be named, which allows you to refer to them from a CSS file. More...

 
void unset_name ()
 
Glib::ustring get_name () const
 Retrieves the name of a widget. More...

 
void set_state (StateType state)
 This function is for use in widget implementations. More...

 
StateType get_state () const
 Returns the widget’s state. More...

 
void set_state_flags (StateFlags flags, bool clear=true)
 This function is for use in widget implementations. More...

 
void unset_state_flags (StateFlags flags)
 This function is for use in widget implementations. More...

 
StateFlags get_state_flags () const
 Returns the widget state as a flag set. More...

 
void set_sensitive (bool sensitive=true)
 Sets the sensitivity of a widget. More...

 
bool get_sensitive () const
 Returns the widget’s sensitivity (in the sense of returning the value that has been set using set_sensitive()). More...

 
bool is_sensitive () const
 Returns the widget’s effective sensitivity, which means it is sensitive itself and also its parent widget is sensitive. More...

 
void set_visible (bool visible=true)
 Sets the visibility state of widget. More...

 
bool get_visible () const
 Determines whether the widget is visible. More...

 
bool is_visible () const
 Determines whether the widget and all its parents are marked as visible. More...

 
bool get_has_window () const
 Determines whether widget has a Gdk::Window of its own. More...

 
bool get_is_toplevel () const
 Determines whether widget is a toplevel widget. More...

 
bool get_is_drawable () const
 Determines whether widget can be drawn to. More...

 
bool get_realized () const
 Determines whether widget is realized. More...

 
bool get_mapped () const
 Whether the widget is mapped. More...

 
void set_app_paintable (bool app_paintable=true)
 Sets whether the application intends to draw on the widget in an Gtk::Widget::signal_draw() handler. More...

 
bool get_app_paintable () const
 Determines whether the application intends to draw on the widget in an Gtk::Widget::signal_draw() handler. More...

 
void set_double_buffered (bool double_buffered=true)
 Widgets are double buffered by default; you can use this function to turn off the buffering. More...

 
bool get_double_buffered () const
 Determines whether the widget is double buffered. More...

 
void set_redraw_on_allocate (bool redraw_on_allocate=true)
 Sets whether the entire widget is queued for drawing when its size allocation changes. More...

 
void set_child_visible (bool visible=true)
 Sets whether widget should be mapped along with its when its parent is mapped and widget has been shown with show(). More...

 
bool get_child_visible () const
 Gets the value set with set_child_visible(). More...

 
Glib::RefPtr< Gdk::Windowget_window ()
 Returns the widget’s window if it is realized, nullptr otherwise. More...

 
Glib::RefPtr< const Gdk::Windowget_window () const
 Returns the widget’s window if it is realized, nullptr otherwise. More...

 
void register_window (const Glib::RefPtr< Gdk::Window >& window)
 Registers a Gdk::Window with the widget and sets it up so that the widget receives events for it. More...

 
void unregister_window (const Glib::RefPtr< Gdk::Window >& window)
 Unregisters a Gdk::Window from the widget that was previously set up with register_window(). More...

 
int get_allocated_width () const
 Returns the width that has currently been allocated to widget. More...

 
int get_allocated_height () const
 Returns the height that has currently been allocated to widget. More...

 
int get_allocated_baseline () const
 Returns the baseline that has currently been allocated to widget. More...

 
void get_allocated_size (Allocation& allocation, int& baseline) const
 Retrieves the widget’s allocated size. More...

 
Allocation get_allocation () const
 Retrieves the widget's location. More...

 
void set_allocation (const Allocation& allocation)
 Sets the widget’s allocation. More...

 
void set_clip (const Allocation& clip)
 Sets the widget’s clip. More...

 
Allocation get_clip () const
 Retrieves the widget’s clip area. More...

 
Containerget_parent ()
 Returns the parent container of widget. More...

 
const Containerget_parent () const
 Returns the parent container of widget. More...

 
Glib::RefPtr< Gdk::Windowget_parent_window ()
 Gets widget’s parent window. More...

 
Glib::RefPtr< const Gdk::Windowget_parent_window () const
 Gets widget’s parent window. More...

 
void set_parent_window (const Glib::RefPtr< const Gdk::Window >& parent_window)
 Sets a non default parent window for widget. More...

 
bool child_focus (DirectionType direction)
 This function is used by custom widget implementations; if you're writing an app, you’d use grab_focus() to move the focus to a particular widget, and Gtk::Container::set_focus_chain() to change the focus tab order. More...

 
bool keynav_failed (DirectionType direction)
 This function should be called whenever keyboard navigation within a single widget hits a boundary. More...

 
void error_bell ()
 Notifies the user about an input-related error on this widget. More...

 
void set_size_request (int width=-1, int height=-1)
 Sets the minimum size of a widget; that is, the widget’s size request will be at least width by height. More...

 
void get_size_request (int& width, int& height) const
 Gets the size request that was explicitly set for the widget using set_size_request(). More...

 
void set_events (Gdk::EventMask events)
 Sets the event mask (see Gdk::EventMask) for a widget. More...

 
void add_events (Gdk::EventMask events)
 Adds the events in the bitfield events to the event mask for widget. More...

 
void set_device_events (const Glib::RefPtr< const Gdk::Device >& device, Gdk::EventMask events)
 Sets the device event mask (see Gdk::EventMask) for a widget. More...

 
void add_device_events (const Glib::RefPtr< const Gdk::Device >& device, Gdk::EventMask events)
 Adds the device events in the bitfield events to the event mask for widget. More...

 
void set_opacity (double opacity)
 Request the widget to be rendered partially transparent, with opacity 0 being fully transparent and 1 fully opaque. More...

 
double get_opacity () const
 Fetches the requested opacity for this widget. More...

 
void set_device_enabled (const Glib::RefPtr< Gdk::Device >& device, bool enabled=true)
 Enables or disables a Gdk::Device to interact with widget and all its children. More...

 
bool get_device_enabled (const Glib::RefPtr< const Gdk::Device >& device) const
 Returns whether device can interact with widget and its children. More...

 
Containerget_toplevel ()
 This function returns the topmost widget in the container hierarchy widget is a part of. More...

 
const Containerget_toplevel () const
 This function returns the topmost widget in the container hierarchy widget is a part of. More...

 
Widgetget_ancestor (GType widget_type)
 Gets the first ancestor of widget with type widget_type. More...

 
const Widgetget_ancestor (GType widget_type) const
 Gets the first ancestor of widget with type widget_type. More...

 
Glib::RefPtr< Gdk::Visualget_visual ()
 Gets the visual that will be used to render widget. More...

 
Glib::RefPtr< Gdk::Screenget_screen ()
 Get the Gdk::Screen from the toplevel window associated with this widget. More...

 
Glib::RefPtr< const Gdk::Screenget_screen () const
 Get the Gdk::Screen from the toplevel window associated with this widget. More...

 
bool has_screen () const
 Checks whether there is a Gdk::Screen is associated with this widget. More...

 
int get_scale_factor () const
 Retrieves the internal scale factor that maps from window coordinates to the actual device pixels. More...

 
Glib::RefPtr< Gdk::Displayget_display ()
 Get the Gdk::Display for the toplevel window associated with this widget. More...

 
Glib::RefPtr< const Gdk::Displayget_display () const
 Get the Gdk::Display for the toplevel window associated with this widget. More...

 
Glib::RefPtr< Gdk::Windowget_root_window ()
 Get the root window where this widget is located. More...

 
Glib::RefPtr< const Gdk::Windowget_root_window () const
 Get the root window where this widget is located. More...

 
Glib::RefPtr< Settingsget_settings ()
 Gets the settings object holding the settings used for this widget. More...

 
Glib::RefPtr< Clipboardget_clipboard (const Glib::ustring& selection)
 Returns the clipboard object for the given selection to be used with widget. More...

 
Glib::RefPtr< const Clipboardget_clipboard (const Glib::ustring& selection) const
 Returns the clipboard object for the given selection to be used with widget. More...

 
bool get_hexpand () const
 Gets whether the widget would like any available extra horizontal space. More...

 
void set_hexpand (bool expand=true)
 Sets whether the widget would like any available extra horizontal space. More...

 
bool get_hexpand_set () const
 Gets whether set_hexpand() has been used to explicitly set the expand flag on this widget. More...

 
void set_hexpand_set (bool set=true)
 Sets whether the hexpand flag (see get_hexpand()) will be used. More...

 
bool get_vexpand () const
 Gets whether the widget would like any available extra vertical space. More...

 
void set_vexpand (bool expand=true)
 Sets whether the widget would like any available extra vertical space. More...

 
bool get_vexpand_set () const
 Gets whether set_vexpand() has been used to explicitly set the expand flag on this widget. More...

 
void set_vexpand_set (bool set=true)
 Sets whether the vexpand flag (see get_vexpand()) will be used. More...

 
void queue_compute_expand ()
 Mark widget as needing to recompute its expand flags. More...

 
bool compute_expand (Orientation orientation)
 Computes whether a container should give this widget extra space when possible. More...

 
bool get_support_multidevice () const
 Returns true if widget is multiple pointer aware. More...

 
void set_support_multidevice (bool support_multidevice=true)
 Enables or disables multiple pointer awareness. More...

 
Glib::RefPtr< Atk::Objectget_accessible ()
 Returns the accessible object that describes the widget to an assistive technology. More...

 
Glib::RefPtr< const Atk::Objectget_accessible () const
 Returns the accessible object that describes the widget to an assistive technology. More...

 
Align get_halign () const
 Gets the value of the Gtk::Widget::property_halign() property. More...

 
void set_halign (Align align)
 Sets the horizontal alignment of widget. More...

 
Align get_valign () const
 Gets the value of the Gtk::Widget::property_valign() property. More...

 
Align get_valign_with_baseline () const
 Gets the value of the Gtk::Widget::property_valign() property, including Gtk::ALIGN_BASELINE. More...

 
void set_valign (Align align)
 Sets the vertical alignment of widget. More...

 
int get_margin_left () const
 Gets the value of the Gtk::Widget::property_margin_left() property. More...

 
void set_margin_left (int margin)
 Sets the left margin of widget. More...

 
int get_margin_right () const
 Gets the value of the Gtk::Widget::property_margin_right() property. More...

 
void set_margin_right (int margin)
 Sets the right margin of widget. More...

 
int get_margin_start () const
 Gets the value of the Gtk::Widget::property_margin_start() property. More...

 
void set_margin_start (int margin)
 Sets the start margin of widget. More...

 
int get_margin_end () const
 Gets the value of the Gtk::Widget::property_margin_end() property. More...

 
void set_margin_end (int margin)
 Sets the end margin of widget. More...

 
int get_margin_top () const
 Gets the value of the Gtk::Widget::property_margin_top() property. More...

 
void set_margin_top (int margin)
 Sets the top margin of widget. More...

 
int get_margin_bottom () const
 Gets the value of the Gtk::Widget::property_margin_bottom() property. More...

 
void set_margin_bottom (int margin)
 Sets the bottom margin of widget. More...

 
Gdk::EventMask get_events () const
 Returns the event mask (see Gdk::EventMask) for the widget. More...

 
Gdk::EventMask get_device_events (const Glib::RefPtr< const Gdk::Device >& device) const
 Returns the events mask for the widget corresponding to an specific device. More...

 
void get_pointer (int& x, int& y) const
 Obtains the location of the mouse pointer in widget coordinates. More...

 
bool is_ancestor (Widget& ancestor) const
 Determines whether widget is somewhere inside ancestor, possibly with intermediate containers. More...

 
bool translate_coordinates (Widget& dest_widget, int src_x, int src_y, int& dest_x, int& dest_y)
 Translate coordinates relative to src_widget’s allocation to coordinates relative to dest_widget’s allocations. More...

 
void override_color (const Gdk::RGBA& color, StateFlags state=STATE_FLAG_NORMAL)
 Sets the color to use for a widget. More...

 
void unset_color (StateFlags state=STATE_FLAG_NORMAL)
 Undoes the effect of previous calls to override_color(). More...

 
void override_background_color (const Gdk::RGBA& color, StateFlags state=STATE_FLAG_NORMAL)
 Sets the background color to use for a widget. More...

 
void unset_background_color (StateFlags state=STATE_FLAG_NORMAL)
 Undoes the effect of previous calls to override_background_color(). More...

 
void override_font (const Pango::FontDescription& font_desc)
 Sets the font to use for a widget. More...

 
void unset_font ()
 Undoes the effect of previous calls to override_font(). More...

 
void override_symbolic_color (const Glib::ustring& name, const Gdk::RGBA& color)
 Sets a symbolic color for a widget. More...

 
void unset_symbolic_color (const Glib::ustring& name)
 Undoes the effect of previous calls to override_symbolic_color(). More...

 
void override_cursor (const Gdk::RGBA& cursor, const Gdk::RGBA& secondary_cursor)
 Sets the cursor color to use in a widget, overriding the cursor-color and secondary-cursor-color style properties. More...

 
void unset_cursor ()
 Undoes the effect of previous calls to override_cursor(). More...

 
void reset_style ()
 Updates the style context of widget and all descendants by updating its widget path. More...

 
template<class PropertyType >
void get_style_property (const Glib::ustring& the_property_name, PropertyType& value) const
 Gets the value of a style property of widget. More...

 
Glib::RefPtr< Pango::Contextcreate_pango_context ()
 Creates a new Pango::Context with the appropriate font map, font options, font description, and base direction for drawing text for this widget. More...

 
Glib::RefPtr< Pango::Contextget_pango_context ()
 Gets a Pango::Context with the appropriate font map, font description, and base direction for this widget. More...

 
void set_font_options (const ::Cairo::FontOptions& options)
 Sets the #cairo_font_options_t used for Pango rendering in this widget. More...

 
void unset_font_options ()
 Undoes the effect of previous calls to set_font_options(). More...

 
::Cairo::FontOptions get_font_options () const
 Returns the #cairo_font_options_t used for Pango rendering. More...

 
Glib::RefPtr< Pango::Layoutcreate_pango_layout (const Glib::ustring& text)
 Creates a new Pango::Layout with the appropriate font map, font description, and base direction for drawing text for this widget. More...

 
Glib::RefPtr< Gdk::Pixbufrender_icon_pixbuf (const StockID& stock_id, IconSize size)
 A convenience function that uses the theme engine and style settings for widget to look up stock_id and render it to a pixbuf. More...

 
void set_composite_name (const Glib::ustring& name)
 Sets a widgets composite name. More...

 
void unset_composite_name ()
 
Glib::ustring get_composite_name () const
 Obtains the composite name of a widget. More...

 
void set_direction (TextDirection dir)
 Sets the reading direction on a particular widget. More...

 
TextDirection get_direction () const
 Gets the reading direction for a particular widget. More...

 
void shape_combine_region (const ::Cairo::RefPtr< const ::Cairo::Region >& region)
 Sets a shape for this widget’s GDK window. More...

 
void input_shape_combine_region (const ::Cairo::RefPtr< const ::Cairo::Region >& region)
 Sets an input shape for this widget’s GDK window. More...

 
WidgetPath get_path () const
 Returns the Gtk::WidgetPath representing widget, if the widget is not connected to a toplevel widget, a partial path will be created. More...

 
std::vector< Widget* > list_mnemonic_labels ()
 Returns a newly allocated list of the widgets, normally labels, for which this widget is the target of a mnemonic (see for example, Gtk::Label::set_mnemonic_widget()). More...

 
std::vector< const Widget* > list_mnemonic_labels () const
 Returns a newly allocated list of the widgets, normally labels, for which this widget is the target of a mnemonic (see for example, Gtk::Label::set_mnemonic_widget()). More...

 
void add_mnemonic_label (Widget& label)
 Adds a widget to the list of mnemonic labels for this widget. More...

 
void remove_mnemonic_label (Widget& label)
 Removes a widget from the list of mnemonic labels for this widget. More...

 
void drag_get_data (const Glib::RefPtr< Gdk::DragContext >& context, const Glib::ustring& target, guint32 time)
 
void drag_highlight ()
 
void drag_unhighlight ()
 
void drag_dest_set (DestDefaults flags=DestDefaults(0), Gdk::DragAction actions=Gdk::DragAction(0))
 
void drag_dest_set (const std::vector< TargetEntry >& targets, DestDefaults flags=DEST_DEFAULT_ALL, Gdk::DragAction actions=Gdk::ACTION_COPY)
 
void drag_dest_set_proxy (const Glib::RefPtr< Gdk::Window >& proxy_window, Gdk::DragProtocol protocol, bool use_coordinates)
 
void drag_dest_unset ()
 
Glib::ustring drag_dest_find_target (const Glib::RefPtr< Gdk::DragContext >& context, const Glib::RefPtr< TargetList >& target_list) const
 Looks for a match between context->targets and the dest_target_list, returning the first matching target, otherwise returning Gdk::NONE. More...

 
Glib::ustring drag_dest_find_target (const Glib::RefPtr< Gdk::DragContext >& context) const
 
Glib::RefPtr< TargetListdrag_dest_get_target_list ()
 
Glib::RefPtr< const TargetListdrag_dest_get_target_list () const
 
void drag_dest_set_target_list (const Glib::RefPtr< TargetList >& target_list)
 
void drag_dest_add_text_targets ()
 
void drag_dest_add_image_targets ()
 
void drag_dest_add_uri_targets ()
 
void drag_source_set (const std::vector< TargetEntry >& targets, Gdk::ModifierType start_button_mask=Gdk::MODIFIER_MASK, Gdk::DragAction actions=Gdk::ACTION_COPY)
 
void drag_source_unset ()
 Undoes the effects of gtk_drag_source_set(). More...

 
void drag_source_set_icon (const Glib::RefPtr< Gdk::Pixbuf >& pixbuf)
 Sets the icon that will be used for drags from a particular widget from a Gdk::Pixbuf. More...

 
void drag_source_set_icon (const StockID& stock_id)
 Sets the icon that will be used for drags from a particular source to a stock icon. More...

 
void drag_source_set_icon (const Glib::ustring& icon_name)
 Sets the icon that will be used for drags from a particular source to a themed icon. More...

 
void drag_source_add_text_targets ()
 Add the text targets supported by Gtk::SelectionData to the target list of the drag source. More...

 
void drag_source_add_uri_targets ()
 Add the URI targets supported by Gtk::SelectionData to the target list of the drag source. More...

 
void drag_source_add_image_targets ()
 Add the writable image targets supported by Gtk::SelectionData to the target list of the drag source. More...

 
Glib::RefPtr< Gdk::DragContextdrag_begin (const Glib::RefPtr< TargetList >& targets, Gdk::DragAction actions, int button, GdkEvent* gdk_event)
 
Glib::RefPtr< Gdk::DragContextdrag_begin (const Glib::RefPtr< TargetList >& targets, Gdk::DragAction actions, int button, GdkEvent* gdk_event, int x, int y)
 
bool drag_check_threshold (int start_x, int start_y, int current_x, int current_y)
 
void drag_set_as_icon (const Glib::RefPtr< Gdk::DragContext >& context, int hot_x, int hot_y)
 
void queue_resize_no_redraw ()
 This function works like queue_resize(), except that the widget is not invalidated. More...

 
bool get_no_show_all () const
 Returns the current value of the Gtk::Widget::property_no_show_all() property, which determines whether calls to show_all() will affect this widget. More...

 
void set_no_show_all (bool no_show_all=true)
 Sets the Gtk::Widget::property_no_show_all() property, which determines whether calls to show_all() will affect this widget. More...

 
void set_parent (Widget& parent)
 This function is useful only when implementing subclasses of Gtk::Container. More...

 
void unparent ()
 This function is only for use in widget implementations. More...

 
void map ()
 This function is only for use in widget implementations. More...

 
void unmap ()
 This function is only for use in widget implementations. More...

 
void draw_insertion_cursor (const ::Cairo::RefPtr< ::Cairo::Context >& cr, const Gdk::Rectangle& location, bool is_primary, TextDirection direction, bool draw_arrow=true)
 Draws a text caret on cr at location. More...

 
void set_tooltip_window (Window& custom_window)
 Replaces the default, usually yellow, window used for displaying tooltips with custom_window. More...

 
Windowget_tooltip_window ()
 Returns the Gtk::Window of the current tooltip. More...

 
void trigger_tooltip_query ()
 Triggers a tooltip query on the display where the toplevel of widget is located. More...

 
void set_tooltip_text (const Glib::ustring& text)
 Sets text as the contents of the tooltip. More...

 
Glib::ustring get_tooltip_text () const
 Gets the contents of the tooltip for widget. More...

 
void set_tooltip_markup (const Glib::ustring& markup)
 Sets markup as the contents of the tooltip, which is marked up with the Pango text markup language. More...

 
Glib::ustring get_tooltip_markup () const
 Gets the contents of the tooltip for widget. More...

 
void set_has_tooltip (bool has_tooltip=TRUE)
 Sets the has-tooltip property on widget to has_tooltip. More...

 
bool get_has_tooltip () const
 Returns the current value of the has-tooltip property. More...

 
int get_width () const
 
int get_height () const
 
bool is_composited () const
 Whether widget can rely on having its alpha channel drawn correctly. More...

 
bool in_destruction () const
 Returns whether the widget is currently being destroyed. More...

 
Glib::RefPtr< StyleContextget_style_context ()
 Returns the style context associated to widget. More...

 
Glib::RefPtr< Gtk::StyleContextget_style_context () const
 Returns the style context associated to widget. More...

 
Gdk::ModifierType get_modifier_mask (Gdk::ModifierIntent intent)
 Returns the modifier mask the widget’s windowing system backend uses for a particular purpose. More...

 
void insert_action_group (const Glib::ustring& name, const Glib::RefPtr< Gio::ActionGroup >& group)
 Inserts group into widget. More...

 
void remove_action_group (const Glib::ustring& name)
 Removes a group from the widget. More...

 
Glib::RefPtr< Gio::ActionGroupget_action_group (const Glib::ustring& prefix)
 Retrieves the ActionGroup that was registered using prefix. More...

 
Glib::RefPtr< const Gio::ActionGroupget_action_group (const Glib::ustring& prefix) const
 Retrieves the ActionGroup that was registered using prefix. More...

 
std::vector< Glib::ustringlist_action_prefixes () const
 Retrieves a nullptr-terminated array of strings containing the prefixes of ActionGroup's available to widget. More...

 
void set_font_map (const Glib::RefPtr< Pango::FontMap >& font_map)
 Sets the font map to use for Pango rendering. More...

 
Glib::RefPtr< Pango::FontMapget_font_map ()
 Gets the font map that has been set with set_font_map(). More...

 
Glib::RefPtr< const Pango::FontMapget_font_map () const
 Gets the font map that has been set with set_font_map(). More...

 
Glib::SignalProxy< void > signal_show ()
 
Glib::SignalProxy< void > signal_hide ()
 
Glib::SignalProxy< void > signal_map ()
 Emitted on mapping of a widget to the screen. More...

 
Glib::SignalProxy< void > signal_unmap ()
 
Glib::SignalProxy< void > signal_realize ()
 Emitted on realization of a widget. More...

 
Glib::SignalProxy< void > signal_unrealize ()
 
Glib::SignalProxy< void, Allocation& > signal_size_allocate ()
 
Glib::SignalProxy< void, Gtk::StateTypesignal_state_changed ()
 
Glib::SignalProxy< void, Gtk::StateFlagssignal_state_flags_changed ()
 
Glib::SignalProxy< void, Widget* > signal_parent_changed ()
 Informs objects that their parent changed. More...

 
Glib::SignalProxy< void, Widget* > signal_hierarchy_changed ()
 
Glib::SignalProxy< void > signal_style_updated ()
 
Glib::SignalProxy< void, TextDirectionsignal_direction_changed ()
 
Glib::SignalProxy< void, bool > signal_grab_notify ()
 
Glib::SignalProxy< void, GParamSpec* > signal_child_notify ()
 
Glib::SignalProxy< bool, bool > signal_mnemonic_activate ()
 
Glib::SignalProxy< void > signal_grab_focus ()
 
Glib::SignalProxy< bool, DirectionTypesignal_focus ()
 
Glib::SignalProxy< bool, GdkEvent* > signal_event ()
 
Glib::SignalProxy< void, GdkEvent* > signal_event_after ()
 
Glib::SignalProxy< bool, GdkEventButton* > signal_button_press_event ()
 Event triggered by user pressing button. More...

 
Glib::SignalProxy< bool, GdkEventButton* > signal_button_release_event ()
 Event triggered by user releasing button. More...

 
Glib::SignalProxy< bool, GdkEventScroll* > signal_scroll_event ()
 
Glib::SignalProxy< bool, GdkEventMotion* > signal_motion_notify_event ()
 Event triggered by user moving pointer. More...

 
Glib::SignalProxy< bool, GdkEventAny* > signal_delete_event ()
 
Glib::SignalProxy< bool, const ::Cairo::RefPtr< ::Cairo::Context >& > signal_draw ()
 
Glib::SignalProxy< bool, GdkEventKey* > signal_key_press_event ()
 Event triggered by a key press will widget has focus. More...

 
Glib::SignalProxy< bool, GdkEventKey* > signal_key_release_event ()
 Event triggered by a key release will widget has focus. More...

 
Glib::SignalProxy< bool, GdkEventCrossing* > signal_enter_notify_event ()
 Event triggered by pointer entering widget area. More...

 
Glib::SignalProxy< bool, GdkEventCrossing* > signal_leave_notify_event ()
 Event triggered by pointer leaving widget area. More...

 
Glib::SignalProxy< bool, GdkEventConfigure* > signal_configure_event ()
 Event triggered by a window resizing. More...

 
Glib::SignalProxy< bool, GdkEventFocus* > signal_focus_in_event ()
 
Glib::SignalProxy< bool, GdkEventFocus* > signal_focus_out_event ()
 
Glib::SignalProxy< bool, GdkEventAny* > signal_map_event ()
 
Glib::SignalProxy< bool, GdkEventAny* > signal_unmap_event ()
 
Glib::SignalProxy< bool, GdkEventProperty* > signal_property_notify_event ()
 
Glib::SignalProxy< bool, GdkEventSelection* > signal_selection_clear_event ()
 
Glib::SignalProxy< bool, GdkEventSelection* > signal_selection_request_event ()
 
Glib::SignalProxy< bool, GdkEventSelection* > signal_selection_notify_event ()
 
Glib::SignalProxy< bool, GdkEventProximity* > signal_proximity_in_event ()
 
Glib::SignalProxy< bool, GdkEventProximity* > signal_proximity_out_event ()
 
Glib::SignalProxy< bool, GdkEventVisibility* > signal_visibility_notify_event ()
 
Glib::SignalProxy< bool, GdkEventWindowState* > signal_window_state_event ()
 
Glib::SignalProxy< void, SelectionData&, guint, guint > signal_selection_get ()
 
Glib::SignalProxy< void, const SelectionData&, guint > signal_selection_received ()
 
Glib::SignalProxy< void, const Glib::RefPtr< Gdk::DragContext >& > signal_drag_begin ()
 
Glib::SignalProxy< void, const Glib::RefPtr< Gdk::DragContext >& > signal_drag_end ()
 
Glib::SignalProxy< void, const Glib::RefPtr< Gdk::DragContext >&, SelectionData&, guint, guint > signal_drag_data_get ()
 
Glib::SignalProxy< void, const Glib::RefPtr< Gdk::DragContext >& > signal_drag_data_delete ()
 
Glib::SignalProxy< bool, const Glib::RefPtr< Gdk::DragContext >&, DragResultsignal_drag_failed ()
 
Glib::SignalProxy< void, const Glib::RefPtr< Gdk::DragContext >&, guint > signal_drag_leave ()
 
Glib::SignalProxy< bool, const Glib::RefPtr< Gdk::DragContext >&, int, int, guint > signal_drag_motion ()
 
Glib::SignalProxy< bool, const Glib::RefPtr< Gdk::DragContext >&, int, int, guint > signal_drag_drop ()
 
Glib::SignalProxy< void, const Glib::RefPtr< Gdk::DragContext >&, int, int, const SelectionData&, guint, guint > signal_drag_data_received ()
 
Glib::SignalProxy< void, const Glib::RefPtr< Gdk::Screen >& > signal_screen_changed ()
 
Glib::SignalProxy< void > signal_composited_changed ()
 
Glib::SignalProxy< bool > signal_popup_menu ()
 
Glib::SignalProxy< bool, int, int, bool, const Glib::RefPtr< Tooltip >& > signal_query_tooltip ()
 
Glib::SignalProxy< bool, GdkEventGrabBroken* > signal_grab_broken_event ()
 
Glib::SignalProxy< bool, GdkEventExpose* > signal_damage_event ()
 
Glib::SignalProxy< bool, GdkEventTouch* > signal_touch_event ()
 
Glib::PropertyProxy< Glib::ustringproperty_name ()
 The name of the widget. More...

 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_name () const
 The name of the widget. More...

 
Glib::PropertyProxy< Container* > property_parent ()
 The parent widget of this widget. More...

 
Glib::PropertyProxy_ReadOnly< Container* > property_parent () const
 The parent widget of this widget. More...

 
Glib::PropertyProxy< int > property_width_request ()
 Override for width request of the widget, or -1 if natural request should be used. More...

 
Glib::PropertyProxy_ReadOnly< int > property_width_request () const
 Override for width request of the widget, or -1 if natural request should be used. More...

 
Glib::PropertyProxy< int > property_height_request ()
 Override for height request of the widget, or -1 if natural request should be used. More...

 
Glib::PropertyProxy_ReadOnly< int > property_height_request () const
 Override for height request of the widget, or -1 if natural request should be used. More...

 
Glib::PropertyProxy< bool > property_visible ()
 Whether the widget is visible. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_visible () const
 Whether the widget is visible. More...

 
Glib::PropertyProxy< bool > property_sensitive ()
 Whether the widget responds to input. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_sensitive () const
 Whether the widget responds to input. More...

 
Glib::PropertyProxy< bool > property_app_paintable ()
 Whether the application will paint directly on the widget. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_app_paintable () const
 Whether the application will paint directly on the widget. More...

 
Glib::PropertyProxy< bool > property_can_focus ()
 Whether the widget can accept the input focus. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_can_focus () const
 Whether the widget can accept the input focus. More...

 
Glib::PropertyProxy< bool > property_has_focus ()
 Whether the widget has the input focus. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_has_focus () const
 Whether the widget has the input focus. More...

 
Glib::PropertyProxy< bool > property_is_focus ()
 Whether the widget is the focus widget within the toplevel. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_is_focus () const
 Whether the widget is the focus widget within the toplevel. More...

 
Glib::PropertyProxy< bool > property_focus_on_click ()
 Whether the widget should grab focus when it is clicked with the mouse. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_focus_on_click () const
 Whether the widget should grab focus when it is clicked with the mouse. More...

 
Glib::PropertyProxy< bool > property_can_default ()
 Whether the widget can be the default widget. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_can_default () const
 Whether the widget can be the default widget. More...

 
Glib::PropertyProxy< bool > property_has_default ()
 Whether the widget is the default widget. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_has_default () const
 Whether the widget is the default widget. More...

 
Glib::PropertyProxy< bool > property_receives_default ()
 If TRUE, the widget will receive the default action when it is focused. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_receives_default () const
 If TRUE, the widget will receive the default action when it is focused. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_composite_child () const
 Whether the widget is part of a composite widget. More...

 
Glib::PropertyProxy< Glib::RefPtr< Style > > property_style ()
 The style of the widget, which contains information about how it will look (colors, etc). More...

 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Style > > property_style () const
 The style of the widget, which contains information about how it will look (colors, etc). More...

 
Glib::PropertyProxy< Gdk::EventMaskproperty_events ()
 The event mask that decides what kind of GdkEvents this widget gets. More...

 
Glib::PropertyProxy_ReadOnly< Gdk::EventMaskproperty_events () const
 The event mask that decides what kind of GdkEvents this widget gets. More...

 
Glib::PropertyProxy< bool > property_has_tooltip ()
 Enables or disables the emission of Gtk::Widget::signal_query_tooltip() on widget. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_has_tooltip () const
 Enables or disables the emission of Gtk::Widget::signal_query_tooltip() on widget. More...

 
Glib::PropertyProxy< Glib::ustringproperty_tooltip_markup ()
 Sets the text of tooltip to be the given string, which is marked up with the [Pango text markup language][PangoMarkupFormat]. More...

 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_tooltip_markup () const
 Sets the text of tooltip to be the given string, which is marked up with the [Pango text markup language][PangoMarkupFormat]. More...

 
Glib::PropertyProxy< Glib::ustringproperty_tooltip_text ()
 Sets the text of tooltip to be the given string. More...

 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_tooltip_text () const
 Sets the text of tooltip to be the given string. More...

 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Window > > property_window () const
 The widget's window if it is realized, nullptr otherwise. More...

 
Glib::PropertyProxy< bool > property_no_show_all ()
 Whether gtk_widget_show_all() should not affect this widget. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_no_show_all () const
 Whether gtk_widget_show_all() should not affect this widget. More...

 
Glib::PropertyProxy< bool > property_double_buffered ()
 Whether the widget is double buffered. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_double_buffered () const
 Whether the widget is double buffered. More...

 
Glib::PropertyProxy< Alignproperty_halign ()
 How to distribute horizontal space if widget gets extra space, see Gtk::Align. More...

 
Glib::PropertyProxy_ReadOnly< Alignproperty_halign () const
 How to distribute horizontal space if widget gets extra space, see Gtk::Align. More...

 
Glib::PropertyProxy< Alignproperty_valign ()
 How to distribute vertical space if widget gets extra space, see Gtk::Align. More...

 
Glib::PropertyProxy_ReadOnly< Alignproperty_valign () const
 How to distribute vertical space if widget gets extra space, see Gtk::Align. More...

 
Glib::PropertyProxy< int > property_margin_left ()
 Margin on left side of widget. More...

 
Glib::PropertyProxy_ReadOnly< int > property_margin_left () const
 Margin on left side of widget. More...

 
Glib::PropertyProxy< int > property_margin_right ()
 Margin on right side of widget. More...

 
Glib::PropertyProxy_ReadOnly< int > property_margin_right () const
 Margin on right side of widget. More...

 
Glib::PropertyProxy< int > property_margin_start ()
 Margin on start of widget, horizontally. More...

 
Glib::PropertyProxy_ReadOnly< int > property_margin_start () const
 Margin on start of widget, horizontally. More...

 
Glib::PropertyProxy< int > property_margin_end ()
 Margin on end of widget, horizontally. More...

 
Glib::PropertyProxy_ReadOnly< int > property_margin_end () const
 Margin on end of widget, horizontally. More...

 
Glib::PropertyProxy< int > property_margin_top ()
 Margin on top side of widget. More...

 
Glib::PropertyProxy_ReadOnly< int > property_margin_top () const
 Margin on top side of widget. More...

 
Glib::PropertyProxy< int > property_margin_bottom ()
 Margin on bottom side of widget. More...

 
Glib::PropertyProxy_ReadOnly< int > property_margin_bottom () const
 Margin on bottom side of widget. More...

 
Glib::PropertyProxy< int > property_margin ()
 Sets all four sides' margin at once. More...

 
Glib::PropertyProxy_ReadOnly< int > property_margin () const
 Sets all four sides' margin at once. More...

 
Glib::PropertyProxy< bool > property_hexpand ()
 Whether to expand horizontally. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_hexpand () const
 Whether to expand horizontally. More...

 
Glib::PropertyProxy< bool > property_hexpand_set ()
 Whether to use the Gtk::Widget::property_hexpand() property. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_hexpand_set () const
 Whether to use the Gtk::Widget::property_hexpand() property. More...

 
Glib::PropertyProxy< bool > property_vexpand ()
 Whether to expand vertically. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_vexpand () const
 Whether to expand vertically. More...

 
Glib::PropertyProxy< bool > property_vexpand_set ()
 Whether to use the Gtk::Widget::property_vexpand() property. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_vexpand_set () const
 Whether to use the Gtk::Widget::property_vexpand() property. More...

 
Glib::PropertyProxy< bool > property_expand ()
 Whether to expand in both directions. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_expand () const
 Whether to expand in both directions. More...

 
Glib::PropertyProxy< double > property_opacity ()
 The requested opacity of the widget. More...

 
Glib::PropertyProxy_ReadOnly< double > property_opacity () const
 The requested opacity of the widget. More...

 
Glib::PropertyProxy_ReadOnly< int > property_scale_factor () const
 The scale factor of the widget. More...

 
- Public Member Functions inherited from Gtk::Object
 Object (Object&& src) noexcept
 
Objectoperator= (Object&& src) noexcept
 
 ~Object () noexceptoverride
 
GObject* gobj ()
 Provides access to the underlying C GtkObject. More...

 
const GObject* gobj () const
 Provides access to the underlying C GtkObject. More...

 
- Public Member Functions inherited from Glib::Object
 Object (const Object &)=delete
 
Objectoperator= (const Object &)=delete
 
 Object (Object &&src) noexcept
 
Objectoperator= (Object &&src) noexcept
 
void * get_data (const QueryQuark &key)
 
void set_data (const Quark &key, void *data)
 
void set_data (const Quark &key, void *data, DestroyNotify notify)
 
void remove_data (const QueryQuark &quark)
 
void * steal_data (const QueryQuark &quark)
 
Glib::RefPtr< Glib::Objectwrap (GObject *object, bool take_copy=false)
 
- Public Member Functions inherited from Glib::ObjectBase
 ObjectBase (const ObjectBase &)=delete
 
ObjectBaseoperator= (const ObjectBase &)=delete
 
void set_property_value (const Glib::ustring &property_name, const Glib::ValueBase &value)
 
void get_property_value (const Glib::ustring &property_name, Glib::ValueBase &value) const
 
void set_property (const Glib::ustring &property_name, const PropertyType &value)
 
void get_property (const Glib::ustring &property_name, PropertyType &value) const
 
void connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void > &slot)
 
void connect_property_changed (const Glib::ustring &property_name, sigc::slot< void > &&slot)
 
sigc::connection connect_property_changed_with_return (const Glib::ustring &property_name, const sigc::slot< void > &slot)
 
sigc::connection connect_property_changed_with_return (const Glib::ustring &property_name, sigc::slot< void > &&slot)
 
void freeze_notify ()
 
void thaw_notify ()
 
virtual void reference () const
 
virtual void unreference () const
 
GObject * gobj ()
 
const GObject * gobj () const
 
GObject * gobj_copy () const
 
- Public Member Functions inherited from sigc::trackable
 trackable () noexcept
 
 trackable (const trackable &src) noexcept
 
 trackable (trackable &&src)
 
 ~trackable ()
 
void add_destroy_notify_callback (void *data, func_destroy_notify func) const
 
void notify_callbacks ()
 
trackableoperator= (const trackable &src)
 
trackableoperator= (trackable &&src)
 
void remove_destroy_notify_callback (void *data) const
 
- Public Member Functions inherited from Gtk::Buildable
 Buildable (Buildable&& src) noexcept
 
Buildableoperator= (Buildable&& src) noexcept
 
 ~Buildable () noexceptoverride
 
GtkBuildable* gobj ()
 Provides access to the underlying C GObject. More...

 
const GtkBuildable* gobj () const
 Provides access to the underlying C GObject. More...

 
void set_name (const Glib::ustring& name)
 Sets the name of the buildable object. More...

 
Glib::ustring get_name () const
 Gets the name of the buildable object. More...

 
- Public Member Functions inherited from Glib::Interface
 Interface ()
 
 Interface (Interface &&src) noexcept
 
Interfaceoperator= (Interface &&src) noexcept
 
 Interface (const Glib::Interface_Class &interface_class)
 
 Interface (GObject *castitem)
 
 ~Interface () noexceptoverride
 
 Interface (const Interface &)=delete
 
Interfaceoperator= (const Interface &)=delete
 
GObject * gobj ()
 
const GObject * gobj () const
 
- Public Member Functions inherited from Atk::Implementor
 Implementor (Implementor &&src) noexcept
 
Implementoroperator= (Implementor &&src) noexcept
 
 ~Implementor () noexceptoverride
 
AtkImplementor * gobj ()
 
const AtkImplementor * gobj () const
 
Glib::RefPtr< Atk::Implementorwrap (AtkImplementor *object, bool take_copy=false)
 
- Public Member Functions inherited from Gtk::CellLayout
 CellLayout (CellLayout&& src) noexcept
 
CellLayoutoperator= (CellLayout&& src) noexcept
 
 ~CellLayout () noexceptoverride
 
GtkCellLayout* gobj ()
 Provides access to the underlying C GObject. More...

 
const GtkCellLayout* gobj () const
 Provides access to the underlying C GObject. More...

 
template<class ColumnType >
void pack_start (const TreeModelColumn< ColumnType >& model_column, bool expand=true)
 
void pack_start (CellRenderer& cell, bool expand=true)
 Packs the cell into the beginning of cell_layout. More...

 
void pack_end (CellRenderer& cell, bool expand=true)
 Adds the cell to the end of cell_layout. More...

 
std::vector< CellRenderer* > get_cells ()
 Return value: a list of cell renderers. More...

 
std::vector< const CellRenderer* > get_cells () const
 Return value: a list of cell renderers. More...

 
CellRendererget_first_cell ()
 Gets the CellRenderer for the column. More...

 
const CellRendererget_first_cell () const
 Gets the CellRenderer for the column. More...

 
void clear ()
 Unsets all the mappings on all renderers on cell_layout and removes all renderers from cell_layout. More...

 
void add_attribute (CellRenderer& cell, const Glib::ustring& attribute, int column)
 Adds an attribute mapping to the list in cell_layout. More...

 
void add_attribute (const Glib::PropertyProxy_Base& property, const TreeModelColumnBase& column)
 
void add_attribute (CellRenderer& cell, const Glib::ustring& attribute, const TreeModelColumnBase& column)
 
void set_cell_data_func (CellRenderer& cell, const SlotCellData& slot)
 
void clear_attributes (CellRenderer& cell)
 Clears all existing attributes previously set with set_attributes(). More...

 
void reorder (CellRenderer& cell, int position)
 Re-inserts cell at position. More...

 
Glib::RefPtr< CellAreaget_area ()
 Returns the underlying Gtk::CellArea which might be cell_layout if called on a Gtk::CellArea or might be nullptr if no Gtk::CellArea is used by cell_layout. More...

 
Glib::RefPtr< const CellAreaget_area () const
 Returns the underlying Gtk::CellArea which might be cell_layout if called on a Gtk::CellArea or might be nullptr if no Gtk::CellArea is used by cell_layout. More...

 
template<class T_ModelColumnType >
void pack_start (const TreeModelColumn< T_ModelColumnType >& column, bool expand)
 
- Public Member Functions inherited from Gtk::CellEditable
 CellEditable (CellEditable&& src) noexcept
 
CellEditableoperator= (CellEditable&& src) noexcept
 
 ~CellEditable () noexceptoverride
 
GtkCellEditable* gobj ()
 Provides access to the underlying C GObject. More...

 
const GtkCellEditable* gobj () const
 Provides access to the underlying C GObject. More...

 
void start_editing (GdkEvent* event)
 Begins editing on a cell_editable. More...

 
void editing_done ()
 Emits the Gtk::CellEditable::signal_editing_done() signal. More...

 
void remove_widget ()
 Emits the Gtk::CellEditable::signal_remove_widget() signal. More...

 
Glib::SignalProxy< void > signal_editing_done ()
 
Glib::SignalProxy< void > signal_remove_widget ()
 
Glib::PropertyProxy< bool > property_editing_canceled ()
 Indicates whether editing on the cell has been canceled. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_editing_canceled () const
 Indicates whether editing on the cell has been canceled. More...

 

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 
- Static Public Member Functions inherited from Gtk::Bin
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 
- Static Public Member Functions inherited from Gtk::Container
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 
- Static Public Member Functions inherited from Gtk::Widget
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 
static Widgetget_current_modal_grab ()
 Retrieve the widget which is currently grabbing all events. More...

 
static void push_composite_child ()
 Makes all newly-created widgets as composite children until the corresponding pop_composite_child() call. More...

 
static void pop_composite_child ()
 Cancels the effect of a previous call to push_composite_child(). More...

 
static void set_default_direction (TextDirection dir)
 Sets the default reading direction for widgets where the direction has not been explicitly set by set_direction(). More...

 
static TextDirection get_default_direction ()
 Obtains the current default reading direction. More...

 
static Widgetdrag_get_source_widget (const Glib::RefPtr< Gdk::DragContext >& context)
 
- Static Public Member Functions inherited from Gtk::Buildable
static void add_interface (GType gtype_implementer)
 
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 
- Static Public Member Functions inherited from Atk::Implementor
static void add_interface (GType gtype_implementer)
 
static GType get_type ()
 
- Static Public Member Functions inherited from Gtk::CellLayout
static void add_interface (GType gtype_implementer)
 
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 
- Static Public Member Functions inherited from Gtk::CellEditable
static void add_interface (GType gtype_implementer)
 
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 

Protected Member Functions

virtual void on_changed ()
 This is a default handler for the signal signal_changed(). More...

 
- Protected Member Functions inherited from Gtk::Bin
 Bin ()
 This constructor is protected because only derived classes should be instantiated. More...

 
- Protected Member Functions inherited from Gtk::Container
virtual void on_add (Widget* widget)
 This is a default handler for the signal signal_add(). More...

 
virtual void on_remove (Widget* widget)
 This is a default handler for the signal signal_remove(). More...

 
virtual void on_check_resize ()
 This is a default handler for the signal signal_check_resize(). More...

 
virtual void on_set_focus_child (Widget* widget)
 This is a default handler for the signal signal_set_focus_child(). More...

 
 Container ()
 
virtual GType child_type_vfunc () const
 Implements child_type(). More...

 
virtual void forall_vfunc (gboolean include_internals, GtkCallback callback, gpointer callback_data)
 Invokes a callback on all children of the container. More...

 
virtual char* composite_name_vfunc (GtkWidget* child)
 Returns the composite name of a child widget. More...

 
virtual void set_child_property_vfunc (GtkWidget* child, guint property_id, const GValue* value, GParamSpec* pspec)
 Sets a child property for this container and its child. More...

 
virtual void get_child_property_vfunc (GtkWidget* child, guint property_id, GValue* value, GParamSpec* pspec) const
 Returns a child property for this container and its child. More...

 
Glib::PropertyProxy< guint > property_border_width ()
 The width of the empty border outside the containers children. More...

 
Glib::PropertyProxy_ReadOnly< guint > property_border_width () const
 The width of the empty border outside the containers children. More...

 
Glib::PropertyProxy< ResizeModeproperty_resize_mode ()
 Specify how resize events are handled. More...

 
Glib::PropertyProxy_ReadOnly< ResizeModeproperty_resize_mode () const
 Specify how resize events are handled. More...

 
Glib::PropertyProxy_WriteOnly< Widget* > property_child ()
 Can be used to add a new child to the container. More...

 
- Protected Member Functions inherited from Gtk::Widget
virtual void on_show ()
 This is a default handler for the signal signal_show(). More...

 
virtual void on_hide ()
 This is a default handler for the signal signal_hide(). More...

 
virtual void on_map ()
 This is a default handler for the signal signal_map(). More...

 
virtual void on_unmap ()
 This is a default handler for the signal signal_unmap(). More...

 
virtual void on_realize ()
 This is a default handler for the signal signal_realize(). More...

 
virtual void on_unrealize ()
 This is a default handler for the signal signal_unrealize(). More...

 
virtual void on_size_allocate (Allocation& allocation)
 This is a default handler for the signal signal_size_allocate(). More...

 
virtual void on_state_changed (Gtk::StateType previous_state)
 This is a default handler for the signal signal_state_changed(). More...

 
virtual void on_parent_changed (Widget* previous_parent)
 This is a default handler for the signal signal_parent_changed(). More...

 
virtual void on_hierarchy_changed (Widget* previous_toplevel)
 This is a default handler for the signal signal_hierarchy_changed(). More...

 
virtual void on_style_updated ()
 This is a default handler for the signal signal_style_updated(). More...

 
virtual void on_direction_changed (TextDirection direction)
 This is a default handler for the signal signal_direction_changed(). More...

 
virtual void on_grab_notify (bool was_grabbed)
 This is a default handler for the signal signal_grab_notify(). More...

 
virtual void on_child_notify (GParamSpec* pspec)
 This is a default handler for the signal signal_child_notify(). More...

 
virtual bool on_mnemonic_activate (bool group_cycling)
 This is a default handler for the signal signal_mnemonic_activate(). More...

 
virtual void on_grab_focus ()
 This is a default handler for the signal signal_grab_focus(). More...

 
virtual bool on_focus (DirectionType direction)
 This is a default handler for the signal signal_focus(). More...

 
virtual bool on_event (GdkEvent* gdk_event)
 This is a default handler for the signal signal_event(). More...

 
virtual bool on_button_press_event (GdkEventButton* button_event)
 This is a default handler for the signal signal_button_press_event(). More...

 
virtual bool on_button_release_event (GdkEventButton* release_event)
 This is a default handler for the signal signal_button_release_event(). More...

 
virtual bool on_scroll_event (GdkEventScroll* scroll_event)
 This is a default handler for the signal signal_scroll_event(). More...

 
virtual bool on_motion_notify_event (GdkEventMotion* motion_event)
 This is a default handler for the signal signal_motion_notify_event(). More...

 
virtual bool on_delete_event (GdkEventAny* any_event)
 This is a default handler for the signal signal_delete_event(). More...

 
virtual bool on_draw (const ::Cairo::RefPtr< ::Cairo::Context >& cr)
 This is a default handler for the signal signal_draw(). More...

 
virtual bool on_key_press_event (GdkEventKey* key_event)
 This is a default handler for the signal signal_key_press_event(). More...

 
virtual bool on_key_release_event (GdkEventKey* key_event)
 This is a default handler for the signal signal_key_release_event(). More...

 
virtual bool on_enter_notify_event (GdkEventCrossing* crossing_event)
 This is a default handler for the signal signal_enter_notify_event(). More...

 
virtual bool on_leave_notify_event (GdkEventCrossing* crossing_event)
 This is a default handler for the signal signal_leave_notify_event(). More...

 
virtual bool on_configure_event (GdkEventConfigure* configure_event)
 This is a default handler for the signal signal_configure_event(). More...

 
virtual bool on_focus_in_event (GdkEventFocus* focus_event)
 This is a default handler for the signal signal_focus_in_event(). More...

 
virtual bool on_focus_out_event (GdkEventFocus* gdk_event)
 This is a default handler for the signal signal_focus_out_event(). More...

 
virtual bool on_map_event (GdkEventAny* any_event)
 This is a default handler for the signal signal_map_event(). More...

 
virtual bool on_unmap_event (GdkEventAny* any_event)
 This is a default handler for the signal signal_unmap_event(). More...

 
virtual bool on_property_notify_event (GdkEventProperty* property_event)
 This is a default handler for the signal signal_property_notify_event(). More...

 
virtual bool on_selection_clear_event (GdkEventSelection* selection_event)
 This is a default handler for the signal signal_selection_clear_event(). More...

 
virtual bool on_selection_request_event (GdkEventSelection* selection_event)
 This is a default handler for the signal signal_selection_request_event(). More...

 
virtual bool on_selection_notify_event (GdkEventSelection* selection_event)
 This is a default handler for the signal signal_selection_notify_event(). More...

 
virtual bool on_proximity_in_event (GdkEventProximity* proximity_event)
 This is a default handler for the signal signal_proximity_in_event(). More...

 
virtual bool on_proximity_out_event (GdkEventProximity* proximity_event)
 This is a default handler for the signal signal_proximity_out_event(). More...

 
virtual bool on_visibility_notify_event (GdkEventVisibility* visibility_event)
 This is a default handler for the signal signal_visibility_notify_event(). More...

 
virtual bool on_window_state_event (GdkEventWindowState* window_state_event)
 This is a default handler for the signal signal_window_state_event(). More...

 
virtual void on_selection_get (SelectionData& selection_data, guint info, guint time)
 This is a default handler for the signal signal_selection_get(). More...

 
virtual void on_selection_received (const SelectionData& selection_data, guint time)
 This is a default handler for the signal signal_selection_received(). More...

 
virtual void on_drag_begin (const Glib::RefPtr< Gdk::DragContext >& context)
 This is a default handler for the signal signal_drag_begin(). More...

 
virtual void on_drag_end (const Glib::RefPtr< Gdk::DragContext >& context)
 This is a default handler for the signal signal_drag_end(). More...

 
virtual void on_drag_data_get (const Glib::RefPtr< Gdk::DragContext >& context, SelectionData& selection_data, guint info, guint time)
 This is a default handler for the signal signal_drag_data_get(). More...

 
virtual void on_drag_data_delete (const Glib::RefPtr< Gdk::DragContext >& context)
 This is a default handler for the signal signal_drag_data_delete(). More...

 
virtual void on_drag_leave (const Glib::RefPtr< Gdk::DragContext >& context, guint time)
 This is a default handler for the signal signal_drag_leave(). More...

 
virtual bool on_drag_motion (const Glib::RefPtr< Gdk::DragContext >& context, int x, int y, guint time)
 This is a default handler for the signal signal_drag_motion(). More...

 
virtual bool on_drag_drop (const Glib::RefPtr< Gdk::DragContext >& context, int x, int y, guint time)
 This is a default handler for the signal signal_drag_drop(). More...

 
virtual void on_drag_data_received (const Glib::RefPtr< Gdk::DragContext >& context, int x, int y, const SelectionData& selection_data, guint info, guint time)
 This is a default handler for the signal signal_drag_data_received(). More...

 
virtual void on_screen_changed (const Glib::RefPtr< Gdk::Screen >& previous_screen)
 This is a default handler for the signal signal_screen_changed(). More...

 
virtual void dispatch_child_properties_changed_vfunc (guint p1, GParamSpec** p2)
 
virtual void show_all_vfunc ()
 
virtual Glib::RefPtr< Atk::Objectget_accessible_vfunc ()
 
virtual SizeRequestMode get_request_mode_vfunc () const
 
virtual void get_preferred_width_vfunc (int& minimum_width, int& natural_width) const
 
virtual void get_preferred_height_for_width_vfunc (int width, int& minimum_height, int& natural_height) const
 
virtual void get_preferred_height_vfunc (int& minimum_height, int& natural_height) const
 
virtual void get_preferred_width_for_height_vfunc (int height, int& minimum_width, int& natural_width) const
 
 Widget ()
 
void realize ()
 Creates the GDK (windowing system) resources associated with a widget. More...

 
void unrealize ()
 This function is only useful in widget implementations. More...

 
void draw (const ::Cairo::RefPtr< ::Cairo::Context >& cr)
 Draws widget to cr. More...

 
void set_mapped (bool mapped=true)
 Marks the widget as being realized. More...

 
void set_realized (bool realized=true)
 Marks the widget as being realized. More...

 
void set_has_window (bool has_window=true)
 Specifies whether widget has a Gdk::Window of its own. More...

 
void set_window (const Glib::RefPtr< Gdk::Window >& window)
 Sets a widget's window. More...

 
void transform_cairo_context_to_window (const ::Cairo::RefPtr< ::Cairo::Context >& cr, const Glib::RefPtr< const Gdk::Window >& window)
 Transforms the given cairo context cr from widget-relative coordinates to window-relative coordinates. More...

 
Requisition get_requisition () const
 Retrieves the widget's requisition. More...

 
void get_style_property_value (const Glib::ustring& the_property_name, Glib::ValueBase& value) const
 Gets the value of a style property of widget. More...

 
void realize_if_needed ()
 
- Protected Member Functions inherited from Glib::Object
 Object ()
 
 Object (const Glib::ConstructParams &construct_params)
 
 Object (GObject *castitem)
 
 ~Object () noexceptoverride
 
- Protected Member Functions inherited from Glib::ObjectBase
 ObjectBase ()
 
 ObjectBase (const char *custom_type_name)
 
 ObjectBase (const std::type_info &custom_type_info)
 
 ObjectBase (ObjectBase &&src) noexcept
 
ObjectBaseoperator= (ObjectBase &&src) noexcept
 
virtual ~ObjectBase () noexcept=0
 
void initialize (GObject *castitem)
 
void initialize_move (GObject *castitem, Glib::ObjectBase *previous_wrapper)
 
- Protected Member Functions inherited from Gtk::Buildable
 Buildable ()
 You should derive from this class to use it. More...

 
- Protected Member Functions inherited from Atk::Implementor
 Implementor ()
 
virtual Glib::RefPtr< Objectref_accessibile_vfunc ()
 
- Protected Member Functions inherited from Gtk::CellLayout
 CellLayout ()
 You should derive from this class to use it. More...

 
virtual void pack_start_vfunc (CellRenderer* cell, bool expand)
 
virtual void pack_end_vfunc (CellRenderer* cell, bool expand)
 
virtual void clear_vfunc ()
 
virtual void add_attribute_vfunc (CellRenderer* cell, const Glib::ustring& attribute, int column)
 
virtual void clear_attributes_vfunc (CellRenderer* cell)
 
virtual void reorder_vfunc (CellRenderer* cell, int position)
 
- Protected Member Functions inherited from Gtk::CellEditable
 CellEditable ()
 You should derive from this class to use it. More...

 
virtual void start_editing_vfunc (GdkEvent* event)
 
virtual void on_editing_done ()
 This is a default handler for the signal signal_editing_done(). More...

 
virtual void on_remove_widget ()
 This is a default handler for the signal signal_remove_widget(). More...

 

Related Functions

(Note that these are not member functions.)

Gtk::ComboBoxwrap (GtkComboBox* object, bool take_copy=false)
 A Glib::wrap() method for this object. More...

 

Additional Inherited Members

- Static Protected Member Functions inherited from Gtk::Widget
static bool should_draw_window (const ::Cairo::RefPtr< const ::Cairo::Context >& cr, const Glib::RefPtr< const Gdk::Window >& window)
 This function is supposed to be called in Gtk::Widget::signal_draw() implementations for widgets that support multiple windows. More...

 

Detailed Description

A widget used to choose from a list of items.

A ComboBox is a widget that allows the user to choose from a list of valid choices. The ComboBox displays the selected choice. When activated, the ComboBox displays a popup which allows the user to make a new choice. The style in which the selected value is displayed, and the style of the popup is determined by the current theme. It may be similar to a Windows-style combo box.

The ComboBox uses the model-view pattern; the list of valid choices is specified in the form of a tree model, and the display of the choices can be adapted to the data in the model by using cell renderers, as you would in a tree view. This is possible since ComboBox implements the CellLayout interface. The tree model holding the valid choices is not restricted to a flat list, it can be a real tree, and the popup will reflect the tree structure.

To allow the user to enter values not in the model, the 'has-entry' property allows the ComboBox to contain a Gtk::Entry. This entry can be accessed by calling get_entry(), or you can just call get_entry_text() to get the text from the Entry.

For a simple list of textual choices, the model-view API of ComboBox can be a bit overwhelming. In this case, ComboBoxText offers a simple alternative. Both ComboBox and ComboBoxText can contain an entry.

The ComboBox widget looks like this:

combobox1.png

Member Typedef Documentation

Constructor & Destructor Documentation

Gtk::ComboBox::ComboBox ( ComboBox&&  src)
noexcept
Gtk::ComboBox::ComboBox ( const ComboBox )
delete
Gtk::ComboBox::~ComboBox ( )
overridenoexcept
Gtk::ComboBox::ComboBox ( bool  has_entry = false)
explicit

Creates a new empty ComboBox, optionally with an entry.

Parameters
has_entryIf this is true then this will have an Entry widget.
Gtk::ComboBox::ComboBox ( const Glib::RefPtr< TreeModel >&  model,
bool  has_entry = false 
)
explicit

Creates a new ComboBox with the model initialized to model, optionally with an entry.

Parameters
modelThe model containing data to display in the ComboBox.
has_entryIf this is true then this will have an Entry widget.
Gtk::ComboBox::ComboBox ( const Glib::RefPtr< CellArea >&  cell_area,
bool  has_entry = false 
)
explicit

Creates a new empty ComboBox using cell_area to layout cells, optionally with an entry.

Parameters
cell_areaThe CellArea to use to layout cell renderers.
has_entryIf this is true then this will have an Entry widget.

Member Function Documentation

TreeModel::iterator Gtk::ComboBox::get_active ( )

Gets an iterator that points to the current active item, if it exists.

Returns
The iterator.
TreeModel::const_iterator Gtk::ComboBox::get_active ( ) const

Gets an iterator that points to the current active item, if it exists.

Returns
The iterator.
Glib::ustring Gtk::ComboBox::get_active_id ( ) const

Returns the ID of the active row of combo_box.

This value is taken from the active row and the column specified by the Gtk::ComboBox::property_id_column() property of combo_box (see set_id_column()).

The returned value is an interned string which means that you can compare the pointer by value to other interned strings and that you must not free it.

If the Gtk::ComboBox::property_id_column() property of combo_box is not set, or if no row is active, or if the active row has a nullptr ID value, then nullptr is returned.

Since gtkmm 3.0:
Returns
The ID of the active row, or nullptr.
void Gtk::ComboBox::get_active_id ( const Glib::ustring active_id)

Changes the active row of combo_box to the one that has an ID equal to active_id, or unsets the active row if active_id is nullptr.

Rows having a nullptr ID string cannot be made active by this function.

If the Gtk::ComboBox::property_id_column() property of combo_box is unset or if no row has the given ID then the function does nothing and returns false.

Since gtkmm 3.0:
Deprecated:
Use set_active_id(). This method was incorrectly named.
Parameters
active_idThe ID of the row to select, or nullptr.
Returns
true if a row with a matching ID was found. If a nullptr active_id was given to unset the active row, the function always returns true.
int Gtk::ComboBox::get_active_row_number ( ) const

Returns the index of the currently active item, or -1 if there’s no active item.

If the model is a non-flat treemodel, and the active item is not an immediate child of the root of the tree, this function returns gtk_tree_path_get_indices (path)[0], where path is the Gtk::TreePath of the active item.

Since gtkmm 2.4:
Returns
An integer which is the index of the currently active item, or -1 if there’s no active item.
bool Gtk::ComboBox::get_add_tearoffs ( ) const

Gets the current value of the :add-tearoffs property.

Deprecated: 3.10

Deprecated:
No replacement available.
Returns
The current value of the :add-tearoffs property.
SensitivityType Gtk::ComboBox::get_button_sensitivity ( ) const

Returns whether the combo box sets the dropdown button sensitive or not when there are no items in the model.

Since gtkmm 2.14:
Returns
Gtk::SENSITIVITY_ON if the dropdown button is sensitive when the model is empty, Gtk::SENSITIVITY_OFF if the button is always insensitive or Gtk::SENSITIVITY_AUTO if it is only sensitive as long as the model has one item to be selected.
int Gtk::ComboBox::get_column_span_column ( ) const

Returns the column with column span information for combo_box.

Since gtkmm 2.6:
Returns
The column span column.
Entry* Gtk::ComboBox::get_entry ( )
const Entry* Gtk::ComboBox::get_entry ( ) const
Glib::ustring Gtk::ComboBox::get_entry_text ( ) const

Get the text in the entry, if there is an entry.

Since gtkmm 2.24:
int Gtk::ComboBox::get_entry_text_column ( ) const

Returns the column which combo_box is using to get the strings from to display in the internal entry.

Since gtkmm 2.24:
Returns
A column in the data source model of combo_box.
bool Gtk::ComboBox::get_focus_on_click ( ) const

Returns whether the combo box grabs focus when it is clicked with the mouse.

See set_focus_on_click().

Since gtkmm 2.6:

Deprecated: 3.20: Use Gtk::Widget::get_focus_on_click() instead

Deprecated:
Use Widget::get_focus_on_click() instead.
Returns
true if the combo box grabs focus when it is clicked with the mouse.
bool Gtk::ComboBox::get_has_entry ( ) const

Returns whether the combo box has an entry.

Since gtkmm 2.24:
Returns
Whether there is an entry in combo_box.
int Gtk::ComboBox::get_id_column ( ) const

Returns the column which combo_box is using to get string IDs for values from.

Since gtkmm 3.0:
Returns
A column in the data source model of combo_box.
Glib::RefPtr<TreeModel> Gtk::ComboBox::get_model ( )

Returns the Gtk::TreeModel which is acting as data source for combo_box.

Since gtkmm 2.4:
Returns
A Gtk::TreeModel which was passed during construction.
Glib::RefPtr<const TreeModel> Gtk::ComboBox::get_model ( ) const

Returns the Gtk::TreeModel which is acting as data source for combo_box.

Since gtkmm 2.4:
Returns
A Gtk::TreeModel which was passed during construction.
Glib::RefPtr<Atk::Object> Gtk::ComboBox::get_popup_accessible ( )

Gets the accessible object corresponding to the combo box’s popup.

This function is mostly intended for use by accessibility technologies; applications should have little use for it.

Since gtkmm 2.6:
Returns
The accessible object corresponding to the combo box’s popup.
Glib::RefPtr<const Atk::Object> Gtk::ComboBox::get_popup_accessible ( ) const

Gets the accessible object corresponding to the combo box’s popup.

This function is mostly intended for use by accessibility technologies; applications should have little use for it.

Since gtkmm 2.6:
Returns
The accessible object corresponding to the combo box’s popup.
bool Gtk::ComboBox::get_popup_fixed_width ( ) const

Gets whether the popup uses a fixed width matching the allocated width of the combo box.

Since gtkmm 3.0:
Returns
true if the popup uses a fixed width.
int Gtk::ComboBox::get_row_span_column ( ) const

Returns the column with row span information for combo_box.

Since gtkmm 2.6:
Returns
The row span column.
Glib::ustring Gtk::ComboBox::get_title ( ) const

Gets the current title of the menu in tearoff mode.

See set_add_tearoffs().

Since gtkmm 2.10:

Deprecated: 3.10

Deprecated:
No replacement available.
Returns
The menu’s title in tearoff mode. This is an internal copy of the string which must not be freed.
static GType Gtk::ComboBox::get_type ( )
static

Get the GType for this class, for use with the underlying GObject type system.

int Gtk::ComboBox::get_wrap_width ( ) const

Returns the wrap width which is used to determine the number of columns for the popup menu.

If the wrap width is larger than 1, the combo box is in table mode.

Since gtkmm 2.6:
Returns
The wrap width.
GtkComboBox* Gtk::ComboBox::gobj ( )
inline

Provides access to the underlying C GtkObject.

const GtkComboBox* Gtk::ComboBox::gobj ( ) const
inline

Provides access to the underlying C GtkObject.

virtual void Gtk::ComboBox::on_changed ( )
protectedvirtual

This is a default handler for the signal signal_changed().

ComboBox& Gtk::ComboBox::operator= ( ComboBox&&  src)
noexcept
ComboBox& Gtk::ComboBox::operator= ( const ComboBox )
delete
void Gtk::ComboBox::popdown ( )

Hides the menu or dropdown list of combo_box.

This function is mostly intended for use by accessibility technologies; applications should have little use for it.

Since gtkmm 2.4:
void Gtk::ComboBox::popup ( )

Pops up the menu or dropdown list of combo_box.

This function is mostly intended for use by accessibility technologies; applications should have little use for it.

Since gtkmm 2.4:
void Gtk::ComboBox::popup ( const Glib::RefPtr< Gdk::Device >&  device)

Pops up the menu or dropdown list of combo_box, the popup window will be grabbed so only device and its associated pointer/keyboard are the only Gdk::Devices able to send events to it.

Since gtkmm 3.0:
Parameters
deviceA Gdk::Device.
Glib::PropertyProxy< int > Gtk::ComboBox::property_active ( )

The item which is currently active.

If the model is a non-flat treemodel, and the active item is not an immediate child of the root of the tree, this property has the value gtk_tree_path_get_indices (path)[0], where path is the Gtk::TreePath of the active item.

Since gtkmm 2.4:
Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< int > Gtk::ComboBox::property_active ( ) const

The item which is currently active.

If the model is a non-flat treemodel, and the active item is not an immediate child of the root of the tree, this property has the value gtk_tree_path_get_indices (path)[0], where path is the Gtk::TreePath of the active item.

Since gtkmm 2.4:
Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< Glib::ustring > Gtk::ComboBox::property_active_id ( )

The value of the ID column of the active row.

Since gtkmm 3.0:
Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::ComboBox::property_active_id ( ) const

The value of the ID column of the active row.

Since gtkmm 3.0:
Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< bool > Gtk::ComboBox::property_add_tearoffs ( )

The add-tearoffs property controls whether generated menus have tearoff menu items.

Note that this only affects menu style combo boxes.

Since gtkmm 2.6:

Deprecated: 3.10

Deprecated:
No replacement available.
Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< bool > Gtk::ComboBox::property_add_tearoffs ( ) const

The add-tearoffs property controls whether generated menus have tearoff menu items.

Note that this only affects menu style combo boxes.

Since gtkmm 2.6:

Deprecated: 3.10

Deprecated:
No replacement available.
Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< SensitivityType > Gtk::ComboBox::property_button_sensitivity ( )

Whether the dropdown button is sensitive when the model is empty.

Since gtkmm 2.14:
Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< SensitivityType > Gtk::ComboBox::property_button_sensitivity ( ) const

Whether the dropdown button is sensitive when the model is empty.

Since gtkmm 2.14:
Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<CellArea> > Gtk::ComboBox::property_cell_area ( ) const

The Gtk::CellArea used to layout cell renderers for this combo box.

If no area is specified when creating the combo box with Gtk::ComboBox::new_with_area() a horizontally oriented Gtk::CellAreaBox will be used.

Since gtkmm 3.0:
Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< int > Gtk::ComboBox::property_column_span_column ( )

If this is set to a non-negative value, it must be the index of a column of type TYPE_INT in the model.

The values of that column are used to determine how many columns a value in the list will span.

Since gtkmm 2.4:
Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< int > Gtk::ComboBox::property_column_span_column ( ) const

If this is set to a non-negative value, it must be the index of a column of type TYPE_INT in the model.

The values of that column are used to determine how many columns a value in the list will span.

Since gtkmm 2.4:
Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< int > Gtk::ComboBox::property_entry_text_column ( )

The column in the combo box's model to associate with strings from the entry if the combo was created with Gtk::ComboBox::property_has_entry() = true.

Since gtkmm 2.24:
Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< int > Gtk::ComboBox::property_entry_text_column ( ) const

The column in the combo box's model to associate with strings from the entry if the combo was created with Gtk::ComboBox::property_has_entry() = true.

Since gtkmm 2.24:
Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< bool > Gtk::ComboBox::property_focus_on_click ( )

Whether the combo box grabs focus when it is clicked with the mouse.

Deprecated:
Use Widget::property_focus_on_click() instead.
Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< bool > Gtk::ComboBox::property_focus_on_click ( ) const

Whether the combo box grabs focus when it is clicked with the mouse.

Deprecated:
Use Widget::property_focus_on_click() instead.
Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< bool > Gtk::ComboBox::property_has_entry ( ) const

Whether the combo box has an entry.

Since gtkmm 2.24:
Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< bool > Gtk::ComboBox::property_has_frame ( )

The has-frame property controls whether a frame is drawn around the entry.

Since gtkmm 2.6:
Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< bool > Gtk::ComboBox::property_has_frame ( ) const

The has-frame property controls whether a frame is drawn around the entry.

Since gtkmm 2.6:
Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< int > Gtk::ComboBox::property_id_column ( )

The column in the combo box's model that provides string IDs for the values in the model, if != -1.

Since gtkmm 3.0:
Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< int > Gtk::ComboBox::property_id_column ( ) const

The column in the combo box's model that provides string IDs for the values in the model, if != -1.

Since gtkmm 3.0:
Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< Glib::RefPtr<TreeModel> > Gtk::ComboBox::property_model ( )

The model from which the combo box takes the values shown in the list.

Since gtkmm 2.4:
Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<TreeModel> > Gtk::ComboBox::property_model ( ) const

The model from which the combo box takes the values shown in the list.

Since gtkmm 2.4:
Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< bool > Gtk::ComboBox::property_popup_fixed_width ( )

Whether the popup's width should be a fixed width matching the allocated width of the combo box.

Since gtkmm 3.0:
Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< bool > Gtk::ComboBox::property_popup_fixed_width ( ) const

Whether the popup's width should be a fixed width matching the allocated width of the combo box.

Since gtkmm 3.0:
Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< bool > Gtk::ComboBox::property_popup_shown ( ) const

Whether the combo boxes dropdown is popped up.

Note that this property is mainly useful, because it allows you to connect to notify::popup-shown.

Since gtkmm 2.10:
Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< int > Gtk::ComboBox::property_row_span_column ( )

If this is set to a non-negative value, it must be the index of a column of type TYPE_INT in the model.

The values of that column are used to determine how many rows a value in the list will span. Therefore, the values in the model column pointed to by this property must be greater than zero and not larger than wrap-width.

Since gtkmm 2.4:
Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< int > Gtk::ComboBox::property_row_span_column ( ) const

If this is set to a non-negative value, it must be the index of a column of type TYPE_INT in the model.

The values of that column are used to determine how many rows a value in the list will span. Therefore, the values in the model column pointed to by this property must be greater than zero and not larger than wrap-width.

Since gtkmm 2.4:
Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< Glib::ustring > Gtk::ComboBox::property_tearoff_title ( )

A title that may be displayed by the window manager when the popup is torn-off.

Since gtkmm 2.10:

Deprecated: 3.10

Deprecated:
No replacement available.
Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::ComboBox::property_tearoff_title ( ) const

A title that may be displayed by the window manager when the popup is torn-off.

Since gtkmm 2.10:

Deprecated: 3.10

Deprecated:
No replacement available.
Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< int > Gtk::ComboBox::property_wrap_width ( )

If wrap-width is set to a positive value, the list will be displayed in multiple columns, the number of columns is determined by wrap-width.

Since gtkmm 2.4:
Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< int > Gtk::ComboBox::property_wrap_width ( ) const

If wrap-width is set to a positive value, the list will be displayed in multiple columns, the number of columns is determined by wrap-width.

Since gtkmm 2.4:
Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
void Gtk::ComboBox::set_active ( int  index)

Sets the active item of combo_box to be the item at index.

Since gtkmm 2.4:
Parameters
indexAn index in the model passed during construction, or -1 to have no active item.
void Gtk::ComboBox::set_active ( const TreeModel::iterator iter)

Sets the current active item to be the one referenced by iter, or unsets the active item if iter is nullptr.

Since gtkmm 2.4:
Parameters
iterThe Gtk::TreeIter, or nullptr.
bool Gtk::ComboBox::set_active_id ( const Glib::ustring active_id)

Changes the active row of the combo box to the one that has an ID equal to active_id.

If property_id_column() is unset or if no row has the given ID then the function does nothing and returns false.

Parameters
active_idThe ID of the row that should be set to active.
Returns
true if a row with a matching ID was found.
Since gtkmm 3.6:
void Gtk::ComboBox::set_add_tearoffs ( bool  add_tearoffs = true)

Sets whether the popup menu should have a tearoff menu item.

Since gtkmm 2.6:

Deprecated: 3.10

Deprecated:
No replacement available.
Parameters
add_tearoffstrue to add tearoff menu items.
void Gtk::ComboBox::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).

Since gtkmm 2.14:
Parameters
sensitivitySpecify the sensitivity of the dropdown button.
void Gtk::ComboBox::set_column_span_column ( int  column_span)

Sets the column with column span information for combo_box to be column_span.

The column span column contains integers which indicate how many columns an item should span.

Since gtkmm 2.4:
Parameters
column_spanA column in the model passed during construction.
void Gtk::ComboBox::set_entry_text_column ( const TreeModelColumnBase text_column) const

Sets the model column which combo_box should use to get strings from to be text_column.

The column text_column in the model of combo_box must be of type TYPE_STRING.

This is only relevant if combo_box has been created with Gtk::ComboBox::property_has_entry() as true.

Since gtkmm 2.24:
Parameters
text_columnA column in model to get the strings from for the internal entry.
void Gtk::ComboBox::set_entry_text_column ( int  text_column)

Sets the model column which combo_box should use to get strings from to be text_column.

The column text_column in the model of combo_box must be of type TYPE_STRING.

This is only relevant if combo_box has been created with Gtk::ComboBox::property_has_entry() as true.

Since gtkmm 2.24:
Parameters
text_columnA column in model to get the strings from for the internal entry.
void Gtk::ComboBox::set_focus_on_click ( bool  focus_on_click = true)

Sets whether the combo box will grab focus when it is clicked with the mouse.

Making mouse clicks not grab focus is useful in places like toolbars where you don’t want the keyboard focus removed from the main area of the application.

Since gtkmm 2.6:

Deprecated: 3.20: Use Gtk::Widget::set_focus_on_click() instead

Deprecated:
Use Widget::set_focus_on_click() instead.
Parameters
focus_on_clickWhether the combo box grabs focus when clicked with the mouse.
void Gtk::ComboBox::set_id_column ( int  id_column)

Sets the model column which combo_box should use to get string IDs for values from.

The column id_column in the model of combo_box must be of type TYPE_STRING.

Since gtkmm 3.0:
Parameters
id_columnA column in model to get string IDs for values from.
void Gtk::ComboBox::set_model ( const Glib::RefPtr< TreeModel >&  model)

Sets the model used by combo_box to be model.

Will unset a previously set model (if applicable). Use unset_model() to unset the old model.

Note that this function does not clear the cell renderers, you have to call Gtk::CellLayout::clear() yourself if you need to set up different cell renderers for the new model.

Since gtkmm 2.4:
Parameters
modelA Gtk::TreeModel.
void Gtk::ComboBox::set_popup_fixed_width ( bool  fixed = true)

Specifies whether the popup’s width should be a fixed width matching the allocated width of the combo box.

Since gtkmm 3.0:
Parameters
fixedWhether to use a fixed popup width.
void Gtk::ComboBox::set_row_separator_func ( const SlotRowSeparator slot)

Sets the row separator function, which is used to determine whether a row should be drawn as a separator.

See also unset_row_separator_func().

Parameters
slotThe callback.
void Gtk::ComboBox::set_row_span_column ( int  row_span)

Sets the column with row span information for combo_box to be row_span.

The row span column contains integers which indicate how many rows an item should span.

Since gtkmm 2.4:
Parameters
row_spanA column in the model passed during construction.
void Gtk::ComboBox::set_title ( const Glib::ustring title)

Sets the menu’s title in tearoff mode.

Since gtkmm 2.10:

Deprecated: 3.10

Deprecated:
No replacement available.
Parameters
titleA title for the menu in tearoff mode.
void Gtk::ComboBox::set_wrap_width ( int  width)

Sets the wrap width of combo_box to be width.

The wrap width is basically the preferred number of columns when you want the popup to be layed out in a table.

Since gtkmm 2.4:
Parameters
widthPreferred number of columns.
Glib::SignalProxy< void > Gtk::ComboBox::signal_changed ( )
Slot Prototype:
void on_my_changed()

The changed signal is emitted when the active item is changed. The can be due to the user selecting a different item from the list, or due to a call to Gtk::ComboBox::set_active_iter(). It will also be emitted while typing into the entry of a combo box with an entry.

Since gtkmm 2.4:
Glib::SignalProxy< Glib::ustring,const TreeModel::Path& > Gtk::ComboBox::signal_format_entry_text ( )
Slot Prototype:
Glib::ustring on_my_format_entry_text(const TreeModel::Path& path)

For combo boxes that are created with an entry (See GtkComboBox:has-entry).

A signal which allows you to change how the text displayed in a combo box's entry is displayed.

Connect a signal handler which returns an allocated string representing path. That string will then be used to set the text in the combo box's entry. The default signal handler uses the text from the GtkComboBox::entry-text-column model column.

Here's an example signal handler which fetches data from the model and displays it in the entry.

[C example ellipted]

Since gtkmm 3.4:
Parameters
pathThe GtkTreePath string from the combo box's current model to format text for.
Returns
A newly allocated string representing path for the current GtkComboBox model.
void Gtk::ComboBox::unset_active ( )

Causes no item to be active.

See also set_active().

void Gtk::ComboBox::unset_model ( )

Remove the model from the ComboBox.

See also
set_model().
Since gtkmm 2.16:
void Gtk::ComboBox::unset_row_separator_func ( )

Causes no separators to be drawn.

Friends And Related Function Documentation

Gtk::ComboBox* wrap ( GtkComboBox *  object,
bool  take_copy = false 
)
related

A Glib::wrap() method for this object.

Parameters
objectThe C instance.
take_copyFalse if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns
A C++ instance that wraps this C instance.