gtkmm  4.8.0
Classes | Public Types | Public Member Functions | Protected Attributes | List of all members
Gtk::ListViewText Class Reference

A simple listbox which presents some lines of information in columns and lets the user select some of them. More...

#include <gtkmm/listviewtext.h>

Inheritance diagram for Gtk::ListViewText:
Inheritance graph
[legend]

Classes

class  TextModelColumns
 

Public Types

typedef std::vector< int > SelectionList
 
- Public Types inherited from Gtk::TreeView
enum class  DropPosition {
  BEFORE ,
  AFTER ,
  INTO_OR_BEFORE ,
  INTO_OR_AFTER
}
 An enum for determining where a dropped row goes. More...
 
enum class  GridLines {
  NONE ,
  HORIZONTAL ,
  VERTICAL ,
  BOTH
}
 Used to indicate which grid lines to draw in a tree view. More...
 
typedef TreeViewColumn Column
 A visible column in a Gtk::TreeView widget. More...
 
typedef TreeSelection Selection
 A selection object for Gtk::TreeView. More...
 
typedef TreeViewColumn::SlotTreeCellData SlotTreeCellData
 
typedef sigc::slot< bool(TreeView *, TreeViewColumn *, TreeViewColumn *, TreeViewColumn *)> SlotColumnDrop
 For instance, bool on_column_drop(TreeView*, tree_view, TreeViewColumn* column, TreeViewColumn* prev_column, TreeViewColumn* next_column) More...
 
typedef sigc::slot< void(TreeView *, const TreeModel::Path &)> SlotMapping
 For example, void on_map_expanded_rows(TreeView* tree_view, const TreeModel::Path& path);. More...
 
typedef sigc::slot< bool(const Glib::RefPtr< TreeModel > &, int, const Glib::ustring &, const TreeModel::const_iterator &)> SlotSearchEqual
 void on_search_equal(const Glib::RefPtr<TreeModel>& model, int column, const Glib::ustring& key, const TreeModel::const_iterator& iter) More...
 
typedef sigc::slot< bool(const Glib::RefPtr< TreeModel > &, const TreeModel::const_iterator &)> SlotRowSeparator
 The slot type for determining whether the row pointed to by the iterator should be rendered as a separator. More...
 
- Public Types inherited from Gtk::Widget
using SlotTick = sigc::slot< bool(const Glib::RefPtr< Gdk::FrameClock > &)>
 Callback type for adding a function to update animations. More...
 
- Public Types inherited from Gtk::Accessible
enum class  Role {
  ALERT ,
  ALERT_DIALOG ,
  BANNER ,
  BUTTON ,
  CAPTION ,
  CELL ,
  CHECKBOX ,
  COLUMN_HEADER ,
  COMBO_BOX ,
  COMMAND ,
  COMPOSITE ,
  DIALOG ,
  DOCUMENT ,
  FEED ,
  FORM ,
  GENERIC ,
  GRID ,
  GRID_CELL ,
  GROUP ,
  HEADING ,
  IMG ,
  INPUT ,
  LABEL ,
  LANDMARK ,
  LEGEND ,
  LINK ,
  LIST ,
  LIST_BOX ,
  LIST_ITEM ,
  LOG ,
  MAIN ,
  MARQUEE ,
  MATH ,
  METER ,
  MENU ,
  MENU_BAR ,
  MENU_ITEM ,
  MENU_ITEM_CHECKBOX ,
  MENU_ITEM_RADIO ,
  NAVIGATION ,
  NONE ,
  NOTE ,
  OPTION ,
  PRESENTATION ,
  PROGRESS_BAR ,
  RADIO ,
  RADIO_GROUP ,
  RANGE ,
  REGION ,
  ROW ,
  ROW_GROUP ,
  ROW_HEADER ,
  SCROLLBAR ,
  SEARCH ,
  SEARCH_BOX ,
  SECTION ,
  SECTION_HEAD ,
  SELECT ,
  SEPARATOR ,
  SLIDER ,
  SPIN_BUTTON ,
  STATUS ,
  STRUCTURE ,
  SWITCH ,
  TAB ,
  TABLE ,
  TAB_LIST ,
  TAB_PANEL ,
  TEXT_BOX ,
  TIME ,
  TIMER ,
  TOOLBAR ,
  TOOLTIP ,
  TREE ,
  TREE_GRID ,
  TREE_ITEM ,
  WIDGET ,
  WINDOW
}
 The accessible role for a Gtk::Accessible implementation. More...
 
enum class  State {
  BUSY ,
  CHECKED ,
  DISABLED ,
  EXPANDED ,
  HIDDEN ,
  INVALID ,
  PRESSED ,
  SELECTED
}
 The possible accessible states of a Gtk::Accessible. More...
 
enum class  Property {
  AUTOCOMPLETE ,
  DESCRIPTION ,
  HAS_POPUP ,
  KEY_SHORTCUTS ,
  LABEL ,
  LEVEL ,
  MODAL ,
  MULTI_LINE ,
  MULTI_SELECTABLE ,
  ORIENTATION ,
  PLACEHOLDER ,
  READ_ONLY ,
  REQUIRED ,
  ROLE_DESCRIPTION ,
  SORT ,
  VALUE_MAX ,
  VALUE_MIN ,
  VALUE_NOW ,
  VALUE_TEXT
}
 The possible accessible properties of a Gtk::Accessible. More...
 
enum class  Relation {
  ACTIVE_DESCENDANT ,
  COL_COUNT ,
  COL_INDEX ,
  COL_INDEX_TEXT ,
  COL_SPAN ,
  CONTROLS ,
  DESCRIBED_BY ,
  DETAILS ,
  ERROR_MESSAGE ,
  FLOW_TO ,
  LABELLED_BY ,
  OWNS ,
  POS_IN_SET ,
  ROW_COUNT ,
  ROW_INDEX ,
  ROW_INDEX_TEXT ,
  ROW_SPAN ,
  SET_SIZE
}
 The possible accessible relations of a Gtk::Accessible. More...
 
