Class

GntTree

Description

class Gnt.Tree : Gnt.Widget {
  parent_instance: GntWidget
}
No description available.

Descendants

Constructors

gnt_tree_new

Create a tree with one column.

gnt_tree_new_with_columns

Create a tree with a specified number of columns.

Instance methods

gnt_tree_add_choice

Add a checkable item in the tree.

gnt_tree_add_row_after

Insert a row in the tree.

gnt_tree_add_row_last

Insert a row at the end of the tree.

gnt_tree_adjust_columns

Automatically adjust the width of the columns in the tree.

gnt_tree_change_text

Change the text of a column in a row.

gnt_tree_create_row

Create a row to insert in the tree.

gnt_tree_create_row_from_list

Create a row from a list of text.

gnt_tree_get_choice

Return whether a row is selected or not, where the row is a checkable item.

gnt_tree_get_parent_key

Get the parent key for a row.

since: 2.4

gnt_tree_get_row_text_list

Get a list of text for a row.

gnt_tree_get_rows

Returns the list of rows in the tree.

gnt_tree_get_selection_data

Get the key for the selected row.

gnt_tree_get_selection_text

Get the text displayed for the selected row.

gnt_tree_get_selection_text_list

Get a list of text of the current row.

gnt_tree_get_selection_visible_line

Get the visible line number of the selected row.

gnt_tree_get_visible_rows

Get the number visible rows.

gnt_tree_is_searching

Check whether the user is currently in the middle of a search.

since: 2.1

gnt_tree_remove

Remove a row from the tree.

gnt_tree_remove_all

Remove all the item from the tree.

gnt_tree_row_get_child

Get the child row.

since: 2.7.3

gnt_tree_row_get_key

Get the key of a row.

since: 2.7.3

gnt_tree_row_get_next

Get the next row.

since: 2.7.3

gnt_tree_row_get_parent

Get the parent row.

since: 2.7.3

gnt_tree_row_get_prev

Get the previous row.

since: 2.7.3

gnt_tree_scroll

Scroll the contents of the tree.

gnt_tree_set_choice

Set whether a checkable item is checked or not.

gnt_tree_set_col_width

Set the width of a column in the tree.

gnt_tree_set_column_is_binary

Set whether data in a column should be considered as binary data, and not as strings. A column containing binary data will be display empty text.

gnt_tree_set_column_is_right_aligned

Set whether text in a column should be right-aligned.

since: 2.1

gnt_tree_set_column_resizable

Set whether a column can be resized to keep the same ratio when the tree is resized.

since: 2.1

gnt_tree_set_column_title

Set the title for a column.

since: 2.1

gnt_tree_set_column_titles

Set the titles of the columns.

gnt_tree_set_column_visible

Set whether a column is visible or not. This can be useful when, for example, we want to store some data which we don’t want/need to display.

gnt_tree_set_column_width_ratio

Set column widths to use when calculating column widths after a tree is resized.

since: 2.1

gnt_tree_set_compare_func

Set the compare function for sorting the data.

gnt_tree_set_expanded

Set whether a row, which has child rows, should be expanded.

gnt_tree_set_hash_fns

Set the hash functions to use to hash, compare and free the keys.

gnt_tree_set_row_color

Set color for the text in a row in the tree.

since: 2.4

gnt_tree_set_row_flags

Set flags for the text in a row in the tree.

gnt_tree_set_search_column

Set the column to use for typeahead searching.

since: 2.1

gnt_tree_set_search_function

Set a custom search function.

since: 2.1

gnt_tree_set_selected

Select a row.

gnt_tree_set_show_separator

Set whether to show column separators.

gnt_tree_set_show_title

Set whether to display the title of the columns.

gnt_tree_set_visible_rows

The number of rows the tree should display at a time.

gnt_tree_sort_row

Sort a row in the tree.

Methods inherited from GntWidget (48)

Please see GntWidget for a full list of methods.

Methods inherited from GntBindable (6)
gnt_bindable_bindings_view

Returns a GntTree populated with “key” -> “binding” for the widget.

since: 2.1.1

gnt_bindable_build_help_window

Builds a window that list the key bindings for a GntBindable object. From this window a user can select a listing to rebind a new key for the given action.

since: 2.1.1

gnt_bindable_check_key

Discover if a key is bound.

since: 2.4.2

gnt_bindable_perform_action_key

Perform an action from a keybinding.

gnt_bindable_perform_action_named

Perform an action on a bindable object.

gnt_bindable_remap_keys
No description available.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

Gnt.Tree:columns
No description available.

Gnt.Tree:expander-level
No description available.

Signals

Gnt.Tree::collapse-toggled
No description available.

Gnt.Tree::scrolled
No description available.

Gnt.Tree::selection-changed
No description available.

Gnt.Tree::toggled
No description available.

Signals inherited from GntWidget (15)
GntWidget::activate
No description available.

GntWidget::clicked
No description available.

GntWidget::confirm-size
No description available.

GntWidget::context-menu
No description available.

GntWidget::destroy
No description available.

GntWidget::draw
No description available.

GntWidget::expose
No description available.

GntWidget::gained-focus
No description available.

GntWidget::hide
No description available.

GntWidget::key-pressed
No description available.

GntWidget::lost-focus
No description available.

GntWidget::map
No description available.

GntWidget::position-set
No description available.

GntWidget::size-changed
No description available.

GntWidget::size-request
No description available.

Signals inherited from GObject (1)
GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct GntTreeClass {
  void (* selection_changed) (
    GntTreeRow* old,
    GntTreeRow* current
  );
  void (* toggled) (
    GntTree* tree,
    gpointer key
  );
  
}

The class structure for GntTree.

Class members
selection_changed: void (* selection_changed) ( GntTreeRow* old, GntTreeRow* current )
No description available.
toggled: void (* toggled) ( GntTree* tree, gpointer key )
No description available.

Virtual methods

Gnt.TreeClass.toggled
No description available.