gtkmm: Gtk::ComboBox Class Reference
A widget used to choose from a list of items. More...
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 | |
virtual | ~ComboBox () |
GtkComboBox* | gobj () |
Provides access to the underlying C GtkObject. More... | |
const GtkComboBox* | gobj () const |
Provides access to the underlying C GtkObject. More... | |
ComboBox () | |
ComboBox (const Glib::RefPtr< TreeModel >& model) | |
Creates a new ComboBox with the model initialized to model. More... | |
ComboBox (bool has_entry) | |
Creates a new empty #GtkComboBox, optionally with an entry. More... | |
ComboBox (const Glib::RefPtr< TreeModel >& model, bool has_entry) | |
Creates a new ComboBox with the model initialized to model. 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< TreeModel > | get_model () |
Returns the Gtk::TreeModel which is acting as data source for combo_box. More... | |
Glib::RefPtr< const TreeModel > | get_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 | popup () |
Pops up the menu or dropdown list of combo_box. More... | |
void | popdown () |
Hides the menu or dropdown list of combo_box. More... | |
Glib::RefPtr< Atk::Object > | get_popup_accessible () |
Gets the accessible object corresponding to the combo box's popup. More... | |
Glib::RefPtr< const Atk::Object > | get_popup_accessible () const |
Gets the accessible object corresponding to the combo box's popup. More... | |
Entry* | get_entry () |
const Entry* | get_entry () const |
Glib::PropertyProxy< Glib::RefPtr< TreeModel > > | property_model () |
The model for the combo box. More... | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< TreeModel > > | property_model () const |
The model for the combo box. More... | |
Glib::PropertyProxy< int > | property_wrap_width () |
Wrap width for laying out the items in a grid. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_wrap_width () const |
Wrap width for laying out the items in a grid. More... | |
Glib::PropertyProxy< int > | property_row_span_column () |
TreeModel column containing the row span values. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_row_span_column () const |
TreeModel column containing the row span values. More... | |
Glib::PropertyProxy< int > | property_column_span_column () |
TreeModel column containing the column span values. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_column_span_column () const |
TreeModel column containing the column span values. 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 () |
Whether dropdowns should have a tearoff menu item. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_add_tearoffs () const |
Whether dropdowns should have a tearoff menu item. More... | |
Glib::PropertyProxy< bool > | property_has_frame () |
Whether the combo box draws a frame around the child. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_has_frame () const |
Whether the combo box draws a frame around the child. 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::ustring > | property_tearoff_title () |
A title that may be displayed by the window manager when the popup is torn-off. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_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's dropdown is shown. More... | |
Glib::PropertyProxy< SensitivityType > | property_button_sensitivity () |
Whether the dropdown button is sensitive when the model is empty. More... | |
Glib::PropertyProxy_ReadOnly< SensitivityType > | property_button_sensitivity () const |
Whether the dropdown button is sensitive when the model is empty. More... | |
Glib::SignalProxy< void > | signal_changed () |
The changed signal gets emitted when the active item is changed. More... | |
Public Member Functions inherited from Gtk::Bin | |
virtual | ~Bin () |
GtkBin* | gobj () |
Provides access to the underlying C GtkObject. More... | |
const GtkBin* | gobj () const |
Provides access to the underlying C GtkObject. More... | |
Gtk::Widget* | get_child () |
Gets the child of the Gtk::Bin, or nullptr if the bin contains no child widget. More... | |
const Gtk::Widget* | get_child () const |
Gets the child of the Gtk::Bin, or nullptr if the bin contains no child widget. More... | |
void | remove () |
Remove the contained object Since this can only hold one object it is not necessary to specify which object to remove like other containers. 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, AlignmentEnum x_align, AlignmentEnum y_align=ALIGN_CENTER) |
Add a Label object. More... | |
void | add_pixmap (const Glib::RefPtr< Gdk::Pixmap >& pixmap, const Glib::RefPtr< Gdk::Bitmap >& mask) |
Add an Image object. More... | |
void | add_pixlabel (const Glib::RefPtr< Gdk::Pixmap >& pixmap, const Glib::RefPtr< Gdk::Bitmap >& mask, const Glib::ustring& label, double x_align=0.5, double y_align=0.5) |
Add Image and Label objects. More... | |
void | add_pixlabel (const Glib::ustring& pixfile, const Glib::ustring& label, double x_align=0.5, double y_align=0.5) |
Add Image and Label objects. More... | |
Public Member Functions inherited from Gtk::Container | |
virtual | ~Container () |
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) |
void | remove (Widget& widget) |
Removes widget from 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 This is largely an internal used mainly for things like creating duplicates of internal lists and other such operations. More... | |
Glib::ListHandle< Widget* > | get_children () |
(internal) Operate on contained items (see foreach()) More... | |
Glib::ListHandle< const Widget* > | get_children () const |
Returns the container's non-internal children. More... | |
void | propagate_expose (Widget& child, GdkEventExpose*event) |
When a container receives an expose event, it must send synthetic expose events to all children that don't have their own Gdk::Windows. More... | |
void | set_focus_chain (const Glib::ListHandle< Widget* >& focusable_widgets) |
Sets a focus chain, overriding the one computed automatically by GTK+. More... | |
bool | has_focus_chain () const |
Glib::ListHandle< Widget* > | get_focus_chain () |
Glib::ListHandle< 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... | |
void | set_focus_vadjustment (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... | |
Adjustment* | get_focus_vadjustment () |
Retrieves the vertical focus adjustment for the container. More... | |
const Adjustment* | get_focus_vadjustment () const |
Retrieves the vertical focus adjustment for the container. More... | |
void | set_focus_hadjustment (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... | |
Adjustment* | get_focus_hadjustment () |
Retrieves the horizontal focus adjustment for the container. More... | |
const Adjustment* | get_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... | |
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 | |
virtual | ~Widget () |
GtkWidget* | gobj () |
Provides access to the underlying C GtkObject. More... | |
const GtkWidget* | gobj () const |
Provides access to the underlying C GtkObject. More... | |
bool | set_scroll_adjustments (Adjustment& hadjustment, Adjustment& vadjustment) |
For widgets that support scrolling, sets the scroll adjustments and returns true . 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 | hide_all () |
Recursively hides a widget and any child widgets. 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) |
Invalidates the rectangular area of widget defined by x, y, width and height by calling gdk_window_invalidate_rect() on the widget's window and all its child windows. More... | |
void | queue_resize () |
This function is only for use in widget implementations. More... | |
Requisition | size_request () const |
This function is typically used when implementing a Gtk::Container subclass. More... | |
void | size_request (const Requisition& requisition) |
This function is typically used when implementing a Gtk::Container subclass. 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 | 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* event) |
Rarely-used function. More... | |
int | send_expose (GdkEvent*event) |
Very rarely-used function. More... | |
bool | send_focus_change (GdkEvent*event) |
Sends the focus change 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... | |
Gdk::Region | region_intersect (const Gdk::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_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 | 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... | |
void | grab_focus () |
Causes widget to have the keyboard focus for the Gtk::Window it's inside. 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 | 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 alyways treated as default widget withing 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... | |
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 gtkrc 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_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 sensntive. 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... | |
void | set_has_window (bool has_window=true) |
Specifies whether widget has a Gdk::Window of its own. 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_expose_event() handler. More... | |
bool | get_app_paintable () const |
Determines whether the application intends to draw on the widget in an Gtk::Widget::signal_expose_event() 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 is_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... | |
void | set_window (const Glib::RefPtr< Gdk::Window >& window) |
Sets a widget's window. More... | |
Glib::RefPtr< Gdk::Window > | get_window () |
Returns the widget's window if it is realized, nullptr otherwise. More... | |
Glib::RefPtr< const Gdk::Window > | get_window () const |
Returns the widget's window if it is realized, nullptr otherwise. More... | |
Allocation | get_allocation () const |
Retrieves the widget's location. More... | |
void | set_allocation (const Allocation& allocation) |
Sets the widget's allocation. More... | |
Container* | get_parent () |
Returns the parent container of widget. More... | |
const Container* | get_parent () const |
Returns the parent container of widget. More... | |
Glib::RefPtr< Gdk::Window > | get_parent_window () |
Gets widget's parent window. More... | |
Glib::RefPtr< const Gdk::Window > | get_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 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_extension_events (Gdk::ExtensionMode mode) |
Sets the extension events mask to mode. More... | |
Gdk::ExtensionMode | get_extension_events () const |
Retrieves the extension events the widget will receive; see gdk_input_set_extension_events(). More... | |
Container* | get_toplevel () |
This function returns the topmost widget in the container hierarchy widget is a part of. More... | |
const Container* | get_toplevel () const |
This function returns the topmost widget in the container hierarchy widget is a part of. More... | |
Widget* | get_ancestor (GType widget_type) |
Gets the first ancestor of widget with type widget_type. More... | |
const Widget* | get_ancestor (GType widget_type) const |
Gets the first ancestor of widget with type widget_type. More... | |
Glib::RefPtr< Gdk::Colormap > | get_colormap () |
Gets the colormap that will be used to render widget. More... | |
Glib::RefPtr< Gdk::Visual > | get_visual () |
Gets the visual that will be used to render widget. More... | |
Glib::RefPtr< Gdk::Screen > | get_screen () |
Get the Gdk::Screen from the toplevel window associated with this widget. More... | |
Glib::RefPtr< const Gdk::Screen > | get_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... | |
Glib::RefPtr< Gdk::Display > | get_display () |
Get the Gdk::Display for the toplevel window associated with this widget. More... | |
Glib::RefPtr< const Gdk::Display > | get_display () const |
Get the Gdk::Display for the toplevel window associated with this widget. More... | |
Glib::RefPtr< Gdk::Window > | get_root_window () |
Get the root window where this widget is located. More... | |
Glib::RefPtr< const Gdk::Window > | get_root_window () const |
Get the root window where this widget is located. More... | |
Glib::RefPtr< Settings > | get_settings () |
Gets the settings object holding the settings (global property settings, RC file information, etc) used for this widget. More... | |
Glib::RefPtr< Clipboard > | get_clipboard (const Glib::ustring& selection) |
Returns the clipboard object for the given selection to be used with widget. More... | |
Glib::RefPtr< const Clipboard > | get_clipboard (const Glib::ustring& selection) const |
Returns the clipboard object for the given selection to be used with widget. More... | |
Glib::RefPtr< Gdk::Pixmap > | get_snapshot (Gdk::Rectangle& clip_rect) const |
Create a Gdk::Pixmap of the contents of the widget and its children. More... | |
Glib::RefPtr< Gdk::Pixmap > | get_snapshot () const |
Create a Gdk::Pixmap of the contents of the widget and its children. More... | |
Glib::RefPtr< Atk::Object > | get_accessible () |
Returns the accessible object that describes the widget to an assistive technology. More... | |
Glib::RefPtr< const Atk::Object > | get_accessible () const |
Returns the accessible object that describes the widget to an assistive technology. More... | |
void | set_colormap (const Glib::RefPtr< const Gdk::Colormap >& colormap) |
Sets the colormap for the widget to the given value. More... | |
Gdk::EventMask | get_events () const |
Returns the event mask for the widget (a bitfield containing flags from the Gdk::EventMask enumeration). 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... | |
bool | has_rc_style () const |
Determines if the widget style has been looked up through the rc mechanism. More... | |
void | set_style (const Glib::RefPtr< Style >& style) |
Sets the Gtk::Style for a widget ( widget->style). More... | |
void | unset_style () |
void | ensure_style () |
Ensures that widget has a style ( widget->style). More... | |
Glib::RefPtr< Style > | get_style () |
Simply an accessor function that returns widget->style. More... | |
Glib::RefPtr< const Style > | get_style () const |
Simply an accessor function that returns widget->style. More... | |
void | modify_style (const Glib::RefPtr< RcStyle >& style) |
Modifies style values on the widget. More... | |
Glib::RefPtr< RcStyle > | get_modifier_style () |
Returns the current modifier style for the widget. More... | |
Glib::RefPtr< const RcStyle > | get_modifier_style () const |
Returns the current modifier style for the widget. More... | |
void | modify_fg (StateType state, const Gdk::Color& color) |
Sets the foreground color for a widget in a particular state. More... | |
void | modify_bg (StateType state, const Gdk::Color& color) |
Sets the background color for a widget in a particular state. More... | |
void | modify_bg_pixmap (StateType state, const Glib::ustring& pixmap_name) |
void | modify_text (StateType state, const Gdk::Color& color) |
Sets the text color for a widget in a particular state. More... | |
void | modify_base (StateType state, const Gdk::Color& color) |
Sets the base color for a widget in a particular state. More... | |
void | modify_cursor (const Gdk::Color& primary, const Gdk::Color& secondary) |
Sets the cursor color to use in a widget, overriding the cursor_color and secondary_cursor_color style properties. More... | |
void | unset_cursor () |
See modify_cursor(). More... | |
void | modify_font (const Pango::FontDescription& font_desc) |
Sets the font to use for a widget. More... | |
void | unset_fg (StateType state) |
Undo the effect of previous calls to modify_fg() for a particular state. More... | |
void | unset_bg (StateType state) |
Undo the effect of previous calls to modify_bg() for a particular state. More... | |
void | unset_text (StateType state) |
Undo the effect of previous calls to modify_text() for a particular state. More... | |
void | unset_base (StateType state) |
Undo the effect of previous calls to modify_base() for a particular state. More... | |
void | unset_font () |
Undo the effect of previous calls to modify_font() for a particular state. More... | |
template<class PropertyType > | |
void | get_style_property (const Glib::ustring& the_property_name, PropertyType& value) const |
Glib::RefPtr< Pango::Context > | create_pango_context () |
Creates a new Pango::Context with the appropriate font map, font description, and base direction for drawing text for this widget. More... | |
Glib::RefPtr< Pango::Context > | get_pango_context () |
Gets a Pango::Context with the appropriate font map, font description, and base direction for this widget. More... | |
Glib::RefPtr< Pango::Layout > | create_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::Pixbuf > | render_icon (const StockID& stock_id, IconSize size, const Glib::ustring& detail=Glib::ustring()) |
A convenience function that uses the theme engine and RC file settings for the 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 | reset_rc_styles () |
Reset the styles of widget and all descendents, so when they are looked up again, they get the correct values for the currently loaded RC file settings. More... | |
void | set_direction (TextDirection dir) |
Sets the reading direction on a particular widget. More... | |
TextDirection | get_direction () |
Gets the reading direction for a particular widget. More... | |
TextDirection | get_direction () const |
Gets the reading direction for a particular widget. More... | |
void | shape_combine_mask (const Glib::RefPtr< const Gdk::Bitmap >& shape_mask, int offset_x, int offset_y) |
Sets a shape for this widget's GDK window. More... | |
void | unset_shape_combine_mask () |
void | input_shape_combine_mask (const Glib::RefPtr< const Gdk::Bitmap >& shape_mask, int offset_x, int offset_y) |
Sets an input shape for this widget's GDK window. More... | |
void | unset_input_shape_combine_mask () |
void | reset_shapes () |
Recursively resets the shape on this widget and its descendants. More... | |
void | path (Glib::ustring& path, Glib::ustring& path_reversed) |
Compute a widget's path of the form "GtkWindow.MyLabel". More... | |
void | class_path (Glib::ustring&path, Glib::ustring& path_reversed) |
Glib::ListHandle< Widget* > | list_mnemonic_labels () |
Returns a newly allocated list of the widgets, normally labels, for which this widget is a the target of a mnemonic (see for example, Gtk::Label::set_mnemonic_widget()). More... | |
Glib::ListHandle< const Widget* > | list_mnemonic_labels () const |
Returns a newly allocated list of the widgets, normally labels, for which this widget is a 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, Glib::ustring& target, guint32 time) |
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 ArrayHandle_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< TargetList > | drag_dest_get_target_list () |
Returns the list of targets this widget can accept from drag-and-drop. More... | |
Glib::RefPtr< const TargetList > | drag_dest_get_target_list () const |
Returns the list of targets this widget can accept from drag-and-drop. More... | |
void | drag_dest_set_target_list (const Glib::RefPtr< TargetList >& target_list) |
Sets the target types that this widget can accept from drag-and-drop. More... | |
void | drag_dest_add_text_targets () |
Add the text targets supported by Gtk::Selection to the target list of the drag destination. More... | |
void | drag_dest_add_image_targets () |
Add the image targets supported by Gtk::Selection to the target list of the drag destination. More... | |
void | drag_dest_add_uri_targets () |
Add the URI targets supported by Gtk::Selection to the target list of the drag destination. More... | |
void | drag_source_set (const ArrayHandle_TargetEntry& targets, Gdk::ModifierType start_button_mask=Gdk::MODIFIER_MASK, Gdk::DragAction actions=Gdk::ACTION_COPY) |
void | drag_source_unset () |
void | drag_source_set_icon (const Glib::RefPtr< Gdk::Colormap >& colormap, const Glib::RefPtr< Gdk::Pixmap >& pixmap, const Glib::RefPtr< Gdk::Bitmap >& mask) |
Sets the icon that will be used for drags from a particular widget from a pixmap/mask. 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::Selection to the target list of the drag source. More... | |
void | drag_source_add_uri_targets () |
Add the URI targets supported by Gtk::Selection to the target list of the drag source. More... | |
void | drag_source_add_image_targets () |
Add the writable image targets supported by Gtk::Selection to the target list of the drag source. More... | |
Glib::RefPtr< Gdk::DragContext > | drag_begin (const Glib::RefPtr< TargetList >& targets, Gdk::DragAction actions, int button, GdkEvent*event) |
Initiates a drag on the source side. More... | |
bool | drag_check_threshold (int start_x, int start_y, int current_x, int current_y) |
Checks to see if a mouse drag starting at ( start_x, start_y) and ending at ( current_x, current_y) has passed the GTK+ drag threshold, and thus should trigger the beginning of a drag-and-drop operation. More... | |
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 GtkWidget:no-show-all property, which determines whether calls to show_all() and hide_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() and hide_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 (Glib::RefPtr< Gdk::Drawable > drawable, const Gdk::Rectangle& area, const Gdk::Rectangle& location, bool is_primary, TextDirection direction, bool draw_arrow=true) |
void | set_tooltip_window (Window& widget) |
Replaces the default, usually yellow, window used for displaying tooltips with widget. More... | |
Window* | get_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... | |
bool | has_no_window () const |
bool | is_realized () const |
bool | is_mapped () const |
bool | is_toplevel () const |
bool | is_drawable () const |
bool | is_visible () const |
bool | sensitive () const |
bool | app_paintable () const |
bool | receives_default () const |
bool | double_buffered () const |
bool | parent_sensitive () const |
bool | rc_style () const |
bool | is_composite_child () const |
Returns trye if the widget is a composite child of its parent. More... | |
WidgetFlags | get_flags () const |
void | set_flags (WidgetFlags flags) |
void | unset_flags (WidgetFlags flags) |
Gtk::StateType | get_saved_state () const |
int | get_width () const |
int | get_height () const |
bool | is_composited () const |
Whether widget can rely on having its alpha channel drawn correctly. More... | |
Glib::RefPtr< Action > | get_action () |
Returns the Gtk::Action that widget is a proxy for. More... | |
Glib::RefPtr< const Action > | get_action () const |
Returns the Gtk::Action that widget is a proxy for. More... | |
Requisition | get_requisition () const |
Retrieves the widget's requisition. 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, Requisition* > | signal_size_request () |
Glib::SignalProxy< void, Allocation& > | signal_size_allocate () |
Glib::SignalProxy< void, Gtk::StateType > | signal_state_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, const Glib::RefPtr< Gtk::Style >& > | signal_style_changed () |
The style-set signal is emitted when a new style has been set on a widget. More... | |
Glib::SignalProxy< void, TextDirection > | signal_direction_changed () |
Glib::SignalProxy< void, bool > | signal_grab_notify () |
Glib::SignalProxy< void, GParamSpec* > | signal_child_notify () |
The ::child-notify signal is emitted for each child property that has changed on an object. More... | |
Glib::SignalProxy< bool, bool > | signal_mnemonic_activate () |
Glib::SignalProxy< void > | signal_grab_focus () |
Glib::SignalProxy< bool, DirectionType > | signal_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 () |
The delete_event signal is emitted if a user requests that a toplevel window is closed. More... | |
Glib::SignalProxy< bool, GdkEventExpose* > | signal_expose_event () |
Event triggered by window requiring a refresh. More... | |
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, GdkEventClient* > | signal_client_event () |
Glib::SignalProxy< bool, GdkEventAny* > | signal_no_expose_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 () |
The drag_begin signal is emitted on the drag source when a drag is started. More... | |
Glib::SignalProxy< void, const Glib::RefPtr< Gdk::DragContext >& > | signal_drag_end () |
The drag_end signal is emitted on the drag source when a drag is finished. More... | |
Glib::SignalProxy< void, const Glib::RefPtr< Gdk::DragContext >&, SelectionData&, guint, guint > | signal_drag_data_get () |
The drag_data_get signal is emitted on the drag source when the drop site requests the data which is dragged. More... | |
Glib::SignalProxy< void, const Glib::RefPtr< Gdk::DragContext >& > | signal_drag_data_delete () |
The drag_data_delete signal is emitted on the drag source when a drag with the action Gdk::ACTION_MOVE is successfully completed. More... | |
Glib::SignalProxy< bool, const Glib::RefPtr< Gdk::DragContext >&, DragResult > | signal_drag_failed () |
Glib::SignalProxy< void, const Glib::RefPtr< Gdk::DragContext >&, guint > | signal_drag_leave () |
The drag_leave signal is emitted on the drop site when the cursor leaves the widget. More... | |
Glib::SignalProxy< bool, const Glib::RefPtr< Gdk::DragContext >&, int, int, guint > | signal_drag_motion () |
The drag_motion signal is emitted on the drop site when the user moves the cursor over the widget during a drag. More... | |
Glib::SignalProxy< bool, const Glib::RefPtr< Gdk::DragContext >&, int, int, guint > | signal_drag_drop () |
The drag_drop signal is emitted on the drop site when the user drops the data onto the widget. More... | |
Glib::SignalProxy< void, const Glib::RefPtr< Gdk::DragContext >&, int, int, const SelectionData&, guint, guint > | signal_drag_data_received () |
The drag_data_received signal is emitted on the drop site when the dragged data has been received. More... | |
Glib::SignalProxy< Glib::RefPtr< Atk::Object > > | signal_get_accessible () |
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::PropertyProxy< Glib::ustring > | property_name () |
The name of the widget. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_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_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::EventMask > | property_events () |
The event mask that decides what kind of GdkEvents this widget gets. More... | |
Glib::PropertyProxy_ReadOnly< Gdk::EventMask > | property_events () const |
The event mask that decides what kind of GdkEvents this widget gets. More... | |
Glib::PropertyProxy< Gdk::ExtensionMode > | property_extension_events () |
The mask that decides what kind of extension events this widget gets. More... | |
Glib::PropertyProxy_ReadOnly< Gdk::ExtensionMode > | property_extension_events () const |
The mask that decides what kind of extension events this widget gets. More... | |
Glib::PropertyProxy< bool > | property_has_tooltip () |
Whether this widget has a tooltip. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_has_tooltip () const |
Whether this widget has a tooltip. More... | |
Glib::PropertyProxy< Glib::ustring > | property_tooltip_markup () |
The contents of the tooltip for this widget. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_tooltip_markup () const |
The contents of the tooltip for this widget. More... | |
Glib::PropertyProxy< Glib::ustring > | property_tooltip_text () |
The contents of the tooltip for this widget. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_tooltip_text () const |
The contents of the tooltip for this widget. More... | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Window > > | property_window () const |
The widget's window if it is realized. 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 or not the widget is double buffered. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_double_buffered () const |
Whether or not the widget is double buffered. More... | |
Public Member Functions inherited from Gtk::Object | |
virtual | ~Object () |
GtkObject* | gobj () |
Provides access to the underlying C GtkObject. More... | |
const GtkObject* | gobj () const |
Provides access to the underlying C GtkObject. More... | |
Glib::PropertyProxy< void* > | property_user_data () |
Anonymous User Data Pointer. More... | |
Glib::PropertyProxy_ReadOnly< void* > | property_user_data () const |
Anonymous User Data Pointer. More... | |
Public Member Functions inherited from Glib::Object | |
Object (const Object &)=delete | |
Object & | operator= (const Object &)=delete |
Object (Object &&src) noexcept | |
Object & | operator= (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::Object > | wrap (GObject *object, bool take_copy=false) |
Public Member Functions inherited from Glib::ObjectBase | |
ObjectBase (const ObjectBase &)=delete | |
ObjectBase & | operator= (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 () |
trackable & | operator= (const trackable &src) |
trackable & | operator= (trackable &&src) |
void | remove_destroy_notify_callback (void *data) const |
Public Member Functions inherited from Atk::Implementor | |
Implementor (Implementor &&src) noexcept | |
Implementor & | operator= (Implementor &&src) noexcept |
~Implementor () noexceptoverride | |
AtkImplementor * | gobj () |
const AtkImplementor * | gobj () const |
Glib::RefPtr< Atk::Implementor > | wrap (AtkImplementor *object, bool take_copy=false) |
Public Member Functions inherited from Glib::Interface | |
Interface () | |
Interface (Interface &&src) noexcept | |
Interface & | operator= (Interface &&src) noexcept |
Interface (const Glib::Interface_Class &interface_class) | |
Interface (GObject *castitem) | |
~Interface () noexceptoverride | |
Interface (const Interface &)=delete | |
Interface & | operator= (const Interface &)=delete |
GObject * | gobj () |
const GObject * | gobj () const |
Public Member Functions inherited from Gtk::CellLayout | |
CellLayout (CellLayout&& src) noexcept | |
CellLayout& | operator= (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... | |
Glib::ListHandle< CellRenderer* > | get_cells () |
Return value: a list of cell renderers. More... | |
Glib::ListHandle< const CellRenderer* > | get_cells () const |
Return value: a list of cell renderers. 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... | |
template<class T_ModelColumnType > | |
void | pack_start (const TreeModelColumn< T_ModelColumnType >& column, bool expand) |
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 |
virtual void | forall_vfunc (gboolean include_internals, GtkCallback callback, gpointer callback_data) |
virtual char* | composite_name_vfunc (GtkWidget* child) |
virtual void | set_child_property_vfunc (GtkWidget* child, guint property_id, const GValue* value, GParamSpec* pspec) |
virtual void | get_child_property_vfunc (GtkWidget* child, guint property_id, GValue* value, GParamSpec* pspec) const |
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< ResizeMode > | property_resize_mode () |
Specify how resize events are handled. More... | |
Glib::PropertyProxy_ReadOnly< ResizeMode > | property_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_request (Requisition* requisition) |
This is a default handler for the signal signal_size_request(). 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_changed (const Glib::RefPtr< Gtk::Style >& previous_style) |
This is a default handler for the signal signal_style_changed(). 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*event) |
This is a default handler for the signal signal_event(). More... | |
virtual bool | on_button_press_event (GdkEventButton*event) |
This is a default handler for the signal signal_button_press_event(). More... | |
virtual bool | on_button_release_event (GdkEventButton*event) |
This is a default handler for the signal signal_button_release_event(). More... | |
virtual bool | on_scroll_event (GdkEventScroll*event) |
This is a default handler for the signal signal_scroll_event(). More... | |
virtual bool | on_motion_notify_event (GdkEventMotion*event) |
This is a default handler for the signal signal_motion_notify_event(). More... | |
virtual bool | on_delete_event (GdkEventAny*event) |
This is a default handler for the signal signal_delete_event(). More... | |
virtual bool | on_expose_event (GdkEventExpose*event) |
This is a default handler for the signal signal_expose_event(). More... | |
virtual bool | on_key_press_event (GdkEventKey*event) |
This is a default handler for the signal signal_key_press_event(). More... | |
virtual bool | on_key_release_event (GdkEventKey*event) |
This is a default handler for the signal signal_key_release_event(). More... | |
virtual bool | on_enter_notify_event (GdkEventCrossing*event) |
This is a default handler for the signal signal_enter_notify_event(). More... | |
virtual bool | on_leave_notify_event (GdkEventCrossing*event) |
This is a default handler for the signal signal_leave_notify_event(). More... | |
virtual bool | on_configure_event (GdkEventConfigure*event) |
This is a default handler for the signal signal_configure_event(). More... | |
virtual bool | on_focus_in_event (GdkEventFocus*event) |
This is a default handler for the signal signal_focus_in_event(). More... | |
virtual bool | on_focus_out_event (GdkEventFocus*event) |
This is a default handler for the signal signal_focus_out_event(). More... | |
virtual bool | on_map_event (GdkEventAny*event) |
This is a default handler for the signal signal_map_event(). More... | |
virtual bool | on_unmap_event (GdkEventAny*event) |
This is a default handler for the signal signal_unmap_event(). More... | |
virtual bool | on_property_notify_event (GdkEventProperty*event) |
This is a default handler for the signal signal_property_notify_event(). More... | |
virtual bool | on_selection_clear_event (GdkEventSelection*event) |
This is a default handler for the signal signal_selection_clear_event(). More... | |
virtual bool | on_selection_request_event (GdkEventSelection*event) |
This is a default handler for the signal signal_selection_request_event(). More... | |
virtual bool | on_selection_notify_event (GdkEventSelection*event) |
This is a default handler for the signal signal_selection_notify_event(). More... | |
virtual bool | on_proximity_in_event (GdkEventProximity*event) |
This is a default handler for the signal signal_proximity_in_event(). More... | |
virtual bool | on_proximity_out_event (GdkEventProximity*event) |
This is a default handler for the signal signal_proximity_out_event(). More... | |
virtual bool | on_visibility_notify_event (GdkEventVisibility*event) |
This is a default handler for the signal signal_visibility_notify_event(). More... | |
virtual bool | on_client_event (GdkEventClient*event) |
This is a default handler for the signal signal_client_event(). More... | |
virtual bool | on_no_expose_event (GdkEventAny*event) |
This is a default handler for the signal signal_no_expose_event(). More... | |
virtual bool | on_window_state_event (GdkEventWindowState*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 Glib::RefPtr< Atk::Object > | on_get_accessible () |
This is a default handler for the signal signal_get_accessible(). 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 void | hide_all_vfunc () |
virtual Glib::RefPtr< Atk::Object > | get_accessible_vfunc () |
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 | 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 | style_attach () |
This function attaches the widget's Gtk::Style to the widget's Gdk::Window. More... | |
void | get_child_requisition (Requisition& requisition) const |
This function is only for use in widget implementations. 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 | |
ObjectBase & | operator= (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 Atk::Implementor | |
Implementor () | |
virtual Glib::RefPtr< Object > | ref_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) |
Related Functions | |
(Note that these are not member functions.) | |
Gtk::ComboBox* | wrap (GtkComboBox* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Related Functions inherited from Gtk::Bin | |
Gtk::Bin* | wrap (GtkBin* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Related Functions inherited from Gtk::Container | |
Gtk::Container* | wrap (GtkContainer* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Related Functions inherited from Gtk::Widget | |
Gtk::Widget* | wrap (GtkWidget* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Related Functions inherited from Gtk::Object | |
Gtk::Object* | wrap (GtkObject* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Related Functions inherited from Gtk::CellLayout | |
Glib::RefPtr< Gtk::CellLayout > | wrap (GtkCellLayout* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from Gtk::Widget | |
static Widget* | get_current_modal_grab () |
Retrieve the widget which is currently grabbing all events. More... | |
static void | push_colormap (const Glib::RefPtr< const Gdk::Colormap >& cmap) |
Pushes cmap onto a global stack of colormaps; the topmost colormap on the stack will be used to create all widgets. More... | |
static void | pop_colormap () |
Removes a colormap pushed with push_colormap(). 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_colormap (const Glib::RefPtr< const Gdk::Colormap >& colormap) |
Sets the default colormap to use when creating widgets. More... | |
static Glib::RefPtr< Style > | get_default_style () |
Returns the default style used by all widgets initially. More... | |
static Glib::RefPtr< Gdk::Colormap > | get_default_colormap () |
Obtains the default colormap used to create widgets. More... | |
static Glib::RefPtr< Gdk::Visual > | get_default_visual () |
Obtains the visual of the default colormap. 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 Widget* | drag_get_source_widget (const Glib::RefPtr< Gdk::DragContext >& context) |
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... | |
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 OptionMenu, or 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.
The ComboBox widget looks like this with has_entry = false:
The ComboBox widget looks like this with has_entry = true:
See also ComboBoxText, which is specialised for a single text column.
Member Typedef Documentation
Constructor & Destructor Documentation
|
virtual |
Gtk::ComboBox::ComboBox | ( | ) |
|
explicit |
Creates a new ComboBox with the model initialized to model.
|
explicit |
Creates a new empty #GtkComboBox, optionally with an entry.
- Parameters
-
has_entry If this is true then this will have an Entry widget.
newin{2,24}
|
explicit |
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.
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.
- 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.
- 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.
- 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.
- Returns
- The column span column.
Entry* Gtk::ComboBox::get_entry | ( | ) |
- See also
- Bin::get_child().
const Entry* Gtk::ComboBox::get_entry | ( | ) | const |
- See also
- Bin::get_child().
Glib::ustring Gtk::ComboBox::get_entry_text | ( | ) | const |
Get the text in the entry, if there is an entry.
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.
- 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().
- 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.
- Returns
- Whether there is an entry in combo_box.
Glib::RefPtr<TreeModel> Gtk::ComboBox::get_model | ( | ) |
Returns the Gtk::TreeModel which is acting as data source for combo_box.
- 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.
- 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.
- 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.
- Returns
- The accessible object corresponding to the combo box's popup.
int Gtk::ComboBox::get_row_span_column | ( | ) | const |
Returns the column with row span information for combo_box.
- 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().
- Returns
- The menu's title in tearoff mode. This is an internal copy of the string which must not be freed.
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.
- Returns
- The wrap width.
|
inline |
Provides access to the underlying C GtkObject.
|
inline |
Provides access to the underlying C GtkObject.
|
protectedvirtual |
This is a default handler for the signal signal_changed().
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.
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.
Glib::PropertyProxy< int > Gtk::ComboBox::property_active | ( | ) |
The item which is currently active.
- 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.
- 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 | ( | ) |
Whether dropdowns should have a tearoff menu item.
- 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 |
Whether dropdowns should have a tearoff menu item.
- 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.
- 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.
- 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 | ( | ) |
TreeModel column containing the column span values.
- 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 |
TreeModel column containing the column span values.
- 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.
- 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.
- 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 | ( | ) |
Whether the combo box draws a frame around the child.
- 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 |
Whether the combo box draws a frame around the child.
- 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 for the combo box.
- 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 for the combo box.
- 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's dropdown is shown.
- 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 | ( | ) |
TreeModel column containing the row span values.
- 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 |
TreeModel column containing the row span values.
- 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.
- 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.
- 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 | ( | ) |
Wrap width for laying out the items in a grid.
- 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 |
Wrap width for laying out the items in a grid.
- 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.
- Parameters
-
index An 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
.
- Parameters
-
iter The Gtk::TreeIter, or nullptr
.
void Gtk::ComboBox::set_add_tearoffs | ( | bool | add_tearoffs = true | ) |
Sets whether the popup menu should have a tearoff menu item.
- Parameters
-
add_tearoffs true
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).
- Parameters
-
sensitivity Specify 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.
- Parameters
-
column_span A 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
.
- Parameters
-
text_column A 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
.
- Parameters
-
text_column A 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.
- Parameters
-
focus_on_click Whether the combo box grabs focus when clicked with the mouse.
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.
- Parameters
-
model A Gtk::TreeModel.
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
-
slot The 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.
- Parameters
-
row_span A column in the model passed during construction.
void Gtk::ComboBox::set_title | ( | const Glib::ustring & | title | ) |
Sets the menu's title in tearoff mode.
- Parameters
-
title A 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.
- Parameters
-
width Preferred number of columns.
Glib::SignalProxy< void > Gtk::ComboBox::signal_changed | ( | ) |
The changed signal gets emitted when the active item is changed.
This can be due to the user selecting a different item from the list, or due to a call to set_active_iter().
- Slot Prototype:
void on_my_changed()
void Gtk::ComboBox::unset_active | ( | ) |
Causes no item to be active.
See also set_active().
void Gtk::ComboBox::unset_model | ( | ) |
void Gtk::ComboBox::unset_row_separator_func | ( | ) |
Causes no separators to be drawn.
Friends And Related Function Documentation
|
related |
A Glib::wrap() method for this object.
- Parameters
-
object The C instance. take_copy False 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.
The documentation for this class was generated from the following file:
- gtkmm/combobox.h