| Top |
GntWidget *
gnt_tree_new_with_columns (int columns);
Create a tree with a specified number of columns.
See gnt_tree_new().
void gnt_tree_set_visible_rows (GntTree *tree,int rows);
The number of rows the tree should display at a time.
int
gnt_tree_get_visible_rows (GntTree *tree);
Get the number visible rows.
void gnt_tree_scroll (GntTree *tree,int count);
Scroll the contents of the tree.
GntTreeRow * gnt_tree_add_row_after (GntTree *tree,void *key,GntTreeRow *row,void *parent,void *bigbro);
Insert a row in the tree.
See gnt_tree_create_row(), gnt_tree_add_row_last(), gnt_tree_add_choice().
GntTreeRow * gnt_tree_add_row_last (GntTree *tree,void *key,GntTreeRow *row,void *parent);
Insert a row at the end of the tree.
See gnt_tree_create_row(), gnt_tree_add_row_after(), gnt_tree_add_choice().
gpointer
gnt_tree_get_selection_data (GntTree *tree);
Get the key for the selected row.
char *
gnt_tree_get_selection_text (GntTree *tree);
Get the text displayed for the selected row.
See gnt_tree_get_row_text_list(), gnt_tree_get_selection_text_list().
GList * gnt_tree_get_row_text_list (GntTree *tree,gpointer key);
Get a list of text for a row.
See gnt_tree_get_selection_text_list(), gnt_tree_get_selection_text().
tree |
The tree |
|
key |
A key corresponding to the row in question. If key
is |
gpointer gnt_tree_row_get_key (GntTree *tree,GntTreeRow *row);
Get the key of a row.
Since: 2.7.3
GntTreeRow * gnt_tree_row_get_next (GntTree *tree,GntTreeRow *row);
Get the next row.
Since: 2.7.3
GntTreeRow * gnt_tree_row_get_prev (GntTree *tree,GntTreeRow *row);
Get the previous row.
Since: 2.7.3
GntTreeRow * gnt_tree_row_get_child (GntTree *tree,GntTreeRow *row);
Get the child row.
Since: 2.7.3
GntTreeRow * gnt_tree_row_get_parent (GntTree *tree,GntTreeRow *row);
Get the parent row.
Since: 2.7.3
GList *
gnt_tree_get_selection_text_list (GntTree *tree);
Get a list of text of the current row.
See gnt_tree_get_row_text_list(), gnt_tree_get_selection_text().
GList *
gnt_tree_get_rows (GntTree *tree);
Returns the list of rows in the tree.
int
gnt_tree_get_selection_visible_line (GntTree *tree);
Get the visible line number of the selected row.
void gnt_tree_change_text (GntTree *tree,gpointer key,int colno,const char *text);
Change the text of a column in a row.
GntTreeRow * gnt_tree_add_choice (GntTree *tree,void *key,GntTreeRow *row,void *parent,void *bigbro);
Add a checkable item in the tree.
See gnt_tree_create_row(), gnt_tree_create_row_from_list(),
gnt_tree_add_row_last(), gnt_tree_add_row_after().
void gnt_tree_set_choice (GntTree *tree,void *key,gboolean set);
Set whether a checkable item is checked or not.
gboolean gnt_tree_get_choice (GntTree *tree,void *key);
Return whether a row is selected or not, where the row is a checkable item.
void gnt_tree_set_row_flags (GntTree *tree,void *key,GntTextFormatFlags flags);
Set flags for the text in a row in the tree.
void gnt_tree_set_row_color (GntTree *tree,void *key,int color);
Set color for the text in a row in the tree.
Since: 2.4.0
GntTreeRow * gnt_tree_create_row (GntTree *tree,...);
Create a row to insert in the tree.
See gnt_tree_create_row_from_list(), gnt_tree_add_row_after(),
gnt_tree_add_row_last(), gnt_tree_add_choice().
GntTreeRow * gnt_tree_create_row_from_list (GntTree *tree,GList *list);
Create a row from a list of text.
See gnt_tree_create_row(), gnt_tree_add_row_after(), gnt_tree_add_row_last(),
gnt_tree_add_choice().
void gnt_tree_set_col_width (GntTree *tree,int col,int width);
Set the width of a column in the tree.
See gnt_tree_set_column_width_ratio(), gnt_tree_set_column_resizable()
void gnt_tree_set_column_title (GntTree *tree,int index,const char *title);
Set the title for a column.
See gnt_tree_set_column_titles(), gnt_tree_set_show_title().
Since: 2.1.0
void gnt_tree_set_column_titles (GntTree *tree,...);
Set the titles of the columns
void gnt_tree_set_show_title (GntTree *tree,gboolean set);
Set whether to display the title of the columns.
See gnt_tree_set_column_title(), gnt_tree_set_column_titles().
void gnt_tree_set_compare_func (GntTree *tree,GCompareFunc func);
Set the compare function for sorting the data.
See gnt_tree_sort_row().
void gnt_tree_set_expanded (GntTree *tree,void *key,gboolean expanded);
Set whether a row, which has child rows, should be expanded.
void gnt_tree_set_show_separator (GntTree *tree,gboolean set);
Set whether to show column separators.
void
gnt_tree_adjust_columns (GntTree *tree);
Automatically adjust the width of the columns in the tree.
void gnt_tree_set_hash_fns (GntTree *tree,gpointer hash,gpointer eq,gpointer kd);
Set the hash functions to use to hash, compare and free the keys.
void gnt_tree_set_column_visible (GntTree *tree,int col,gboolean vis);
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.
void gnt_tree_set_column_resizable (GntTree *tree,int col,gboolean res);
Set whether a column can be resized to keep the same ratio when the tree is resized.
See gnt_tree_set_col_width(), gnt_tree_set_column_width_ratio().
tree |
The tree |
|
col |
The index of the column |
|
res |
If |
Since: 2.1.0
void gnt_tree_set_column_is_binary (GntTree *tree,int col,gboolean bin);
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.
void gnt_tree_set_column_is_right_aligned (GntTree *tree,int col,gboolean right);
Set whether text in a column should be right-aligned.
tree |
The tree |
|
col |
The index of the column |
|
right |
|
Since: 2.1.0
void gnt_tree_set_column_width_ratio (GntTree *tree,int cols[]);
Set column widths to use when calculating column widths after a tree is resized.
See gnt_tree_set_col_width(), gnt_tree_set_column_resizable().
tree |
The tree |
|
cols |
Array of widths. The width must have the same number of entries as the number of columns in the tree, or end with a negative value for a column-width. |
Since: 2.1.0
void gnt_tree_set_search_column (GntTree *tree,int col);
Set the column to use for typeahead searching.
Since: 2.1.0
gboolean
gnt_tree_is_searching (GntTree *tree);
Check whether the user is currently in the middle of a search.
Since: 2.1.0
void gnt_tree_set_search_function (GntTree *tree,gboolean (*func) (GntTree *tree, gpointer key, const char *search, const char *current));
Set a custom search function.
tree |
The tree |
|
func |
The custom search function. The search function is
sent the tree itself, the key of a row, the search
string and the content of row in the search column.
If the function returns |
Since: 2.1.0
GntTreeColumnFlag has been deprecated since version 2.14.0 and should not be used in newly-written code.
This is an internal implementation detail.
struct GntTree {
GntWidget parent;
GntTreeRow *GNTSEAL(current); /* current selection */
GntTreeRow *GNTSEAL(top); /* The topmost visible item */
GntTreeRow *GNTSEAL(bottom); /* The bottommost visible item */
GntTreeRow *GNTSEAL(root); /* The root of all evil */
GList *GNTSEAL(list); /* List of GntTreeRow s */
GHashTable *GNTSEAL(hash); /* We need this for quickly referencing the rows */
guint (*GNTSEAL(hash_func))(gconstpointer);
gboolean (*GNTSEAL(hash_eq_func))(gconstpointer, gconstpointer);
GDestroyNotify GNTSEAL(key_destroy);
GDestroyNotify GNTSEAL(value_destroy);
int GNTSEAL(ncol); /* No. of columns */
struct _GntTreeColInfo
{
int GNTSEAL(width);
char *GNTSEAL(title);
int GNTSEAL(width_ratio);
GntTreeColumnFlag GNTSEAL(flags);
} *GNTSEAL(columns); /* Would a GList be better? */
gboolean GNTSEAL(show_title);
gboolean GNTSEAL(show_separator); /* Whether to show column separators */
struct _GntTreePriv *GNTSEAL(priv);
};
Access to any fields is deprecated. See inline comments for replacements.
typedef struct _GntTreeCol GntTreeCol;
GntTreeCol has been deprecated since version 2.14.0 and should not be used in newly-written code.
This is an internal implementation detail.
typedef struct _GntTreePriv GntTreePriv;
GntTreePriv has been deprecated since version 2.14.0 and should not be used in newly-written code.
This is an internal implementation detail.