- Public Types inherited from Gtk::Scrollable
enum class  Policy {
  MINIMUM ,
  NATURAL
}
 Defines the policy to be used in a scrollable widget when updating the scrolled window adjustments in a given orientation. More...
 

Public Member Functions

 ListViewText (guint columns_count, bool editable=false, Gtk::SelectionMode mode=Gtk::SelectionMode::SINGLE)
 
 ~ListViewText () noexcept override
 
void set_column_title (guint column, const Glib::ustring & title)
 Adds a title to column column. More...
 
Glib::ustring get_column_title (guint column) const
 Gets the title of column column. More...
 
guint append (const Glib::ustring & column_one_value={})
 Add a new row at the end of the list. More...
 
void prepend (const Glib::ustring & column_one_value={})
 Insert a new row at the beginning of the list. More...
 
void insert (guint row, const Glib::ustring & column_one_value={})
 Insert a new row at an arbitrary position in the list. More...
 
void clear_items ()
 Discard all row: More...
 
Glib::ustring get_text (guint row, guint column=0) const
 Obtain the value of an existing cell from the list. More...
 
void set_text (guint row, guint column, const Glib::ustring & value)
 Change an existing value of cell of the list. More...
 
void set_text (guint row, const Glib::ustring & value)
 Change an existing value of a column 0 of a row of the list. More...
 
guint size () const
 
guint get_num_columns () const
 
SelectionList get_selected ()
 Returns a vector of the indexes of the selected rows. More...
 
- Public Member Functions inherited from Gtk::TreeView
 TreeView (TreeView && src) noexcept
 
TreeViewoperator= (TreeView && src) noexcept
 
 TreeView (const TreeView &)=delete
 
TreeViewoperator= (const TreeView &)=delete
 
 ~TreeView () noexcept override
 
GtkTreeView * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkTreeView * gobj () const
 Provides access to the underlying C GObject. More...
 
 TreeView ()
 Default constructor. More...
 
 TreeView (const Glib::RefPtr< TreeModel > & model)
 Constructor that binds to a TreeModel. More...
 
Glib::RefPtr< TreeModelget_model ()
 Returns the model the Gtk::TreeView is based on. More...
 
Glib::RefPtr< const TreeModelget_model () const
 Returns the model the Gtk::TreeView is based on. More...
 
void set_model (const Glib::RefPtr< TreeModel > & model)
 Sets the model for a Gtk::TreeView. More...
 
void unset_model ()
 Remove the model from the TreeView. More...
 
Glib::RefPtr< TreeSelectionget_selection ()
 Gets the Gtk::TreeSelection associated with tree_view. More...
 
Glib::RefPtr< const TreeSelectionget_selection () const
 Gets the Gtk::TreeSelection associated with tree_view. More...
 
bool get_headers_visible () const
 Returns true if the headers on the tree_view are visible. More...
 
void set_headers_visible (bool headers_visible=true)
 Sets the visibility state of the headers. More...
 
void columns_autosize ()
 Resizes all columns to their optimal width. More...
 
bool get_headers_clickable () const
 Returns whether all header columns are clickable. More...
 
void set_headers_clickable (bool setting=true)
 Allow the column title buttons to be clicked. More...
 
void set_activate_on_single_click (bool single=true)
 Cause the Gtk::TreeView::row-activated signal to be emitted on a single click instead of a double click. More...
 
bool get_activate_on_single_click () const
 Gets the setting set by set_activate_on_single_click(). More...
 
int append_column (TreeViewColumn & column)
 Appends column to the list of columns. More...
 
template<class ColumnType >
int append_column (const Glib::ustring & title, const TreeModelColumn< ColumnType > & model_column)
 Appends a View column with the appropriate CellRenderer for the Model column. More...
 
template<class ColumnType >
int append_column_numeric (const Glib::ustring & title, const TreeModelColumn< ColumnType > & model_column, const Glib::ustring & format)
 Like append_column(), but only for numeric types, which will be displayed in the specified format. More...
 
template<class ColumnType >
int append_column_editable (const Glib::ustring & title, const TreeModelColumn< ColumnType > & model_column)
 Appends a View column with the appropriate CellRenderer for the Model column. More...
 
template<class ColumnType >
int append_column_numeric_editable (const Glib::ustring & title, const TreeModelColumn< ColumnType > & model_column, const Glib::ustring & format)
 Like append_column_editable(), but only for numeric types, which will be displayed in the specified format. More...
 
int append_column (const Glib::ustring & title, CellRenderer & cell)
 Creates a View column containing the CellRenderer, and appends it. More...
 
int remove_column (TreeViewColumn & column)
 Removes column from tree_view. More...
 
void remove_all_columns ()
 Removes all View columns. More...
 
int insert_column (TreeViewColumn & column, int position)
 This inserts the column into the tree_view at position. More...
 
int insert_column (const Glib::ustring & title, CellRenderer & cell, int position)
 Creates a View column containing the CellRenderer, and inserts it. More...
 
template<class ColumnType >
int insert_column (const Glib::ustring & title, const TreeModelColumn< ColumnType > & model_column, int position)
 Inserts a View column with the appropriate CellRenderer for the Model column. More...
 
template<class ColumnType >
int insert_column_editable (const Glib::ustring & title, const TreeModelColumn< ColumnType > & model_column, int position)
 Inserts a View column with the appropriate CellRenderer for the Model column. More...
 
int insert_column_with_data_func (int position, const Glib::ustring & title, CellRenderer & cell, const SlotTreeCellData & slot)
 Inserts a new column into the TreeView with the given cell renderer and a SlotTreeCellData to set cell renderer attributes (normally using data from the model). More...
 
guint get_n_columns () const
 Queries the number of columns in the given tree_view. More...
 
TreeViewColumnget_column (int n)
 Gets the Gtk::TreeViewColumn at the given position in the #tree_view. More...
 
