gtkmm: Gtk::ListBox Class Reference
A ListBox is a vertical container that contains ListBoxRow children. More...
#include <gtkmm/listbox.h>
Public Member Functions | |
ListBox (ListBox&& src) noexcept | |
ListBox& | operator= (ListBox&& src) noexcept |
ListBox (const ListBox&)=delete | |
ListBox& | operator= (const ListBox&)=delete |
~ListBox () noexcept override | |
GtkListBox* | gobj () |
Provides access to the underlying C GObject. More... | |
const GtkListBox* | gobj () const |
Provides access to the underlying C GObject. More... | |
ListBox () | |
void | prepend (Widget& child) |
Prepend a widget to the list. More... | |
void | append (Widget& child) |
Append a widget to the list. More... | |
void | insert (Widget& child, int position) |
Insert the child into the box at position. More... | |
void | remove (Widget& child) |
Removes a child from box. 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... | |
void | set_show_separators (bool show_separators=true) |
Sets whether the list box should show separators between rows. More... | |
bool | get_show_separators () const |
Returns whether the list box should show separators between rows. 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::PropertyProxy< bool > | property_accept_unpaired_release () |
Accept unpaired release. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_accept_unpaired_release () const |
Accept unpaired release. More... | |
Glib::PropertyProxy< bool > | property_show_separators () |
Show separators between rows. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_show_separators () const |
Show separators between rows. 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::Widget | |
Widget (Widget&& src) noexcept | |
Widget& | operator= (Widget&& src) noexcept |
Widget (const Widget&)=delete | |
Widget& | operator= (const Widget&)=delete |
~Widget () noexcept override | |
Destroys the widget. More... | |
GtkWidget* | gobj () |
Provides access to the underlying C GObject. More... | |
const GtkWidget* | gobj () const |
Provides access to the underlying C GObject. More... | |
Glib::RefPtr< ConstraintTarget > | make_refptr_constrainttarget () |
Converts this widget to a reference counted Gtk::ConstraintTarget. More... | |
Glib::RefPtr< const ConstraintTarget > | make_refptr_constrainttarget () const |
Converts this widget to a reference counted Gtk::ConstraintTarget. More... | |
void | show () |
Flags a widget to be displayed. More... | |
void | hide () |
Reverses the effects of show(), causing the widget to be hidden (invisible to the user). More... | |
void | queue_draw () |
Schedules this widget to be redrawn in paint phase of the current or the next frame. 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, int baseline) |
This is a simple form of allocate() that takes the new position of widget as part of allocation. More... | |
SizeRequestMode | get_request_mode () const |
Gets whether the widget prefers a height-for-width layout or a width-for-height layout. More... | |
void | measure (Orientation orientation, int for_size, int& minimum, int& natural, int& minimum_baseline, int& natural_baseline) const |
Measures widget in the orientation orientation and for the given for_size. 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 | set_layout_manager (const Glib::RefPtr< LayoutManager >& layout_manager) |
Sets the layout manager delegate instance that provides an implementation for measuring and allocating the children of widget. More... | |
void | unset_layout_manager () |
Undoes the effect of a previous call to set_layout_manager(). More... | |
Glib::RefPtr< LayoutManager > | get_layout_manager () |
Retrieves the layout manager set using set_layout_manager(). More... | |
Glib::RefPtr< const LayoutManager > | get_layout_manager () const |
Retrieves the layout manager set using set_layout_manager(). More... | |
bool | mnemonic_activate (bool group_cycling) |
Emits the Gtk::Widget::signal_mnemonic_activate() signal. More... | |
bool | activate () |
For widgets that can be “activated” (buttons, menu items, etc.) this function activates them. More... | |
void | set_can_focus (bool can_focus=true) |
Specifies whether the input focus can enter the widget or any of its children. More... | |
bool | get_can_focus () const |
Determines whether the input focus can enter widget or any of its children. More... | |
void | set_focusable (bool focusable=true) |
Specifies whether widget can own the input focus. More... | |
bool | get_focusable () 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... | |
bool | grab_focus () |
Causes widget (or one of its descendents) 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_target (bool can_target=true) |
Sets whether widget can be the target of pointer events. More... | |
bool | get_can_target () const |
Queries whether widget can be the target of pointer events. More... | |
bool | has_default () const |
Determines whether widget is the current default widget within its toplevel. 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... | |
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_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 | 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_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... | |
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... | |
Allocation | get_allocation () const |
Retrieves the widget’s location. More... | |
int | get_width () const |
Returns the content width of the widget, as passed to its size-allocate implementation. More... | |
int | get_height () const |
Returns the content height of the widget, as passed to its size-allocate implementation. More... | |
int | get_size (Orientation orientation) const |
Returns the content width or height of the widget, depending on orientation. More... | |
Widget* | get_parent () |
Returns the parent widget of widget. More... | |
const Widget* | get_parent () const |
Returns the parent widget of widget. More... | |
Root* | get_root () |
Returns the Gtk::Root widget of widget or nullptr if the widget is not contained inside a widget tree with a root widget. More... | |
const Root* | get_root () const |
Returns the Gtk::Root widget of widget or nullptr if the widget is not contained inside a widget tree with a root widget. More... | |
Native* | get_native () |
Returns the GtkNative widget that contains widget, or nullptr if the widget is not contained inside a widget tree with a native ancestor. More... | |
const Native* | get_native () const |
Returns the GtkNative widget that contains widget, or nullptr if the widget is not contained inside a widget tree with a native ancestor. 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. 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_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_overflow (Overflow overflow) |
Sets how widget treats content that is drawn outside the widget's content area. More... | |
Overflow | get_overflow () const |
Returns the value set via set_overflow(). 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... | |
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< Settings > | get_settings () |
Gets the settings object holding the settings used for this widget. More... | |
Glib::RefPtr< Gdk::Clipboard > | get_clipboard () |
This is a utility function to get the clipboard object for the Gdk::Display that widget is using. More... | |
Glib::RefPtr< const Gdk::Clipboard > | get_clipboard () const |
This is a utility function to get the clipboard object for the Gdk::Display that widget is using. More... | |
Glib::RefPtr< Gdk::Clipboard > | get_primary_clipboard () |
This is a utility function to get the primary clipboard object for the Gdk::Display that widget is using. More... | |
Glib::RefPtr< const Gdk::Clipboard > | get_primary_clipboard () const |
This is a utility function to get the primary clipboard object for the Gdk::Display that widget is using. 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... | |
bool | compute_expand (Orientation orientation) |
Computes whether a container should give this widget extra space when possible. More... | |
void | set_expand (bool expand=true) |
Sets whether the widget would like any available extra space in both directions. 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... | |
void | set_valign (Align align) |
Sets the vertical alignment 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... | |
void | set_margin (int margin) |
Set all 4 margins to the same value. 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, double src_x, double src_y, double& dest_x, double& dest_y) |
Translate coordinates relative to src_widget’s allocation to coordinates relative to dest_widget’s allocations. More... | |
bool | contains (double x, double y) const |
Tests if the point at ( x, y) is contained in widget. More... | |
Widget* | pick (double x, double y, PickFlags flags=PickFlags::DEFAULT) |
Finds the descendant of widget (including widget itself) closest to the screen at the point ( x, y). More... | |
const Widget* | pick (double x, double y, PickFlags flags=PickFlags::DEFAULT) const |
Finds the descendant of widget (including widget itself) closest to the screen at the point ( x, y). More... | |
void | add_controller (const Glib::RefPtr< EventController >& controller) |
Adds controller to widget so that it will receive events. More... | |
void | remove_controller (const Glib::RefPtr< EventController >& controller) |
Removes controller from widget, so that it doesn't process events anymore. 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... | |
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 | set_cursor (const Glib::RefPtr< Gdk::Cursor >& cursor) |
Sets the cursor to be shown when pointer devices point towards widget. More... | |
void | set_cursor (const Glib::ustring& name={}) |
Sets a named cursor to be shown when pointer devices point towards the widget. More... | |
Glib::RefPtr< Gdk::Cursor > | get_cursor () |
Queries the cursor set via set_cursor(). More... | |
Glib::RefPtr< const Gdk::Cursor > | get_cursor () const |
Queries the cursor set via set_cursor(). 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... | |
bool | drag_check_threshold (int start_x, int start_y, int current_x, int current_y) |
Checks to see if a mouse drag starting at ( start_x, start_y) and ending at ( current_x, current_y) has passed the GTK drag threshold, and thus should trigger the beginning of a drag-and-drop operation. More... | |
Glib::RefPtr< Gdk::FrameClock > | get_frame_clock () |
Obtains the frame clock for a widget. More... | |
Glib::RefPtr< const Gdk::FrameClock > | get_frame_clock () const |
Obtains the frame clock for a widget. More... | |
void | set_parent (Widget& parent) |
This function is useful only when implementing subclasses of Gtk::Widget. 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 | 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 set using set_tooltip_markup(). More... | |
void | set_has_tooltip (bool has_tooltip=TRUE) |
Sets the has-tooltip property on widget to has_tooltip. More... | |
bool | get_has_tooltip () const |
Returns the current value of the has-tooltip property. More... | |
bool | 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< const StyleContext > | get_style_context () const |
Returns the style context associated to widget. More... | |
guint | add_tick_callback (const SlotTick& slot) |
Queues an animation frame update and adds a callback to be called before each frame. More... | |
void | remove_tick_callback (guint id) |
Removes a tick callback previously registered with add_tick_callback(). 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... | |
bool | activate_action (const Glib::ustring& name, const Glib::VariantBase& args={}) |
Looks up the action in the action groups associated with the widget and its ancestors, and activates it. More... | |
void | activate_default () |
Activate the default.activate action from 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... | |
Widget* | get_first_child () |
Returns the widgets first child. More... | |
const Widget* | get_first_child () const |
Returns the widgets first child. More... | |
Widget* | get_last_child () |
Returns the widgets last child. More... | |
const Widget* | get_last_child () const |
Returns the widgets last child. More... | |
Widget* | get_next_sibling () |
Returns the widgets next sibling. More... | |
const Widget* | get_next_sibling () const |
Returns the widgets next sibling. More... | |
Widget* | get_prev_sibling () |
Returns the widgets previous sibling. More... | |
const Widget* | get_prev_sibling () const |
Returns the widgets previous sibling. More... | |
Glib::RefPtr< Gio::ListModel > | observe_children () |
Returns a ListModel to track the children of widget. More... | |
Glib::RefPtr< const Gio::ListModel > | observe_children () const |
Returns a ListModel to track the children of widget. More... | |
Glib::RefPtr< Gio::ListModel > | observe_controllers () |
Returns a ListModel to track the Gtk::EventControllers of widget. More... | |
Glib::RefPtr< const Gio::ListModel > | observe_controllers () const |
Returns a ListModel to track the Gtk::EventControllers of widget. More... | |
void | insert_after (Widget& parent, const Widget& previous_sibling) |
Inserts the Widget into the child widget list of parent after previous_sibling. More... | |
void | insert_before (Widget& parent, const Widget& next_sibling) |
Inserts the Widget into the child widget list of parent before next_sibling. More... | |
void | insert_at_start (Widget& parent) |
Inserts the Widget at the beginning of the child widget list of parent. More... | |
void | insert_at_end (Widget& parent) |
Inserts the Widget at the end of the child widget list of parent. More... | |
void | snapshot_child (Widget& child, const Glib::RefPtr< Gtk::Snapshot >& snapshot) |
When a widget receives a call to the snapshot function, it must send synthetic Gtk::WidgetClass.snapshot() calls to all children. More... | |
bool | should_layout () const |
Returns whether widget should contribute to the measuring and allocation of its parent. More... | |
Glib::ustring | get_css_name () const |
Returns the CSS name that is used for self. More... | |
void | add_css_class (const Glib::ustring& css_class) |
Adds css_class to widget. More... | |
void | remove_css_class (const Glib::ustring& css_class) |
Removes css_class from widget. More... | |
bool | has_css_class (const Glib::ustring& css_class) const |
Returns whether css_class is currently applied to widget. More... | |
std::vector< Glib::ustring > | get_css_classes () const |
Returns the list of css classes applied to widget. More... | |
void | set_css_classes (const std::vector< Glib::ustring >& classes) |
Will clear all css classes applied to widget and replace them with classes. 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(Gtk::StateFlags)> | signal_state_flags_changed () |
Glib::SignalProxy< void(TextDirection)> | signal_direction_changed () |
Glib::SignalProxy< bool(bool)> | signal_mnemonic_activate () |
Glib::SignalProxy< bool(int, int, bool, const Glib::RefPtr< Tooltip >&)> | signal_query_tooltip () |
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_ReadOnly< Widget* > | property_parent () const |
The parent widget of this widget. More... | |
Glib::PropertyProxy_ReadOnly< Root* > | property_root () const |
The Gtk::Root widget of the widget tree containing this widget or nullptr if the widget is not contained in a root 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_can_focus () |
Whether the widget or any of its descendents can accept the input focus. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_can_focus () const |
Whether the widget or any of its descendents can accept the input focus. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_has_focus () const |
Whether the widget has the input focus. More... | |
Glib::PropertyProxy< bool > | property_can_target () |
Whether the widget can receive pointer events. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_can_target () const |
Whether the widget can receive pointer events. 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_focusable () |
Whether this widget itself will accept the input focus. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_focusable () const |
Whether this widget itself will accept the input focus. 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< Glib::RefPtr< Gdk::Cursor > > | property_cursor () |
The cursor used by widget. More... | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Cursor > > | property_cursor () const |
The cursor used by widget. 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< 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_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< 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< 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< Overflow > | property_overflow () |
How content outside the widget's content area is treated. More... | |
Glib::PropertyProxy_ReadOnly< Overflow > | property_overflow () const |
How content outside the widget's content area is treated. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_scale_factor () const |
The scale factor of the widget. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_css_name () const |
The name of this widget in the CSS tree. More... | |
Glib::PropertyProxy< std::vector< Glib::ustring > > | property_css_classes () |
A list of css classes applied to this widget. More... | |
Glib::PropertyProxy_ReadOnly< std::vector< Glib::ustring > > | property_css_classes () const |
A list of css classes applied to this widget. More... | |
Glib::PropertyProxy< Glib::RefPtr< LayoutManager > > | property_layout_manager () |
The Gtk::LayoutManager instance to use to compute the preferred size of the widget, and allocate its children. More... | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< LayoutManager > > | property_layout_manager () const |
The Gtk::LayoutManager instance to use to compute the preferred size of the widget, and allocate its children. More... | |
Public Member Functions inherited from Gtk::Object | |
Object (Object&& src) noexcept | |
Object& | operator= (Object&& src) noexcept |
~Object () noexcept override | |
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 |
PropertyType | get_property (const Glib::ustring &property_name) const |
sigc::connection | connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void()> &slot) |
sigc::connection | connect_property_changed (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) noexcept | |
~trackable () | |
void | add_destroy_notify_callback (notifiable *data, func_destroy_notify func) const |
void | notify_callbacks () |
trackable & | operator= (const trackable &src) |
trackable & | operator= (trackable &&src) noexcept |
void | remove_destroy_notify_callback (notifiable *data) const |
Public Member Functions inherited from Gtk::Accessible | |
Accessible (Accessible&& src) noexcept | |
Accessible& | operator= (Accessible&& src) noexcept |
~Accessible () noexcept override | |
GtkAccessible* | gobj () |
Provides access to the underlying C GObject. More... | |
const GtkAccessible* | gobj () const |
Provides access to the underlying C GObject. More... | |
Role | get_accessible_role () const |
Retrieves the Gtk::Accessible::Role for the given Gtk::Accessible. More... | |
void | update_state (State state, const Glib::ValueBase& value) |
Updates an accessible state. More... | |
void | update_property (Property property, const Glib::ValueBase& value) |
Updates an accessible property. More... | |
void | update_relation (Relation relation, const Glib::ValueBase& value) |
Updates an accessible relation. More... | |
void | reset_state (State state) |
Resets the accessible state to its default value. More... | |
void | reset_property (Property property) |
Resets the accessible property to its default value. More... | |
void | reset_relation (Relation relation) |
Resets the accessible relation to its default value. More... | |
Glib::PropertyProxy< Role > | property_accessible_role () |
The accessible role of the given Gtk::Accessible implementation. More... | |
Glib::PropertyProxy_ReadOnly< Role > | property_accessible_role () const |
The accessible role of the given Gtk::Accessible implementation. 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 () noexcept override | |
Interface (const Interface &)=delete | |
Interface & | operator= (const Interface &)=delete |
GObject * | gobj () |
const GObject * | gobj () const |
Public Member Functions inherited from Gtk::Buildable | |
Buildable (Buildable&& src) noexcept | |
Buildable& | operator= (Buildable&& src) noexcept |
~Buildable () noexcept override | |
GtkBuildable* | gobj () |
Provides access to the underlying C GObject. More... | |
const GtkBuildable* | gobj () const |
Provides access to the underlying C GObject. More... | |
Glib::ustring | get_buildable_id () const |
Gets the ID of the buildable object. More... | |
Public Member Functions inherited from Gtk::ConstraintTarget | |
ConstraintTarget (ConstraintTarget&& src) noexcept | |
ConstraintTarget& | operator= (ConstraintTarget&& src) noexcept |
~ConstraintTarget () noexcept override | |
GtkConstraintTarget* | gobj () |
Provides access to the underlying C GObject. More... | |
const GtkConstraintTarget* | gobj () const |
Provides access to the underlying C GObject. More... | |
Static Public Member Functions | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
Static Public Member Functions inherited from Gtk::Widget | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. 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 Public Member Functions inherited from Gtk::Accessible | |
static void | add_interface (GType gtype_implementer) |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
Static Public Member Functions inherited from Gtk::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 Gtk::ConstraintTarget | |
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... | |
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::Widget | |
Gtk::Widget* | wrap (GtkWidget* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Related Functions inherited from Gtk::Accessible | |
Glib::RefPtr< Gtk::Accessible > | wrap (GtkAccessible* 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... | |
Related Functions inherited from Gtk::ConstraintTarget | |
Glib::RefPtr< Gtk::ConstraintTarget > | wrap (GtkConstraintTarget* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from Gtk::Widget | |
virtual void | root_vfunc () |
virtual void | unroot_vfunc () |
virtual void | size_allocate_vfunc (int width, int height, int baseline) |
virtual SizeRequestMode | get_request_mode_vfunc () const |
virtual void | measure_vfunc (Orientation orientation, int for_size, int& minimum, int& natural, int& minimum_baseline, int& natural_baseline) const |
virtual bool | grab_focus_vfunc () |
virtual void | set_focus_child_vfunc (Widget* child) |
Sets the focused child of widget. More... | |
virtual void | compute_expand_vfunc (bool& hexpand_p, bool& vexpand_p) |
virtual bool | contains_vfunc (double x, double y) const |
virtual void | snapshot_vfunc (const Glib::RefPtr< Gtk::Snapshot >& snapshot) |
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 | realize_if_needed () |
void | set_focus_child (Widget& child) |
Set child as the current focus child of widget. More... | |
void | unset_focus_child () |
Unsets the focus child of the widget. More... | |
Widget* | get_focus_child () |
Returns the current focus child of widget. More... | |
const Widget* | get_focus_child () const |
Returns the current focus child of widget. More... | |
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_state_flags_changed (Gtk::StateFlags previous_state_flags) |
This is a default handler for the signal signal_state_flags_changed(). More... | |
virtual void | on_direction_changed (TextDirection direction) |
This is a default handler for the signal signal_direction_changed(). More... | |
virtual bool | on_mnemonic_activate (bool group_cycling) |
This is a default handler for the signal signal_mnemonic_activate(). More... | |
virtual bool | on_query_tooltip (int x, int y, bool keyboard_tooltip, const Glib::RefPtr< Tooltip >& tooltip) |
This is a default handler for the signal signal_query_tooltip(). More... | |
Protected Member Functions inherited from Glib::Object | |
Object () | |
Object (const Glib::ConstructParams &construct_params) | |
Object (GObject *castitem) | |
~Object () noexcept override | |
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::Accessible | |
Accessible () | |
You should derive from this class to use it. More... | |
Protected Member Functions inherited from Gtk::Buildable | |
Buildable () | |
You should derive from this class to use it. More... | |
Protected Member Functions inherited from Gtk::ConstraintTarget | |
ConstraintTarget () | |
You should derive from this class to use it. 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 prepend(), append() and insert(), 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
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.
- Returns
- 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
true
if the row should be visible,false
otherwise
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 0
if 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.
- Parameters
-
child The Gtk::Widget to add.
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()) 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()) 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 by setting the Gtk::StateFlags::DROP_ACTIVE state 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
true
if rows are activated on single click,false
otherwise.
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
nullptr
in 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
nullptr
in 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 |
Gets the selection mode of the listbox.
- Returns
- A Gtk::SelectionMode.
bool Gtk::ListBox::get_show_separators | ( | ) | const |
Returns whether the list box should show separators between rows.
- Returns
true
if the list box shows separators.
|
static |
Get the GType for this class, for use with the underlying GObject type system.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
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.
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.
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.
- Parameters
-
child The Gtk::Widget to add.
Glib::PropertyProxy< bool > Gtk::ListBox::property_accept_unpaired_release | ( | ) |
Accept unpaired release.
Default value: false
- 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_accept_unpaired_release | ( | ) | const |
Accept unpaired release.
Default value: false
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< bool > Gtk::ListBox::property_activate_on_single_click | ( | ) |
Activate row on a single click.
Default value: true
- 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.
Default value: true
- 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.
Default value: Gtk::SelectionMode::SINGLE
- 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.
Default value: Gtk::SelectionMode::SINGLE
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< bool > Gtk::ListBox::property_show_separators | ( | ) |
Show separators between rows.
Default value: false
- 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_show_separators | ( | ) | const |
Show separators between rows.
Default value: false
- 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::remove | ( | Widget& | child | ) |
Removes a child from box.
- Parameters
-
child The child to remove.
void Gtk::ListBox::select_all | ( | ) |
Select all children of box, if the selection mode allows it.
void Gtk::ListBox::select_row | ( | ListBoxRow& | row | ) |
Make row the currently selected row.
- Parameters
-
row The row to select or nullptr
.
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_show_separators | ( | bool | show_separators = true | ) |
Sets whether the list box should show separators between rows.
- Parameters
-
show_separators true
to show separators.
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)
Flags: Run Last
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)
Flags: Run Last
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::SelectionMode::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()
Flags: Run First
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.