e-tree-model
3
GAL Library
e-tree-model
Synopsis
#define E_TREE_MODEL_TYPE
gint (*ETreePathCompareFunc) (ETreeModel *model,
ETreePath *path1,
ETreePath *path2);
gboolean (*ETreePathFunc) (ETreeModel *model,
ETreePath *path,
gpointer data);
void e_tree_model_construct (ETreeModel *etree);
ETreeModel* e_tree_model_new (void);
ETreePath* e_tree_model_get_root (ETreeModel *etree);
ETreePath* e_tree_model_node_get_parent (ETreeModel *etree,
ETreePath *path);
ETreePath* e_tree_model_node_get_first_child
(ETreeModel *etree,
ETreePath *path);
ETreePath* e_tree_model_node_get_last_child
(ETreeModel *etree,
ETreePath *path);
ETreePath* e_tree_model_node_get_next (ETreeModel *etree,
ETreePath *path);
ETreePath* e_tree_model_node_get_prev (ETreeModel *etree,
ETreePath *path);
ETreePath* e_tree_model_node_insert (ETreeModel *etree,
ETreePath *parent,
int position,
gpointer node_data);
ETreePath* e_tree_model_node_insert_before (ETreeModel *etree,
ETreePath *parent,
ETreePath *sibling,
gpointer node_data);
gpointer e_tree_model_node_remove (ETreeModel *etree,
ETreePath *path);
void e_tree_model_freeze (ETreeModel *etree);
void e_tree_model_thaw (ETreeModel *etree);
gboolean e_tree_model_node_is_root (ETreeModel *etree,
ETreePath *path);
gboolean e_tree_model_node_is_expandable (ETreeModel *etree,
ETreePath *path);
gboolean e_tree_model_node_is_expanded (ETreeModel *etree,
ETreePath *path);
gboolean e_tree_model_node_is_visible (ETreeModel *etree,
ETreePath *path);
void e_tree_model_set_expanded_default
(ETreeModel *etree,
gboolean expanded);
void e_tree_model_node_set_expanded (ETreeModel *etree,
ETreePath *path,
gboolean expanded);
void e_tree_model_node_set_expanded_recurse
(ETreeModel *etree,
ETreePath *path,
gboolean expanded);
guint e_tree_model_node_get_children (ETreeModel *etree,
ETreePath *path,
ETreePath ***paths);
guint e_tree_model_node_depth (ETreeModel *etree,
ETreePath *path);
guint e_tree_model_node_num_visible_descendents
(ETreeModel *etm,
ETreePath *node);
gpointer e_tree_model_node_get_data (ETreeModel *etm,
ETreePath *node);
void e_tree_model_node_set_data (ETreeModel *etm,
ETreePath *node,
gpointer node_data);
ETreePath* e_tree_model_node_at_row (ETreeModel *etree,
int row);
GdkPixbuf* e_tree_model_icon_of_node (ETreeModel *etree,
ETreePath *path);
int e_tree_model_row_of_node (ETreeModel *etree,
ETreePath *path);
void e_tree_model_root_node_set_visible
(ETreeModel *etree,
gboolean visible);
gboolean e_tree_model_root_node_is_visible
(ETreeModel *etree);
void e_tree_model_node_set_compare_function
(ETreeModel *tree_model,
ETreePath *node,
ETreePathCompareFunc compare);
void e_tree_model_node_sort (ETreeModel *tree_model,
ETreePath *node);
void e_tree_model_node_changed (ETreeModel *tree_model,
ETreePath *node);
void e_tree_model_node_inserted (ETreeModel *tree_model,
ETreePath *parent_node,
ETreePath *inserted_node);
void e_tree_model_node_removed (ETreeModel *tree_model,
ETreePath *parent_node,
ETreePath *removed_node);
void e_tree_model_node_collapsed (ETreeModel *tree_model,
ETreePath *node);
void e_tree_model_node_expanded (ETreeModel *tree_model,
ETreePath *node,
gboolean *allow_expand);
gboolean e_tree_model_save_expanded_state
(ETreeModel *etm,
const char *filename);
gboolean e_tree_model_load_expanded_state
(ETreeModel *etm,
const char *filename);
void e_tree_model_node_set_save_id (ETreeModel *etm,
ETreePath *node,
const char *id);
ETreePath* e_tree_model_node_insert_id (ETreeModel *tree_model,
ETreePath *parent_path,
int position,
gpointer node_data,
const char *save_id);
void e_tree_model_node_traverse (ETreeModel *model,
ETreePath *path,
ETreePathFunc func,
gpointer data);
Description
Details
<anchor id="E-TREE-MODEL-TYPE:CAPS">E_TREE_MODEL_TYPE
E_TREE_MODEL_TYPE#define E_TREE_MODEL_TYPE (e_tree_model_get_type ())
<anchor id="ETreePathCompareFunc">ETreePathCompareFunc ()
ETreePathCompareFuncgint (*ETreePathCompareFunc) (ETreeModel *model,
ETreePath *path1,
ETreePath *path2);
model :
path1 :
path2 :
Returns :
<anchor id="ETreePathFunc">ETreePathFunc ()
ETreePathFuncgboolean (*ETreePathFunc) (ETreeModel *model,
ETreePath *path,
gpointer data);
model :
path :
data :
Returns :
<anchor id="e-tree-model-construct">e_tree_model_construct ()
e_tree_model_constructvoid e_tree_model_construct (ETreeModel *etree);
etree :
<anchor id="e-tree-model-new">e_tree_model_new ()
e_tree_model_newETreeModel* e_tree_model_new (void);
XXX docs here.
return values: a newly constructed ETreeModel.
Returns :
<anchor id="e-tree-model-get-root">e_tree_model_get_root ()
e_tree_model_get_rootETreePath* e_tree_model_get_root (ETreeModel *etree);
Accessor for the root node of etree.
return values: the ETreePath corresponding to the root node.
etree :
the ETreeModel of which we want the root node.
Returns :
<anchor id="e-tree-model-node-get-parent">e_tree_model_node_get_parent ()
e_tree_model_node_get_parentETreePath* e_tree_model_node_get_parent (ETreeModel *etree,
ETreePath *path);
etree :
path :
Returns :
<anchor id="e-tree-model-node-get-first-child">e_tree_model_node_get_first_child ()
e_tree_model_node_get_first_childETreePath* e_tree_model_node_get_first_child
(ETreeModel *etree,
ETreePath *path);
etree :
path :
Returns :
<anchor id="e-tree-model-node-get-last-child">e_tree_model_node_get_last_child ()
e_tree_model_node_get_last_childETreePath* e_tree_model_node_get_last_child
(ETreeModel *etree,
ETreePath *path);
etree :
path :
Returns :
<anchor id="e-tree-model-node-get-next">e_tree_model_node_get_next ()
e_tree_model_node_get_nextETreePath* e_tree_model_node_get_next (ETreeModel *etree,
ETreePath *path);
etree :
path :
Returns :
<anchor id="e-tree-model-node-get-prev">e_tree_model_node_get_prev ()
e_tree_model_node_get_prevETreePath* e_tree_model_node_get_prev (ETreeModel *etree,
ETreePath *path);
etree :
path :
Returns :
<anchor id="e-tree-model-node-insert">e_tree_model_node_insert ()
e_tree_model_node_insertETreePath* e_tree_model_node_insert (ETreeModel *etree,
ETreePath *parent,
int position,
gpointer node_data);
etree :
parent :
position :
node_data :
Returns :
<anchor id="e-tree-model-node-insert-before">e_tree_model_node_insert_before ()
e_tree_model_node_insert_beforeETreePath* e_tree_model_node_insert_before (ETreeModel *etree,
ETreePath *parent,
ETreePath *sibling,
gpointer node_data);
etree :
parent :
sibling :
node_data :
Returns :
<anchor id="e-tree-model-node-remove">e_tree_model_node_remove ()
e_tree_model_node_removegpointer e_tree_model_node_remove (ETreeModel *etree,
ETreePath *path);
etree :
path :
Returns :
<anchor id="e-tree-model-freeze">e_tree_model_freeze ()
e_tree_model_freezevoid e_tree_model_freeze (ETreeModel *etree);
etree :
<anchor id="e-tree-model-thaw">e_tree_model_thaw ()
e_tree_model_thawvoid e_tree_model_thaw (ETreeModel *etree);
etree :
<anchor id="e-tree-model-node-is-root">e_tree_model_node_is_root ()
e_tree_model_node_is_rootgboolean e_tree_model_node_is_root (ETreeModel *etree,
ETreePath *path);
etree :
path :
Returns :
<anchor id="e-tree-model-node-is-expandable">e_tree_model_node_is_expandable ()
e_tree_model_node_is_expandablegboolean e_tree_model_node_is_expandable (ETreeModel *etree,
ETreePath *path);
etree :
path :
Returns :
<anchor id="e-tree-model-node-is-expanded">e_tree_model_node_is_expanded ()
e_tree_model_node_is_expandedgboolean e_tree_model_node_is_expanded (ETreeModel *etree,
ETreePath *path);
etree :
path :
Returns :
<anchor id="e-tree-model-node-is-visible">e_tree_model_node_is_visible ()
e_tree_model_node_is_visiblegboolean e_tree_model_node_is_visible (ETreeModel *etree,
ETreePath *path);
etree :
path :
Returns :
<anchor id="e-tree-model-set-expanded-default">e_tree_model_set_expanded_default ()
e_tree_model_set_expanded_defaultvoid e_tree_model_set_expanded_default
(ETreeModel *etree,
gboolean expanded);
etree :
expanded :
<anchor id="e-tree-model-node-set-expanded">e_tree_model_node_set_expanded ()
e_tree_model_node_set_expandedvoid e_tree_model_node_set_expanded (ETreeModel *etree,
ETreePath *path,
gboolean expanded);
etree :
path :
expanded :
<anchor id="e-tree-model-node-set-expanded-recurse">e_tree_model_node_set_expanded_recurse ()
e_tree_model_node_set_expanded_recursevoid e_tree_model_node_set_expanded_recurse
(ETreeModel *etree,
ETreePath *path,
gboolean expanded);
etree :
path :
expanded :
<anchor id="e-tree-model-node-get-children">e_tree_model_node_get_children ()
e_tree_model_node_get_childrenguint e_tree_model_node_get_children (ETreeModel *etree,
ETreePath *path,
ETreePath ***paths);
etree :
path :
paths :
Returns :
<anchor id="e-tree-model-node-depth">e_tree_model_node_depth ()
e_tree_model_node_depthguint e_tree_model_node_depth (ETreeModel *etree,
ETreePath *path);
etree :
path :
Returns :
<anchor id="e-tree-model-node-num-visible-descendents">e_tree_model_node_num_visible_descendents ()
e_tree_model_node_num_visible_descendentsguint e_tree_model_node_num_visible_descendents
(ETreeModel *etm,
ETreePath *node);
etm :
node :
Returns :
<anchor id="e-tree-model-node-get-data">e_tree_model_node_get_data ()
e_tree_model_node_get_datagpointer e_tree_model_node_get_data (ETreeModel *etm,
ETreePath *node);
etm :
node :
Returns :
<anchor id="e-tree-model-node-set-data">e_tree_model_node_set_data ()
e_tree_model_node_set_datavoid e_tree_model_node_set_data (ETreeModel *etm,
ETreePath *node,
gpointer node_data);
etm :
node :
node_data :
<anchor id="e-tree-model-node-at-row">e_tree_model_node_at_row ()
e_tree_model_node_at_rowETreePath* e_tree_model_node_at_row (ETreeModel *etree,
int row);
etree :
row :
Returns :
<anchor id="e-tree-model-icon-of-node">e_tree_model_icon_of_node ()
e_tree_model_icon_of_nodeGdkPixbuf* e_tree_model_icon_of_node (ETreeModel *etree,
ETreePath *path);
XXX docs here.
return values: the GdkPixbuf associated with this node.
etree :
The ETreeModel.
path :
The ETreePath to the node we're getting the icon of.
Returns :
<anchor id="e-tree-model-row-of-node">e_tree_model_row_of_node ()
e_tree_model_row_of_nodeint e_tree_model_row_of_node (ETreeModel *etree,
ETreePath *path);
etree :
path :
Returns :
<anchor id="e-tree-model-root-node-set-visible">e_tree_model_root_node_set_visible ()
e_tree_model_root_node_set_visiblevoid e_tree_model_root_node_set_visible
(ETreeModel *etree,
gboolean visible);
etree :
visible :
<anchor id="e-tree-model-root-node-is-visible">e_tree_model_root_node_is_visible ()
e_tree_model_root_node_is_visiblegboolean e_tree_model_root_node_is_visible
(ETreeModel *etree);
etree :
Returns :
<anchor id="e-tree-model-node-set-compare-function">e_tree_model_node_set_compare_function ()
e_tree_model_node_set_compare_functionvoid e_tree_model_node_set_compare_function
(ETreeModel *tree_model,
ETreePath *node,
ETreePathCompareFunc compare);
tree_model :
node :
compare :
<anchor id="e-tree-model-node-sort">e_tree_model_node_sort ()
e_tree_model_node_sortvoid e_tree_model_node_sort (ETreeModel *tree_model,
ETreePath *node);
tree_model :
node :
<anchor id="e-tree-model-node-changed">e_tree_model_node_changed ()
e_tree_model_node_changedvoid e_tree_model_node_changed (ETreeModel *tree_model,
ETreePath *node);
tree_model :
node :
<anchor id="e-tree-model-node-inserted">e_tree_model_node_inserted ()
e_tree_model_node_insertedvoid e_tree_model_node_inserted (ETreeModel *tree_model,
ETreePath *parent_node,
ETreePath *inserted_node);
tree_model :
parent_node :
inserted_node :
<anchor id="e-tree-model-node-removed">e_tree_model_node_removed ()
e_tree_model_node_removedvoid e_tree_model_node_removed (ETreeModel *tree_model,
ETreePath *parent_node,
ETreePath *removed_node);
tree_model :
parent_node :
removed_node :
<anchor id="e-tree-model-node-collapsed">e_tree_model_node_collapsed ()
e_tree_model_node_collapsedvoid e_tree_model_node_collapsed (ETreeModel *tree_model,
ETreePath *node);
tree_model :
node :
<anchor id="e-tree-model-node-expanded">e_tree_model_node_expanded ()
e_tree_model_node_expandedvoid e_tree_model_node_expanded (ETreeModel *tree_model,
ETreePath *node,
gboolean *allow_expand);
tree_model :
node :
allow_expand :
<anchor id="e-tree-model-save-expanded-state">e_tree_model_save_expanded_state ()
e_tree_model_save_expanded_stategboolean e_tree_model_save_expanded_state
(ETreeModel *etm,
const char *filename);
etm :
filename :
Returns :
<anchor id="e-tree-model-load-expanded-state">e_tree_model_load_expanded_state ()
e_tree_model_load_expanded_stategboolean e_tree_model_load_expanded_state
(ETreeModel *etm,
const char *filename);
etm :
filename :
Returns :
<anchor id="e-tree-model-node-set-save-id">e_tree_model_node_set_save_id ()
e_tree_model_node_set_save_idvoid e_tree_model_node_set_save_id (ETreeModel *etm,
ETreePath *node,
const char *id);
etm :
node :
id :
<anchor id="e-tree-model-node-insert-id">e_tree_model_node_insert_id ()
e_tree_model_node_insert_idETreePath* e_tree_model_node_insert_id (ETreeModel *tree_model,
ETreePath *parent_path,
int position,
gpointer node_data,
const char *save_id);
tree_model :
parent_path :
position :
node_data :
save_id :
Returns :
<anchor id="e-tree-model-node-traverse">e_tree_model_node_traverse ()
e_tree_model_node_traversevoid e_tree_model_node_traverse (ETreeModel *model,
ETreePath *path,
ETreePathFunc func,
gpointer data);
model :
path :
func :
data :