const TreeViewColumnget_column (int n) const
 Gets the Gtk::TreeViewColumn at the given position in the #tree_view. More...
 
CellRendererget_column_cell_renderer (int n)
 Gets the CellRenderer for that column. More...
 
const CellRendererget_column_cell_renderer (int n) const
 Gets the CellRenderer for that column. More...
 
std::vector< TreeViewColumn * > get_columns ()
 Returns a list of all the Gtk::TreeViewColumn s currently in tree_view. More...
 
std::vector< const TreeViewColumn * > get_columns () const
 Returns a list of all the Gtk::TreeViewColumn s currently in tree_view. More...
 
void move_column_after (TreeViewColumn & column, TreeViewColumn & base_column)
 Moves column to be after to base_column. More...
 
void move_column_to_start (TreeViewColumn & column)
 This method moves column to the first position in the view. More...
 
void set_expander_column (TreeViewColumn & column)
 Sets the column to draw the expander arrow at. More...
 
void reset_expander_column ()
 This method resets the expander arrow to the default - the first visible column. More...
 
TreeViewColumnget_expander_column ()
 Returns the column that is the current expander column, or nullptr if none has been set. More...
 
const TreeViewColumnget_expander_column () const
 Returns the column that is the current expander column, or nullptr if none has been set. More...
 
void set_column_drag_function (const SlotColumnDrop & slot)
 Sets a callback slot for determining where a column may be dropped when dragged. More...
 
void unset_column_drag_function ()
 See set_column_drag_function(). More...
 
void scroll_to_point (int tree_x, int tree_y)
 Scrolls the tree view such that the top-left corner of the visible area is tree_x, tree_y, where tree_x and tree_y are specified in tree coordinates. More...
 
void scroll_to_cell (const TreeModel::Path & path, TreeViewColumn & column, float row_align, float col_align)
 Moves the alignments of tree view to the position specified by column and path. More...
 
void scroll_to_cell (const TreeModel::Path & path, TreeViewColumn & column)
 Moves the alignments of tree view to the position specified by column and path. More...
 
void scroll_to_row (const TreeModel::Path & path, float row_align)
 Moves the alignments of tree view to the position specified by path. More...
 
void scroll_to_row (const TreeModel::Path & path)
 Moves the alignments of tree view to the position specified by path. More...
 
void scroll_to_column (TreeViewColumn & column, float col_align)
 Moves the alignments of tree view to the position specified by column. More...
 
void scroll_to_column (TreeViewColumn & column)
 Moves the alignments of tree view to the position specified by column. More...
 
void row_activated (const TreeModel::Path & path, TreeViewColumn & column)
 Activates the cell determined by path and column. More...
 
void expand_all ()
 Recursively expands all nodes in the tree_view. More...
 
void collapse_all ()
 Recursively collapses all visible, expanded nodes in tree_view. More...
 
void expand_to_path (const TreeModel::Path & path)
 Expands the row at path. More...
 
bool expand_row (const TreeModel::Path & path, bool open_all)
 Opens the row so its children are visible. More...
 
bool collapse_row (const TreeModel::Path & path)
 Collapses a row (hides its child rows, if they exist). More...
 
void map_expanded_rows (const SlotMapping & slot)
 Calls the callback slot on all expanded rows. More...
 
bool row_expanded (const TreeModel::Path & path)
 Returns true if the node pointed to by path is expanded in tree_view. More...
 
void set_reorderable (bool reorderable=true)
 This function is a convenience function to allow you to reorder models that support the Gtk::TreeDragSourceIface and the Gtk::TreeDragDestIface. More...
 
bool get_reorderable () const
 Retrieves whether the user can reorder the tree via drag-and-drop. More...
 
void set_cursor (const TreeModel::Path & path, TreeViewColumn & focus_column, bool start_editing=false)
 Sets the current keyboard focus to be at path, and selects it. More...
 
void set_cursor (const TreeModel::Path & path, TreeViewColumn & focus_column, CellRenderer & focus_cell, bool start_editing=false)
 Sets the current keyboard focus to be at path, and selects it. More...
 
void set_cursor (const TreeModel::Path & path)
 Sets the current keyboard focus to be at path , and selects it. More...
 
void get_cursor (TreeModel::Path & path, TreeViewColumn *& focus_column)
 Fills in path and focus_column with the current path and focus column. More...
 
bool get_path_at_pos (int x, int y, TreeModel::Path & path, TreeViewColumn *& column, int & cell_x, int & cell_y) const
 Finds the path at the point (x, y), relative to bin_window coordinates. More...
 
bool get_path_at_pos (int x, int y, TreeModel::Path & path) const
 Finds the path at the point (x, y), relative to bin_window coordinates. More...
 
void get_cell_area (const TreeModel::Path & path, TreeViewColumn & column, Gdk::Rectangle & rect) const
 Fills the bounding rectangle in tree window coordinates for the cell at the row specified by path and the column specified by column. More...
 
void get_background_area (const TreeModel::Path & path, TreeViewColumn & column, Gdk::Rectangle & rect) const
 Fills the bounding rectangle in tree window coordinates for the cell at the row specified by path and the column specified by column. More...
 
void get_visible_rect (Gdk::Rectangle & visible_rect) const
 Fills visible_rect with the currently-visible region of the buffer, in tree coordinates. More...
 
bool get_visible_range (TreeModel::Path & start_path, TreeModel::Path & end_path) const
 
bool is_blank_at_pos (int x, int y, TreePath & path, TreeViewColumn *& column, int & cell_x, int & cell_y) const
 Determine whether the point (x, y) in the tree view is blank, that is no cell content nor an expander arrow is drawn at the location. More...
 
bool is_blank_at_pos (int x, int y) const
 Determine whether the point (x, y) in the tree view is blank, that is no cell content nor an expander arrow is drawn at the location. More...
 
