gtkmm: Gtk::ListBox Class Reference
A ListBox is a vertical container that contains ListBoxRow children. More...
#include <gtkmm/listbox.h>
Inheritance diagram for Gtk::ListBox:
Public Types | |
| typedef sigc::slot< bool, ListBoxRow* > | SlotFilter |
| For instance: bool on_filter(ListBoxRow* row);. More... | |
| typedef sigc::slot< int, ListBoxRow*, ListBoxRow* > | SlotSort |
| For instance: int on_sort(ListBoxRow* row1, ListBoxRow* row2);. More... | |
| typedef sigc::slot< void, ListBoxRow*, ListBoxRow* > | SlotUpdateHeader |
| For instance: void on_update_header(ListBoxRow* row, ListBoxRow* before);. More... | |
| typedef sigc::slot< void, ListBoxRow* > | SlotForeach |
| For instance, void on_foreach(ListBoxRow* row);. More... | |
| template<typename T_item > | |
| using | SlotCreateWidget = sigc::slot< Gtk::Widget*, const Glib::RefPtr< T_item >& > |
| For instance: Gtk::Widget* on_create_widget(const Glib::RefPtr<T_item>& item);. More... | |
 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 Member Functions | |
| ListBox (ListBox&& src) noexcept | |
| ListBox& | operator= (ListBox&& src) noexcept |
| ListBox (const ListBox&)=delete | |
| ListBox& | operator= (const ListBox&)=delete |
| ~ListBox () noexceptoverride | |
| GtkListBox* | gobj () |
| Provides access to the underlying C GtkObject. More... | |
| const GtkListBox* | gobj () const |
| Provides access to the underlying C GtkObject. More... | |
| ListBox () | |
| void | prepend (Widget& child) |
| Prepend a widget to the list. More... | |
| void | insert (Widget& child, int position) |
| Insert the child into the box at position. More... | |
| void | append (Widget& child) |
| Append a widget to the list. More... | |
| ListBoxRow* | get_selected_row () |
| Gets the selected row. More... | |
| const ListBoxRow* | get_selected_row () const |
| Gets the selected row. More... | |
| ListBoxRow* | get_row_at_index (int index) |
| Gets the n-th child in the list (not counting headers). More... | |
| const ListBoxRow* | get_row_at_index (int index) const |
| Gets the n-th child in the list (not counting headers). More... | |
| ListBoxRow* | get_row_at_y (int y) |
| Gets the row at the y position. More... | |
| const ListBoxRow* | get_row_at_y (int y) const |
| Gets the row at the y position. More... | |
| void | select_row (ListBoxRow& row) |
| Make row the currently selected row. More... | |
| void | unselect_row () |
| Unselects the currently selected row, if any. More... | |
| void | set_placeholder (Widget& placeholder) |
| Sets the placeholder widget that is shown in the list when it doesn't display any visible children. More... | |
| void | unset_placeholder () |
| Removes the placeholder widget, if any. More... | |
| void | set_adjustment (const Glib::RefPtr< Adjustment >& adjustment) |
| Sets the adjustment (if any) that the widget uses to for vertical scrolling. More... | |
| Glib::RefPtr< Adjustment > | get_adjustment () |
| Gets the adjustment (if any) that the widget uses to for vertical scrolling. More... | |
| Glib::RefPtr< const Adjustment > | get_adjustment () const |
| Gets the adjustment (if any) that the widget uses to for vertical scrolling. More... | |
| void | selected_foreach (const SlotForeach& slot) |
| std::vector< ListBoxRow* > | get_selected_rows () |
| Creates a list of all selected children. More... | |
| std::vector< ListBoxRow* > | get_selected_rows () const |
| Creates a list of all selected children. More... | |
| void | unselect_row (ListBoxRow* row) |
| Unselects a single row of box, if the selection mode allows it. More... | |
| void | select_all () |
| Select all children of box, if the selection mode allows it. More... | |
| void | unselect_all () |
| Unselect all children of box, if the selection mode allows it. More... | |
| void | set_selection_mode (SelectionMode mode) |
| Sets how selection works in the listbox. More... | |
| SelectionMode | get_selection_mode () const |
| Gets the selection mode of the listbox. More... | |
| void | set_filter_func (const SlotFilter& slot) |
| Sets a filter function. More... | |
| void | unset_filter_func () |
| Removes the filter function, if any. More... | |
| void | set_sort_func (const SlotSort& slot) |
| Sets a sort function. More... | |
| void | unset_sort_func () |
| Removes the sort function, if any. More... | |
| void | set_header_func (const SlotUpdateHeader& slot) |
| Sets a header function. More... | |
| void | unset_header_func () |
| Removes the header function, if any. More... | |
| void | invalidate_filter () |
| Update the filtering for all rows. More... | |
| void | invalidate_sort () |
| Update the sorting for all rows. More... | |
| void | invalidate_headers () |
| Update the separators for all rows. More... | |
| void | set_activate_on_single_click (bool single=true) |
If single is true, rows will be activated when you click on them, otherwise you need to double-click. More... | |
| bool | get_activate_on_single_click () const |
| Returns whether rows activate on single clicks. More... | |
| void | drag_unhighlight_row () |
| If a row has previously been highlighted via drag_highlight_row() it will have the highlight removed. More... | |
| void | drag_highlight_row (ListBoxRow& row) |
| This is a helper function for implementing DnD onto a Gtk::ListBox. More... | |
| void | bind_model (const Glib::RefPtr< Gio::ListModel >& model, const SlotCreateWidget< Glib::Object >& slot_create_widget) |
| Binds a Gio::ListModel. More... | |
| template<typename T_item , typename T_slot > | |
| void | bind_list_store (const Glib::RefPtr< Gio::ListStore< T_item >>& store, T_slot&& slot_create_widget) |
| Binds a Gio::ListStore<>. More... | |
| Glib::PropertyProxy< SelectionMode > | property_selection_mode () |
| The selection mode. More... | |
| Glib::PropertyProxy_ReadOnly< SelectionMode > | property_selection_mode () const |
| The selection mode. More... | |
| Glib::PropertyProxy< bool > | property_activate_on_single_click () |
| Activate row on a single click. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_activate_on_single_click () const |
| Activate row on a single click. More... | |
| Glib::SignalProxy< void, ListBoxRow* > | signal_row_selected () |
| Glib::SignalProxy< void, ListBoxRow* > | signal_row_activated () |
| Glib::SignalProxy< void > | signal_selected_rows_changed () |
| Public Member Functions inherited from Gtk::Container | |
| Container (Container&& src) noexcept | |
| Container& | operator= (Container&& src) noexcept |
| Container (const Container&)=delete | |
| Container& | operator= (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... | |
| Widget* | get_focus_child () |
| Returns the current focus child widget inside container. More... | |
| const Widget* | get_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< Adjustment > | get_focus_vadjustment () |
| Retrieves the vertical focus adjustment for the container. More... | |
| Glib::RefPtr< const Adjustment > | get_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< Adjustment > | get_focus_hadjustment () |
| Retrieves the horizontal focus adjustment for the container. More... | |
| Glib::RefPtr< 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... | |
| 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 | |
| Widget& | operator= (Widget&& src) noexcept |
| Widget (const Widget&)=delete | |
| Widget& | operator= (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::Region > | region_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::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... | |
| 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... | |
| 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 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... | |
| 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::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... | |
| int | get_scale_factor () const |
| Retrieves the internal scale factor that maps from window coordinates to the actual device pixels. 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 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... | |
| 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::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... | |
| 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::Context > | create_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::Context > | get_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::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_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< TargetList > | drag_dest_get_target_list () |
| Glib::RefPtr< const TargetList > | drag_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::DragContext > | drag_begin (const Glib::RefPtr< TargetList >& targets, Gdk::DragAction actions, int button, GdkEvent* gdk_event) |
| Glib::RefPtr< Gdk::DragContext > | drag_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... | |
| 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... | |
| 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< StyleContext > | get_style_context () |
| Returns the style context associated to widget. More... | |
| Glib::RefPtr< Gtk::StyleContext > | get_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::ActionGroup > | get_action_group (const Glib::ustring& prefix) |
| Retrieves the ActionGroup that was registered using prefix. More... | |
| Glib::RefPtr< const Gio::ActionGroup > | get_action_group (const Glib::ustring& prefix) const |
| Retrieves the ActionGroup that was registered using prefix. More... | |
| std::vector< Glib::ustring > | list_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::FontMap > | get_font_map () |
| Gets the font map that has been set with set_font_map(). More... | |
| Glib::RefPtr< const Pango::FontMap > | get_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::StateType > | signal_state_changed () |
| Glib::SignalProxy< void, Gtk::StateFlags > | signal_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, TextDirection > | signal_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, 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 () |
| 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 >&, DragResult > | signal_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::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_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::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< 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::ustring > | property_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::ustring > | property_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::ustring > | property_tooltip_text () |
| Sets the text of tooltip to be the given string. More... | |
| Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_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< Align > | property_halign () |
| How to distribute horizontal space if widget gets extra space, see Gtk::Align. More... | |
| Glib::PropertyProxy_ReadOnly< Align > | property_halign () const |
| How to distribute horizontal space if widget gets extra space, see Gtk::Align. More... | |
| Glib::PropertyProxy< Align > | property_valign () |
| How to distribute vertical space if widget gets extra space, see Gtk::Align. More... | |
| Glib::PropertyProxy_ReadOnly< Align > | property_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 | |
| Object& | operator= (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 | |
| 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 Gtk::Buildable | |
| Buildable (Buildable&& src) noexcept | |
| Buildable& | operator= (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 | |
| 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 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) |
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::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 Widget* | get_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 Widget* | drag_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 () |
Protected Member Functions | |
| virtual void | on_row_selected (ListBoxRow* row) |
| This is a default handler for the signal signal_row_selected(). More... | |
| virtual void | on_row_activated (ListBoxRow* row) |
| This is a default handler for the signal signal_row_activated(). 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< 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_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::Object > | get_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 | |
| 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 Gtk::Buildable | |
| Buildable () | |
| You should derive from this class to use it. More... | |
| Protected Member Functions inherited from Atk::Implementor | |
| Implementor () | |
| virtual Glib::RefPtr< Object > | ref_accessibile_vfunc () |
Related Functions | |
(Note that these are not member functions.) | |
| Gtk::ListBox* | wrap (GtkListBox* 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::Buildable | |
| Glib::RefPtr< Gtk::Buildable > | wrap (GtkBuildable* 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 ListBox is a vertical container that contains ListBoxRow children.
These rows can by dynamically sorted and filtered, and headers can be added dynamically depending on the row content. It also allows keyboard and mouse navigation and selection like a typical list.
Using ListBox is often an alternative to TreeView, especially when the list contents have a more complicated layout than what is allowed by a CellRenderer, or when the contents are interactive (e.g. contain a button).
Although a ListBox must have only ListBoxRow children you can add any kind of widget to it via Container::add(), and a ListBoxRow widget will automatically be inserted between the list and the widget.
Also see FlowBox.
A ListBox looks like this:
Member Typedef Documentation
template <typename T_item >
| using Gtk::ListBox::SlotCreateWidget = sigc::slot<Gtk::Widget*, const Glib::RefPtr<T_item>&> |
For instance: Gtk::Widget* on_create_widget(const Glib::RefPtr<T_item>& item);.
Called for list boxes that are bound to a Gio::ListModel with bind_model() or bind_list_store() for each item that gets added to the model.
Versions of GTK+ prior to 3.18 called show_all() on the rows created by the SlotCreateWidget, but this forced all widgets inside the row to be shown, and is no longer the case. Applications should be updated to show the desired row widgets.
- Template Parameters
-
T_item Base class of the items in the Gio::ListModel. All items must be of type T_item or a type derived from T_item. T_item must be Glib::Object or a type derived from Glib::Object.
- Parameters
-
item The item from the model for which to create a widget. A Gtk::Widget that represents item.
| typedef sigc::slot<bool, ListBoxRow*> Gtk::ListBox::SlotFilter |
For instance: bool on_filter(ListBoxRow* row);.
Will be called whenever the row changes or is added and lets you control if the row should be visible or not.
- Parameters
-
row The row that may be filtered
- Returns
trueif the row should be visible,falseotherwise
| typedef sigc::slot<void, ListBoxRow*> Gtk::ListBox::SlotForeach |
For instance, void on_foreach(ListBoxRow* row);.
| typedef sigc::slot<int, ListBoxRow*, ListBoxRow*> Gtk::ListBox::SlotSort |
For instance: int on_sort(ListBoxRow* row1, ListBoxRow* row2);.
Compare two rows to determine which should be first.
- Parameters
-
row1 The first row row2 The second row
- Returns
- < 0 if row1 should be before row2, 0 if they are equal and > 0 otherwise
| typedef sigc::slot<void, ListBoxRow*, ListBoxRow*> Gtk::ListBox::SlotUpdateHeader |
For instance: void on_update_header(ListBoxRow* row, ListBoxRow* before);.
Whenever row changes or which row is before row changes this is called, which lets you update the header on row. You may remove or set a new one via ListBoxRow::set_header() or just change the state of the current header widget.
- Parameters
-
row The row to update before The row before row, or 0if it is first
Constructor & Destructor Documentation
|
noexcept |
|
delete |
|
overridenoexcept |
| Gtk::ListBox::ListBox | ( | ) |
Member Function Documentation
| void Gtk::ListBox::append | ( | Widget& | child | ) |
Append a widget to the list.
If a sort function is set, the widget will actually be inserted at the calculated position and this function has the same effect of Gtk::Container::add().
- Parameters
-
child The Gtk::Widget to add.
template <typename T_item , typename T_slot >
| void Gtk::ListBox::bind_list_store | ( | const Glib::RefPtr< Gio::ListStore< T_item >> & | store, |
| T_slot && | slot_create_widget | ||
| ) |
Binds a Gio::ListStore<>.
If this ListBox was already bound to a Gio::ListModel, that previous binding is destroyed. (Gio::ListStore is a Gio::ListModel.)
The contents of the ListBox are cleared and then filled with widgets that represent items from store. The ListBox is updated whenever store changes. If store is an empty Glib::RefPtr, the ListBox is left empty.
It is undefined to add or remove widgets directly (for example, with insert() or Gtk::Container::add()) while the ListBox is bound to a model.
Note that using a model is incompatible with the filtering and sorting functionality in ListBox. When using a model, filtering and sorting should be implemented by the model.
- Template Parameters
-
T_item Base class of the items in the Gio::ListStore. All items must be of type T_item or a type derived from T_item. T_item must be Glib::Object or a type derived from Glib::Object. T_slot SlotCreateWidget<T_item> or a type that can be converted to SlotCreateWidget<T_item>.
- Parameters
-
store The Gio::ListStore<> to be bound. slot_create_widget A slot that creates widgets for items.
| void Gtk::ListBox::bind_model | ( | const Glib::RefPtr< Gio::ListModel > & | model, |
| const SlotCreateWidget< Glib::Object >& | slot_create_widget | ||
| ) |
Binds a Gio::ListModel.
If this ListBox was already bound to a model, that previous binding is destroyed.
The contents of the ListBox are cleared and then filled with widgets that represent items from model. The ListBox is updated whenever model changes. If model is an empty Glib::RefPtr, the ListBox is left empty.
It is undefined to add or remove widgets directly (for example, with insert() or Gtk::Container::add()) while the ListBox is bound to a model.
Note that using a model is incompatible with the filtering and sorting functionality in ListBox. When using a model, filtering and sorting should be implemented by the model.
- Parameters
-
model The Gio::ListModel to be bound. slot_create_widget A slot that creates widgets for items.
- See also
- bind_list_store()
| void Gtk::ListBox::drag_highlight_row | ( | ListBoxRow& | row | ) |
This is a helper function for implementing DnD onto a Gtk::ListBox.
The passed in row will be highlighted via gtk_drag_highlight(), and any previously highlighted row will be unhighlighted.
The row will also be unhighlighted when the widget gets a drag leave event.
- Parameters
-
row A Gtk::ListBoxRow.
| void Gtk::ListBox::drag_unhighlight_row | ( | ) |
If a row has previously been highlighted via drag_highlight_row() it will have the highlight removed.
| bool Gtk::ListBox::get_activate_on_single_click | ( | ) | const |
Returns whether rows activate on single clicks.
- Returns
trueif rows are activated on single click,falseotherwise.
| Glib::RefPtr<Adjustment> Gtk::ListBox::get_adjustment | ( | ) |
Gets the adjustment (if any) that the widget uses to for vertical scrolling.
- Returns
- The adjustment.
| Glib::RefPtr<const Adjustment> Gtk::ListBox::get_adjustment | ( | ) | const |
Gets the adjustment (if any) that the widget uses to for vertical scrolling.
- Returns
- The adjustment.
| ListBoxRow* Gtk::ListBox::get_row_at_index | ( | int | index | ) |
Gets the n-th child in the list (not counting headers).
If _index is negative or larger than the number of items in the list, nullptr is returned.
- Parameters
-
index The index of the row.
- Returns
- The child Gtk::Widget or
nullptr.
| const ListBoxRow* Gtk::ListBox::get_row_at_index | ( | int | index | ) | const |
Gets the n-th child in the list (not counting headers).
If _index is negative or larger than the number of items in the list, nullptr is returned.
- Parameters
-
index The index of the row.
- Returns
- The child Gtk::Widget or
nullptr.
| ListBoxRow* Gtk::ListBox::get_row_at_y | ( | int | y | ) |
Gets the row at the y position.
- Parameters
-
y Position.
- Returns
- The row or
nullptrin case no row exists for the given y coordinate.
| const ListBoxRow* Gtk::ListBox::get_row_at_y | ( | int | y | ) | const |
Gets the row at the y position.
- Parameters
-
y Position.
- Returns
- The row or
nullptrin case no row exists for the given y coordinate.
| ListBoxRow* Gtk::ListBox::get_selected_row | ( | ) |
Gets the selected row.
Note that the box may allow multiple selection, in which case you should use selected_foreach() to find all selected rows.
- Returns
- The selected row.
| const ListBoxRow* Gtk::ListBox::get_selected_row | ( | ) | const |
Gets the selected row.
Note that the box may allow multiple selection, in which case you should use selected_foreach() to find all selected rows.
- Returns
- The selected row.
| std::vector<ListBoxRow*> Gtk::ListBox::get_selected_rows | ( | ) |
Creates a list of all selected children.
- Returns
- A List containing the Gtk::Widget for each selected child.
| std::vector<ListBoxRow*> Gtk::ListBox::get_selected_rows | ( | ) | const |
Creates a list of all selected children.
- Returns
- A List containing the Gtk::Widget for each selected child.
| SelectionMode Gtk::ListBox::get_selection_mode | ( | ) | const |
|
static |
Get the GType for this class, for use with the underlying GObject type system.
|
inline |
Provides access to the underlying C GtkObject.
|
inline |
Provides access to the underlying C GtkObject.
| void Gtk::ListBox::insert | ( | Widget& | child, |
| int | position | ||
| ) |
Insert the child into the box at position.
If a sort function is set, the widget will actually be inserted at the calculated position and this function has the same effect of Gtk::Container::add().
If position is -1, or larger than the total number of items in the box, then the child will be appended to the end.
- Parameters
-
child The Gtk::Widget to add. position The position to insert child in.
| void Gtk::ListBox::invalidate_filter | ( | ) |
Update the filtering for all rows.
Call this when result of the filter function on the box is changed due to an external factor. For instance, this would be used if the filter function just looked for a specific search string and the entry with the search string has changed.
| void Gtk::ListBox::invalidate_headers | ( | ) |
Update the separators for all rows.
Call this when result of the header function on the box is changed due to an external factor.
| void Gtk::ListBox::invalidate_sort | ( | ) |
Update the sorting for all rows.
Call this when result of the sort function on the box is changed due to an external factor.
|
protectedvirtual |
This is a default handler for the signal signal_row_activated().
|
protectedvirtual |
This is a default handler for the signal signal_row_selected().
| void Gtk::ListBox::prepend | ( | Widget& | child | ) |
Prepend a widget to the list.
If a sort function is set, the widget will actually be inserted at the calculated position and this function has the same effect of Gtk::Container::add().
- Parameters
-
child The Gtk::Widget to add.
| Glib::PropertyProxy< bool > Gtk::ListBox::property_activate_on_single_click | ( | ) |
Activate row on a single click.
- 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::ListBox::property_activate_on_single_click | ( | ) | const |
Activate row on a single click.
- 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< SelectionMode > Gtk::ListBox::property_selection_mode | ( | ) |
The selection mode.
- 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< SelectionMode > Gtk::ListBox::property_selection_mode | ( | ) | const |
The selection mode.
- 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::ListBox::select_all | ( | ) |
Select all children of box, if the selection mode allows it.
| void Gtk::ListBox::select_row | ( | ListBoxRow& | row | ) |
| void Gtk::ListBox::selected_foreach | ( | const SlotForeach& | slot | ) |
| void Gtk::ListBox::set_activate_on_single_click | ( | bool | single = true | ) |
If single is true, rows will be activated when you click on them, otherwise you need to double-click.
- Parameters
-
single A boolean.
| void Gtk::ListBox::set_adjustment | ( | const Glib::RefPtr< Adjustment >& | adjustment | ) |
Sets the adjustment (if any) that the widget uses to for vertical scrolling.
For instance, this is used to get the page size for PageUp/Down key handling.
In the normal case when the box is packed inside a Gtk::ScrolledWindow the adjustment from that will be picked up automatically, so there is no need to manually do that.
- Parameters
-
adjustment The adjustment, or nullptr.
| void Gtk::ListBox::set_filter_func | ( | const SlotFilter& | slot | ) |
Sets a filter function.
By setting a filter function on the ListBox one can decide dynamically which of the rows to show. For instance, to implement a search function on a list that filters the original list to only show the matching rows.
The slot will be called for each row after the call, and it will continue to be called each time a row changes (via ListBoxRow::changed()) or when invalidate_filter() is called.
- Parameters
-
slot Callback that lets you filter which rows to show
| void Gtk::ListBox::set_header_func | ( | const SlotUpdateHeader& | slot | ) |
Sets a header function.
By setting a header function on the ListBox one can dynamically add headers in front of rows, depending on the contents of the row and its position in the list. For instance, one could use it to add headers in front of the first item of a new kind, in a list sorted by the kind.
The slot can look at the current header widget using ListBoxRow::get_header() and either update the state of the widget as needed, or set a new one using ListBoxRow::set_header(). If no header is needed, use ListBoxRow::unset_header().
Note that you may get many calls to this slot for a particular row when e.g. changing things that don't affect the header. In this case it is important for performance to not blindly replace an exisiting header with an identical one.
The slot function will be called for each row after the call, and it will continue to be called each time a row changes (via ListBoxRow::changed()) and when the row before changes (either by ListBoxRow::changed() on the previous row, or when the previous row becomes a different row). It is also called for all rows when invalidate_headers() is called.
- Parameters
-
slot Callback that lets you add row headers
| void Gtk::ListBox::set_placeholder | ( | Widget& | placeholder | ) |
Sets the placeholder widget that is shown in the list when it doesn't display any visible children.
- Parameters
-
placeholder A Gtk::Widget or nullptr.
| void Gtk::ListBox::set_selection_mode | ( | SelectionMode | mode | ) |
Sets how selection works in the listbox.
See Gtk::SelectionMode for details.
- Parameters
-
mode The Gtk::SelectionMode.
| void Gtk::ListBox::set_sort_func | ( | const SlotSort& | slot | ) |
Sets a sort function.
By setting a sort function on the ListBox one can dynamically reorder the rows of the list, based on the contents of the rows.
The slot will be called for each row after the call, and will continue to be called each time a row changes (via ListBoxRow::changed()) and when invalidate_sort() is called.
- Parameters
-
slot The sort function.
| Glib::SignalProxy< void,ListBoxRow* > Gtk::ListBox::signal_row_activated | ( | ) |
- Slot Prototype:
void on_my_row_activated(ListBoxRow* row)
The signal_row_activated() signal is emitted when a row has been activated by the user.
- Parameters
-
row The activated row.
| Glib::SignalProxy< void,ListBoxRow* > Gtk::ListBox::signal_row_selected | ( | ) |
- Slot Prototype:
void on_my_row_selected(ListBoxRow* row)
The signal_row_selected() signal is emitted when a new row is selected, or (with a nullptr row) when the selection is cleared.
When the box is using Gtk::SELECTION_MULTIPLE, this signal will not give you the full picture of selection changes, and you should use the Gtk::ListBox::signal_selected_rows_changed() signal instead.
- Parameters
-
row The selected row.
| Glib::SignalProxy< void > Gtk::ListBox::signal_selected_rows_changed | ( | ) |
- Slot Prototype:
void on_my_selected_rows_changed()
The signal_selected_rows_changed() signal is emitted when the set of selected rows changes.
| void Gtk::ListBox::unselect_all | ( | ) |
Unselect all children of box, if the selection mode allows it.
| void Gtk::ListBox::unselect_row | ( | ) |
Unselects the currently selected row, if any.
| void Gtk::ListBox::unselect_row | ( | ListBoxRow* | row | ) |
Unselects a single row of box, if the selection mode allows it.
- Parameters
-
row The row to unselected.
| void Gtk::ListBox::unset_filter_func | ( | ) |
Removes the filter function, if any.
| void Gtk::ListBox::unset_header_func | ( | ) |
Removes the header function, if any.
| void Gtk::ListBox::unset_placeholder | ( | ) |
Removes the placeholder widget, if any.
| void Gtk::ListBox::unset_sort_func | ( | ) |
Removes the sort function, if any.
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.