void enable_model_drag_source (const Glib::RefPtr< const Gdk::ContentFormats > & formats, Gdk::ModifierType start_button_mask=static_cast< Gdk::ModifierType >(GDK_MODIFIER_MASK), Gdk::DragAction actions=Gdk::DragAction::COPY|Gdk::DragAction::MOVE)
 Turns tree_view into a drag source for automatic DND. More...
 
void enable_model_drag_source (Gdk::ModifierType start_button_mask=static_cast< Gdk::ModifierType >(GDK_MODIFIER_MASK), Gdk::DragAction actions=Gdk::DragAction::COPY|Gdk::DragAction::MOVE)
 Turns the TreeView into a drag source for automatic DND. More...
 
void enable_model_drag_dest (const Glib::RefPtr< const Gdk::ContentFormats > & formats, Gdk::DragAction actions=Gdk::DragAction::COPY|Gdk::DragAction::MOVE)
 Turns tree_view into a drop destination for automatic DND. More...
 
void enable_model_drag_dest (Gdk::DragAction actions=Gdk::DragAction::COPY|Gdk::DragAction::MOVE)
 Turns the TreeView into a drop destination for automatic DND. More...
 
void unset_rows_drag_source ()
 Undoes the effect of enable_model_drag_source() More...
 
void unset_rows_drag_dest ()
 Undoes the effect of enable_model_drag_dest() More...
 
void set_drag_dest_row (const TreeModel::Path & path, DropPosition pos)
 Sets the row that is highlighted for feedback. More...
 
void unset_drag_dest_row ()
 Remove an existing highlight. More...
 
void get_drag_dest_row (TreeModel::Path & path, DropPosition & pos) const
 Gets information about the row that is highlighted for feedback. More...
 
bool get_dest_row_at_pos (int drag_x, int drag_y, TreeModel::Path & path, DropPosition & pos) const
 Determines the destination row for a given position. More...
 
Glib::RefPtr< Gdk::Paintablecreate_row_drag_icon (const TreeModel::Path & path) const
 Creates a cairo_surface_t representation of the row at path. More...
 
void set_enable_search (bool enable_search=true)
 If enable_search is set, then the user can type in text to search through the tree interactively (this is sometimes called "typeahead find"). More...
 
bool get_enable_search () const
 Returns whether or not the tree allows to start interactive searching by typing in text. More...
 
int get_search_column () const
 Gets the column searched on by the interactive search code. More...
 
void set_search_column (const TreeModelColumnBase & column)
 Sets column as the column where the interactive search code should search in for the current model. More...
 
void set_search_column (int column)
 Sets column as the column where the interactive search code should search in for the current model. More...
 
void set_search_equal_func (const SlotSearchEqual & slot)
 Sets the compare function for the interactive search capabilities. More...
 
Editableget_search_entry ()
 Returns the Gtk::Entry which is currently in use as interactive search entry for tree_view. More...
 
const Editableget_search_entry () const
 Returns the Gtk::Entry which is currently in use as interactive search entry for tree_view. More...
 
void set_search_entry (Editable & entry)
 Sets the entry which the interactive search code will use for this tree_view. More...
 
void convert_widget_to_tree_coords (int wx, int wy, int & tx, int & ty) const
 Converts widget coordinates to coordinates for the tree (the full scrollable area of the tree). More...
 
void convert_tree_to_widget_coords (int tx, int ty, int & wx, int & wy) const
 Converts tree coordinates (coordinates in full scrollable area of the tree) to widget coordinates. More...
 
void convert_widget_to_bin_window_coords (int wx, int wy, int & bx, int & by) const
 Converts widget coordinates to coordinates for the bin_window. More...
 
void convert_bin_window_to_widget_coords (int bx, int by, int & wx, int & wy) const
 Converts bin_window coordinates to widget relative coordinates. More...
 
void convert_tree_to_bin_window_coords (int tx, int ty, int & bx, int & by) const
 Converts tree coordinates (coordinates in full scrollable area of the tree) to bin_window coordinates. More...
 
void convert_bin_window_to_tree_coords (int bx, int by, int & tx, int & ty) const
 Converts bin_window coordinates to coordinates for the tree (the full scrollable area of the tree). More...
 
void set_fixed_height_mode (bool enable=true)
 Enables or disables the fixed height mode of tree_view. More...
 
bool get_fixed_height_mode () const
 Returns whether fixed height mode is turned on for tree_view. More...
 
void set_hover_selection (bool hover=true)
 Enables or disables the hover selection mode of tree_view. More...
 
bool get_hover_selection () const
 Returns whether hover selection mode is turned on for tree_view. More...
 
void set_hover_expand (bool expand=true)
 Enables or disables the hover expansion mode of tree_view. More...
 
bool get_hover_expand () const
 Returns whether hover expansion mode is turned on for tree_view. More...
 
void set_rubber_banding (bool enable=true)
 Enables or disables rubber banding in tree_view. More...
 
bool get_rubber_banding () const
 Returns whether rubber banding is turned on for tree_view. More...
 
bool is_rubber_banding_active () const
 Returns whether a rubber banding operation is currently being done in tree_view. More...
 
void set_row_separator_func (const SlotRowSeparator & slot)
 Sets the row separator function, which is used to determine whether a row should be drawn as a separator. More...
 
void unset_row_separator_func ()
 Removes the row separator function, so no separators are drawn. More...
 
void set_grid_lines (GridLines grid_lines)
 Sets which grid lines to draw in tree_view. More...
 
GridLines get_grid_lines () const
 Returns which grid lines are enabled in tree_view. More...
 
void set_enable_tree_lines (bool enable=true)
 Sets whether to draw lines interconnecting the expanders in tree_view. More...
 
bool get_enable_tree_lines () const
 Returns whether or not tree lines are drawn in tree_view. More...
 
void set_show_expanders (bool enabled=true)
 Sets whether to draw and enable expanders and indent child rows in tree_view. More...
 
bool get_show_expanders () const
 Returns whether or not expanders are drawn in tree_view. More...
 
void set_level_indentation (int indentation)
 Sets the amount of extra indentation for child levels to use in tree_view in addition to the default indentation. More...
 
int get_level_indentation () const
 Returns the amount, in pixels, of extra indentation for child levels in tree_view. More...
 
void set_tooltip_row (const Glib::RefPtr< Tooltip > & tooltip, const TreePath & path)
 Sets the tip area of tooltip to be the area covered by the row at path. More...
 
void set_tooltip_cell (const Glib::RefPtr< Tooltip > & tooltip, const TreeModel::Path * path, TreeViewColumn * column, CellRenderer * cell)
 Sets the tip area of tooltip to the area path, column and cell have in common. More...
 
bool get_tooltip_context_path (int x, int y, bool keyboard_tip, TreeModel::Path & path)
 This function is supposed to be used in a Gtk::Widget::query-tooltip signal handler for Gtk::TreeView. More...
 
bool get_tooltip_context_iter (int x, int y, bool keyboard_tip, Gtk::TreeModel::iterator & iter)
 This function is supposed to be used in a Gtk::Widget::query-tooltip signal handler for Gtk::TreeView. More...
 
void set_tooltip_column (int column)
 If you only plan to have simple (text-only) tooltips on full rows, you can use this function to have Gtk::TreeView handle these automatically for you. More...
 
int get_tooltip_column () const
 Returns the column of tree_view’s model which is being used for displaying tooltips on tree_view’s rows. More...
 
Glib::SignalProxy< void(const TreeModel::Path &, TreeViewColumn *)> signal_row_activated ()
 
Glib::SignalProxy< bool(const TreeModel::iterator &, const TreeModel::Path &)> signal_test_expand_row ()
 
Glib::SignalProxy< bool(const TreeModel::iterator &, const TreeModel::Path &)> signal_test_collapse_row ()
 
Glib::SignalProxy< void(const TreeModel::iterator &, const TreeModel::Path &)> signal_row_expanded ()
 
Glib::SignalProxy< void(const TreeModel::iterator &, const TreeModel::Path &)> signal_row_collapsed ()
 
Glib::SignalProxy< void()> signal_cursor_changed ()
 
Glib::SignalProxy< void()> signal_columns_changed ()
 
Glib::PropertyProxy< Glib::RefPtr< TreeModel > > property_model ()
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< TreeModel > > property_model () const
 
Glib::PropertyProxy< bool > property_headers_visible ()
 Default value: true More...
 
Glib::PropertyProxy_ReadOnly< bool > property_headers_visible () const
 Default value: true More...
 
Glib::PropertyProxy< bool > property_headers_clickable ()
 Default value: true More...
 
Glib::PropertyProxy_ReadOnly< bool > property_headers_clickable () const
 Default value: true More...
 
Glib::PropertyProxy< TreeViewColumn * > property_expander_column ()
 
Glib::PropertyProxy_ReadOnly< TreeViewColumn * > property_expander_column () const
 
Glib::PropertyProxy< bool > property_reorderable ()
 Default value: false More...
 
Glib::PropertyProxy_ReadOnly< bool > property_reorderable () const
 Default value: false More...
 
Glib::PropertyProxy< bool > property_enable_search ()
 Default value: true More...
 
Glib::PropertyProxy_ReadOnly< bool > property_enable_search () const
 Default value: true More...
 
Glib::PropertyProxy< int > property_search_column ()
 Default value: -1. More...
 
Glib::PropertyProxy_ReadOnly< int > property_search_column () const
 Default value: -1. More...
 
Glib::PropertyProxy< bool > property_fixed_height_mode ()
 Setting the property_fixed_height_mode() property to true speeds up Gtk::TreeView by assuming that all rows have the same height. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_fixed_height_mode () const
 Setting the property_fixed_height_mode() property to true speeds up Gtk::TreeView by assuming that all rows have the same height. More...
 
Glib::PropertyProxy< bool > property_hover_selection ()
 Enables or disables the hover selection mode of tree_view. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_hover_selection () const
 Enables or disables the hover selection mode of tree_view. More...
 
Glib::PropertyProxy< bool > property_hover_expand ()
 Enables or disables the hover expansion mode of tree_view. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_hover_expand () const
 Enables or disables the hover expansion mode of tree_view. More...
 
Glib::PropertyProxy< bool > property_show_expanders ()
 true if the view has expanders. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_show_expanders () const
 true if the view has expanders. More...
 
Glib::PropertyProxy< bool > property_level_indentation ()
 Extra indentation for each level. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_level_indentation () const
 Extra indentation for each level. More...
 
Glib::PropertyProxy< bool > property_rubber_banding ()
 Default value: false More...
 
Glib::PropertyProxy_ReadOnly< bool > property_rubber_banding () const
 Default value: false More...
 
Glib::PropertyProxy< bool > property_enable_grid_lines ()
 Default value: Gtk::TreeView::GridLines::NONE. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_enable_grid_lines () const
 Default value: Gtk::TreeView::GridLines::NONE. More...
 
Glib::PropertyProxy< bool > property_enable_tree_lines ()
 Default value: false More...
 
Glib::PropertyProxy_ReadOnly< bool > property_enable_tree_lines () const
 Default value: false More...
 
Glib::PropertyProxy< int > property_tooltip_column ()
 Default value: -1. More...
 
Glib::PropertyProxy_ReadOnly< int > property_tooltip_column () const
 Default value: -1. More...
 
Glib::PropertyProxy< bool > property_activate_on_single_click ()
 The activate-on-single-click property specifies whether the "row-activated" signal will be emitted after a single click. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_activate_on_single_click () const
 The activate-on-single-click property specifies whether the "row-activated" signal will be emitted after a single click. More...
 
- Public Member Functions inherited from Gtk::Widget
 Widget (Widget && src) noexcept
 
Widgetoperator= (Widget && src) noexcept
 
 Widget (const Widget &)=delete
 
Widgetoperator= (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< ConstraintTargetmake_refptr_constrainttarget ()
 Converts this widget to a reference counted Gtk::ConstraintTarget. More...
 
Glib::RefPtr< const ConstraintTargetmake_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(). More...
 
void queue_draw ()
 Schedules this widget to be redrawn in the paint phase of the current or the next frame. More...
 
void queue_resize ()
 Flags a widget to have its size renegotiated. More...
 
void queue_allocate ()
 Flags the widget for a rerun of the size_allocate_vfunc() function. More...
 
void size_allocate (const Allocation & allocation, int baseline)
 Allocates widget with a transformation that translates the origin to the position in 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< LayoutManagerget_layout_manager ()
 Retrieves the layout manager used by widget. More...
 
Glib::RefPtr< const LayoutManagerget_layout_manager () const
 Retrieves the layout manager used by widget. More...
 
bool mnemonic_activate (bool group_cycling)
 Emits the 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 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)
 Sets a widgets name. 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)
 Turns on flag values in the current widget state. More...
 
void unset_state_flags (StateFlags flags)
 Turns off flag values for the current widget state. 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. More...
 
bool is_sensitive () const
 Returns the widget’s effective sensitivity. 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 parent. 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. More...
 
int get_height () const
 Returns the content height of the widget. More...
 
int get_size (Orientation orientation) const
 Returns the content width or height of the widget. More...
 
Widgetget_parent ()
 Returns the parent widget of widget. More...
 
const Widgetget_parent () const
 Returns the parent widget of widget. More...
 
Rootget_root ()
 Returns the Gtk::Root widget of widget. More...
 
const Rootget_root () const
 Returns the Gtk::Root widget of widget. More...
 
Nativeget_native ()
 Returns the nearest Gtk::Native ancestor of widget. More...
 
const Nativeget_native () const
 Returns the nearest Gtk::Native ancestor of widget. More...
 
bool child_focus (DirectionType direction)
 Called by widgets as the user moves around the window using keyboard shortcuts. More...
 
bool keynav_failed (DirectionType direction)
 Emits the ::keynav-failed signal on the widget. 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. 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. 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 widgets overflow value. More...
 
Widgetget_ancestor (GType widget_type)
 Gets the first ancestor of widget with type widget_type. More...
 
const Widgetget_ancestor (GType widget_type) const
 Gets the first ancestor of widget with type widget_type. More...
 
int get_scale_factor () const
 Retrieves the internal scale factor that maps from window coordinates to the actual device pixels. More...
 
Glib::RefPtr< Gdk::Displayget_display ()
 Get the Gdk::Display for the toplevel window associated with this widget. More...
 
Glib::RefPtr< const Gdk::Displayget_display () const
 Get the Gdk::Display for the toplevel window associated with this widget. More...
 
Glib::RefPtr< Settingsget_settings ()
 Gets the settings object holding the settings used for this widget. More...
 
Glib::RefPtr< Gdk::Clipboardget_clipboard ()
 Gets the clipboard object for widget. More...
 
Glib::RefPtr< const Gdk::Clipboardget_clipboard () const
 Gets the clipboard object for widget. More...
 
Glib::RefPtr< Gdk::Clipboardget_primary_clipboard ()
 Gets the primary clipboard of widget. More...
 
Glib::RefPtr< const Gdk::Clipboardget_primary_clipboard () const
 Gets the primary clipboard of 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 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 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 horizontal alignment of widget. More...
 
void set_halign (Align align)
 Sets the horizontal alignment of widget. More...
 
Align get_valign () const
 Gets the vertical alignment of widget. More...
 
void set_valign (Align align)
 Sets the vertical alignment of widget. More...
 
int get_margin_start () const
 Gets the start margin of widget. More...
 
void set_margin_start (int margin)
 Sets the start margin of widget. More...
 
int get_margin_end () const
 Gets the end margin of widget. More...
 
void set_margin_end (int margin)
 Sets the end margin of widget. More...
 
int get_margin_top () const
 Gets the top margin of widget. More...
 
void set_margin_top (int margin)
 Sets the top margin of widget. More...
 
int get_margin_bottom () const
 Gets the bottom margin of widget. 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...
 
Widgetpick (double x, double y, PickFlags flags=PickFlags::DEFAULT)
 Finds the descendant of widget closest to the point ( x, y). More...
 
const Widgetpick (double x, double y, PickFlags flags=PickFlags::DEFAULT) const
 Finds the descendant of widget closest to 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 of widget. More...
 
Glib::RefPtr< Pango::Layout > create_pango_layout (const Glib::ustring & text)
 Creates a new Pango::Layout with the appropriate font map, font description, and base direction for drawing text for this widget. More...
 
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::Cursorget_cursor ()
 Queries the cursor set on widget. More...
 
Glib::RefPtr< const Gdk::Cursorget_cursor () const
 Queries the cursor set on widget. More...
 
std::vector< Widget * > list_mnemonic_labels ()
 Returns the widgets for which this widget is the target of a mnemonic. More...
 
std::vector< const Widget * > list_mnemonic_labels () const
 Returns the widgets for which this widget is the target of a mnemonic. 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 drag movement has passed the GTK drag threshold. More...
 
Glib::RefPtr< Gdk::FrameClockget_frame_clock ()
 Obtains the frame clock for a widget. More...
 
Glib::RefPtr< const Gdk::FrameClockget_frame_clock () const
 Obtains the frame clock for a widget. More...
 
void set_parent (Widget & parent)
 Sets parent as the parent widget of widget. More...
 
void unparent ()
 Dissociate widget from its parent. More...
 
void map ()
 Causes a widget to be mapped if it isn’t already. More...
 
void unmap ()
 Causes a widget to be unmapped if it’s currently mapped. More...
 
void trigger_tooltip_query ()
 Triggers a tooltip query on the display where the toplevel of widget is located. More...
 
void set_tooltip_text (const Glib::ustring & text)
 Sets text as the contents of the tooltip. More...
 
Glib::ustring get_tooltip_text () const
 Gets the contents of the tooltip for widget. More...
 
void set_tooltip_markup (const Glib::ustring & markup)
 Sets markup as the contents of the tooltip, which is marked up with the Pango text markup language. More...
 
Glib::ustring get_tooltip_markup () const
 Gets the contents of the tooltip for widget. More...
 
void set_has_tooltip (bool has_tooltip=TRUE)
 Sets the has-tooltip property on widget to has_tooltip. More...
 
bool get_has_tooltip () const
 Returns the current value of the has-tooltip property. More...
 
bool in_destruction () const
 Returns whether the widget is currently being destroyed. More...
 
Glib::RefPtr< StyleContextget_style_context ()
 Returns the style context associated to widget. More...
 
Glib::RefPtr< const StyleContextget_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 ()
 Activates 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 of widget. More...
 
Glib::RefPtr< const Pango::FontMap > get_font_map () const
 Gets the font map of widget. More...
 
Widgetget_first_child ()
 Returns the widgets first child. More...
 
const Widgetget_first_child () const
 Returns the widgets first child. More...
 
Widgetget_last_child ()
 Returns the widgets last child. More...
 
const Widgetget_last_child () const
 Returns the widgets last child. More...
 
Widgetget_next_sibling ()
 Returns the widgets next sibling. More...
 
const Widgetget_next_sibling () const
 Returns the widgets next sibling. More...
 
Widgetget_prev_sibling ()
 Returns the widgets previous sibling. More...
 
const Widgetget_prev_sibling () const
 Returns the widgets previous sibling. More...
 
Glib::RefPtr< Gio::ListModel > observe_children ()
 Returns a Gio::ListModel to track the children of widget. More...
 
Glib::RefPtr< const Gio::ListModel > observe_children () const
 Returns a Gio::ListModel to track the children of widget. More...
 
Glib::RefPtr< Gio::ListModel > observe_controllers ()
 Returns a Gio::ListModel to track the Gtk::EventControllers of widget. More...
 
Glib::RefPtr< const Gio::ListModel > observe_controllers () const
 Returns a Gio::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)
 Snapshot the a child of widget. 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 a style class to widget. More...
 
void remove_css_class (const Glib::ustring & css_class)
 Removes a style 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 style classes applied to widget. More...
 
void set_css_classes (const std::vector< Glib::ustring > & classes)
 Clear all style classes applied to widget and replace them with classes. More...
 
Gdk::RGBA get_color () const
 Gets the current foreground color for the widget's CSS style. 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< void()> signal_destroy ()
 Emitted during the dispose phase. More...
 
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. More...
 
Glib::PropertyProxy< int > property_width_request ()
 Override for width request of the widget. More...
 
Glib::PropertyProxy_ReadOnly< int > property_width_request () const
 Override for width request of the widget. More...
 
Glib::PropertyProxy< int > property_height_request ()
 Override for height request of the widget. More...
 
Glib::PropertyProxy_ReadOnly< int > property_height_request () const
 Override for height request of the widget. 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 ()
 Whether the widget will receive the default action when it is focused. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_receives_default () const
 Whether 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 the signal_query_tooltip() signal on widget. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_has_tooltip () const
 Enables or disables the emission of the signal_query_tooltip() signal 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 Pango markup. 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 Pango markup. 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< Alignproperty_halign ()
 How to distribute horizontal space if widget gets extra space. More...
 
Glib::PropertyProxy_ReadOnly< Alignproperty_halign () const
 How to distribute horizontal space if widget gets extra space. More...
 
Glib::PropertyProxy< Alignproperty_valign ()
 How to distribute vertical space if widget gets extra space. More...
 
Glib::PropertyProxy_ReadOnly< Alignproperty_valign () const
 How to distribute vertical space if widget gets extra space. 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 hexpand property. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_hexpand_set () const
 Whether to use the 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 vexpand property. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_vexpand_set () const
 Whether to use the 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< Overflowproperty_overflow ()
 How content outside the widget's content area is treated. More...
 
Glib::PropertyProxy_ReadOnly< Overflowproperty_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
 
Objectoperator= (Object && src) noexcept
 
 ~Object () noexcept override
 
- Public Member Functions inherited from Gtk::Accessible
 Accessible (Accessible && src) noexcept
 
Accessibleoperator= (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< Roleproperty_accessible_role ()
 The accessible role of the given Gtk::Accessible implementation. More...
 
Glib::PropertyProxy_ReadOnly< Roleproperty_accessible_role () const
 The accessible role of the given Gtk::Accessible implementation. More...
 
- Public Member Functions inherited from Gtk::Buildable
 Buildable (Buildable && src) noexcept
 
Buildableoperator= (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
 
ConstraintTargetoperator= (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...
 
- Public Member Functions inherited from Gtk::Scrollable
 Scrollable (Scrollable && src) noexcept
 
Scrollableoperator= (Scrollable && src) noexcept
 
 ~Scrollable () noexcept override
 
GtkScrollable * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkScrollable * gobj () const
 Provides access to the underlying C GObject. More...
 
Glib::RefPtr< Adjustmentget_hadjustment ()
 Retrieves the Gtk::Adjustment used for horizontal scrolling. More...
 
Glib::RefPtr< const Adjustmentget_hadjustment () const
 Retrieves the Gtk::Adjustment used for horizontal scrolling. More...
 
void set_hadjustment (const Glib::RefPtr< Adjustment > & hadjustment)
 Sets the horizontal adjustment of the Gtk::Scrollable. More...
 
void unset_hadjustment ()
 This method removes the hadjustment. More...
 
Glib::RefPtr< Adjustmentget_vadjustment ()
 Retrieves the Gtk::Adjustment used for vertical scrolling. More...
 
Glib::RefPtr< const Adjustmentget_vadjustment () const
 Retrieves the Gtk::Adjustment used for vertical scrolling. More...
 
void set_vadjustment (const Glib::RefPtr< Adjustment > & vadjustment)
 Sets the vertical adjustment of the Gtk::Scrollable. More...
 
void unset_vadjustment ()
 This method removes the vadjustment. More...
 
Policy get_hscroll_policy () const
 Gets the horizontal Gtk::Scrollable::Policy. More...
 
void set_hscroll_policy (Policy policy)
 Sets the Gtk::Scrollable::Policy. More...
 
Policy get_vscroll_policy () const
 Gets the vertical Gtk::Scrollable::Policy. More...
 
void set_vscroll_policy (Policy policy)
 Sets the Gtk::Scrollable::Policy. More...
 
bool get_border (Border & border) const
 Returns the size of a non-scrolling border around the outside of the scrollable. More...
 
Glib::PropertyProxy< Glib::RefPtr< Adjustment > > property_hadjustment ()
 Horizontal Gtk::Adjustment of the scrollable widget. More...
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Adjustment > > property_hadjustment () const
 Horizontal Gtk::Adjustment of the scrollable widget. More...
 
Glib::PropertyProxy< Glib::RefPtr< Adjustment > > property_vadjustment ()
 Vertical Gtk::Adjustment of the scrollable widget. More...
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Adjustment > > property_vadjustment () const
 Vertical Gtk::Adjustment of the scrollable widget. More...
 
Glib::PropertyProxy< Policyproperty_hscroll_policy ()
 Determines when horizontal scrolling should start. More...
 
Glib::PropertyProxy_ReadOnly< Policyproperty_hscroll_policy () const
 Determines when horizontal scrolling should start. More...
 
Glib::PropertyProxy< Policyproperty_vscroll_policy ()
 Determines when vertical scrolling should start. More...
 
Glib::PropertyProxy_ReadOnly< Policyproperty_vscroll_policy () const
 Determines when vertical scrolling should start. More...
 

Protected Attributes

Glib::RefPtr< Gtk::ListStorem_model
 
TextModelColumns m_model_columns
 

Additional Inherited Members

- Static Public Member Functions inherited from Gtk::TreeView
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. 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...
 
- Static Public Member Functions inherited from Gtk::Scrollable
static void add_interface (GType gtype_implementer)
 
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 
- Protected Member Functions 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 resources associated with a widget. More...
 
void unrealize ()
 Causes a widget to be unrealized (frees all GDK resources associated with the widget). 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...
 
Widgetget_focus_child ()
 Returns the current focus child of widget. More...
 
const Widgetget_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 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...
 
- Protected Member Functions inherited from Gtk::Scrollable
 Scrollable ()
 You should derive from this class to use it. More...
 
virtual bool get_border_vfunc (Border & border) const
 

Detailed Description

A simple listbox which presents some lines of information in columns and lets the user select some of them.

This is a convenience class, based on Gtk::TreeView, which allows only text values and does not allow child items. In most cases you will actually need the functionality offered by a real Gtk::TreeView with your own type-safe Gtk::TreeModel::ColumnRecord.

Deprecated:
4.10: Use Gtk::ListView for lists, and Gtk::ColumnView for tabular lists.

Member Typedef Documentation

◆ SelectionList

Constructor & Destructor Documentation

◆ ListViewText()

Gtk::ListViewText::ListViewText ( guint  columns_count,
bool  editable = false,
Gtk::SelectionMode  mode = Gtk::SelectionMode::SINGLE 
)

◆ ~ListViewText()

Gtk::ListViewText::~ListViewText ( )
overridenoexcept

Member Function Documentation

◆ append()

guint Gtk::ListViewText::append ( const Glib::ustring &  column_one_value = {})

Add a new row at the end of the list.

Parameters
column_one_valuethe new text for the new row, column 0
Returns
the number of the row added

◆ clear_items()

void Gtk::ListViewText::clear_items ( )

Discard all row:

◆ get_column_title()

Glib::ustring Gtk::ListViewText::get_column_title ( guint  column) const

Gets the title of column column.

Parameters
columnthe column number.
Returns
the title of column column.

◆ get_num_columns()

guint Gtk::ListViewText::get_num_columns ( ) const
Returns
the number of columns in the listbox

◆ get_selected()

SelectionList Gtk::ListViewText::get_selected ( )

Returns a vector of the indexes of the selected rows.

Returns
a SelectionList with the selection results

◆ get_text()

Glib::ustring Gtk::ListViewText::get_text ( guint  row,
guint  column = 0 
) const

Obtain the value of an existing cell from the list.

Parameters
rowthe number of the row in the listbox.
columnthe number of the column in the row.
Returns
the value of that cell, if it exists.

◆ insert()

void Gtk::ListViewText::insert ( guint  row,
const Glib::ustring &  column_one_value = {} 
)

Insert a new row at an arbitrary position in the list.

Parameters
rowThe row number
column_one_valuethe new text for the new row, column 0

◆ prepend()

void Gtk::ListViewText::prepend ( const Glib::ustring &  column_one_value = {})

Insert a new row at the beginning of the list.

Parameters
column_one_valuethe new text for the new row, column 0

◆ set_column_title()

void Gtk::ListViewText::set_column_title ( guint  column,
const Glib::ustring &  title 
)

Adds a title to column column.

Parameters
columnthe column number.
titlethe title for column column.

◆ set_text() [1/2]

void Gtk::ListViewText::set_text ( guint  row,
const Glib::ustring &  value 
)

Change an existing value of a column 0 of a row of the list.

Parameters
rowthe number of the row in the list.
valuethe new contents of column 0 of the row.

◆ set_text() [2/2]

void Gtk::ListViewText::set_text ( guint  row,
guint  column,
const Glib::ustring &  value 
)

Change an existing value of cell of the list.

Parameters
rowthe number of the row in the list.
columnthe number of the column in the row.
valuethe new contents of that row and column.

◆ size()

guint Gtk::ListViewText::size ( ) const
Returns
the number of rows in the listbox

Member Data Documentation

◆ m_model

Glib::RefPtr<Gtk::ListStore> Gtk::ListViewText::m_model
protected

◆ m_model_columns

TextModelColumns Gtk::ListViewText::m_model_columns
protected