|  |  |  | Evolution Utilities Reference Manual |  | 
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Implemented Interfaces | Properties | Style Properties | Signals | ||||
struct ETree; gboolean e_tree_construct (ETree *tree,ETreeModel *etm,ETableExtras *ete,ETableSpecification *specification); GtkWidget * e_tree_new (ETreeModel *etm,ETableExtras *ete,ETableSpecification *specification); ETableState * e_tree_get_state_object (ETree *tree); ETableSpecification * e_tree_get_spec (ETree *tree); void e_tree_set_state_object (ETree *tree,ETableState *state); void e_tree_show_cursor_after_reflow (ETree *tree); void e_tree_set_cursor (ETree *tree,ETreePath path); ETreePath e_tree_get_cursor (ETree *tree); void e_tree_path_foreach (ETree *tree,ETreeForeachFunc callback,gpointer closure); void e_tree_get_cell_at (ETree *tree,gint x,gint y,gint *row_return,gint *col_return); void e_tree_get_cell_geometry (ETree *tree,gint row,gint col,gint *x_return,gint *y_return,gint *width_return,gint *height_return); ETreeModel * e_tree_get_model (ETree *tree); ESelectionModel * e_tree_get_selection_model (ETree *tree); ETreeTableAdapter * e_tree_get_table_adapter (ETree *tree); void e_tree_drag_source_set (ETree *tree,GdkModifierType start_button_mask,const GtkTargetEntry *targets,gint n_targets,GdkDragAction actions); void e_tree_drag_source_unset (ETree *tree); GdkDragContext * e_tree_drag_begin (ETree *tree,gint row,gint col,GtkTargetList *targets,GdkDragAction actions,gint button,GdkEvent *event); gboolean e_tree_is_dragging (ETree *tree); ETableItem * e_tree_get_item (ETree *tree); GnomeCanvasItem * e_tree_get_header_item (ETree *tree); void e_tree_set_info_message (ETree *tree,const gchar *info_message); void e_tree_freeze_state_change (ETree *tree); void e_tree_thaw_state_change (ETree *tree); gboolean e_tree_is_editing (ETree *tree);
GObject +----GInitiallyUnowned +----GtkWidget +----GtkContainer +----GtkTable +----ETree
"ETreeTableAdapter" ETreeTableAdapter* : Read "always-search" gboolean : Read / Write "drawfocus" gboolean : Write "horizontal-draw-grid" gboolean : Write "is-editing" gboolean : Read "length-threshold" gint : Write "uniform-row-height" gboolean : Read / Write "vertical-draw-grid" gboolean : Write
"alternating-row-colors" gboolean : Read "expander-size" gint : Read "vertical-spacing" gint : Read
"click" :Run Last"cursor-activated" :Run Last"cursor-change" :Run Last"double-click" :Run Last"key-press" :Run Last"right-click" :Run Last"selection-change" :Run Last"start-drag" :Run Last"state-change" :Run Last"tree-drag-begin" :Run Last"tree-drag-data-delete" :Run Last"tree-drag-data-get" :Run Last"tree-drag-data-received" :Run Last"tree-drag-drop" :Run Last"tree-drag-end" :Run Last"tree-drag-leave" :Run Last"tree-drag-motion" :Run Last"white-space-event" :Run Last
gboolean e_tree_construct (ETree *tree,ETreeModel *etm,ETableExtras *ete,ETableSpecification *specification);
This is the internal implementation of e_tree_new() for use by
subclasses or language bindings.  See e_tree_new() for details.
| 
 | The newly created ETree object. | 
| 
 | The model for this table. | 
| 
 | An optional ETableExtras.  ( NULLis valid.) | 
| 
 | an ETableSpecification | 
| Returns : | TRUEon success,FALSEif an error occurred | 
GtkWidget * e_tree_new (ETreeModel *etm,ETableExtras *ete,ETableSpecification *specification);
This function creates an ETree from the given parameters.  The
ETreeModel is a tree model to be represented.  The ETableExtras
is an optional set of pixbufs, cells, and sorting functions to be
used when interpreting the spec.  If you pass in NULL it uses the
default ETableExtras.  (See e_table_extras_new()).
specification is the specification of the set of viewable columns and the
default sorting state and such.  state is an optional string specifying
the current sorting state and such.
| 
 | The model for this tree | 
| 
 | An optional ETableExtras  ( NULLis valid.) | 
| 
 | an ETableSpecification | 
| Returns : | The newly created ETree or NULLif there's an error. | 
ETableState *       e_tree_get_state_object             (ETree *tree);
Builds an ETableState corresponding to the current state of the ETree.
| 
 | ETree object to act on | 
| Returns : | The ETableStateobject generated. | 
ETableSpecification * e_tree_get_spec                   (ETree *tree);
Returns the specification object.
| 
 | The ETree to query | 
void e_tree_path_foreach (ETree *tree,ETreeForeachFunc callback,gpointer closure);
void e_tree_get_cell_at (ETree *tree,gint x,gint y,gint *row_return,gint *col_return);
Return the row and column for the cell in which the pixel at (x, y) is
contained.
| 
 | An ETree widget | 
| 
 | X coordinate for the pixel | 
| 
 | Y coordinate for the pixel | 
| 
 | Pointer to return the row value | 
| 
 | Pointer to return the column value | 
void e_tree_get_cell_geometry (ETree *tree,gint row,gint col,gint *x_return,gint *y_return,gint *width_return,gint *height_return);
Computes the data about this cell.
| 
 | The tree. | 
| 
 | The row to get the geometry of. | 
| 
 | The col to get the geometry of. | 
| 
 | Returns the x coordinate of the upper right hand corner of the cell with respect to the widget. | 
| 
 | Returns the y coordinate of the upper right hand corner of the cell with respect to the widget. | 
| 
 | Returns the width of the cell. | 
| 
 | Returns the height of the cell. | 
ETreeModel *        e_tree_get_model                    (ETree *tree);
Returns the model upon which this ETree is based.
| 
 | the ETree | 
| Returns : | the model | 
ESelectionModel *   e_tree_get_selection_model          (ETree *tree);
Returns the selection model of this ETree.
| 
 | the ETree | 
| Returns : | the selection model | 
ETreeTableAdapter * e_tree_get_table_adapter            (ETree *tree);
Returns the table adapter this ETree uses.
| 
 | the ETree | 
| Returns : | the model | 
void e_tree_drag_source_set (ETree *tree,GdkModifierType start_button_mask,const GtkTargetEntry *targets,gint n_targets,GdkDragAction actions);
GdkDragContext * e_tree_drag_begin (ETree *tree,gint row,gint col,GtkTargetList *targets,GdkDragAction actions,gint button,GdkEvent *event);
gboolean            e_tree_is_dragging                  (ETree *tree);
| 
 | An ETree widget | 
| Returns : | whether is treein a drag&drop operation. | 
void e_tree_set_info_message (ETree *tree,const gchar *info_message);
Creates an info message in table area, or removes old.
| 
 | ETree instance | 
| 
 | Message to set. Can be NULL. | 
"always-search" property"always-search" gboolean : Read / Write
Always search.
Default value: FALSE
"horizontal-draw-grid" property"horizontal-draw-grid" gboolean : Write
Horizontal Draw Grid.
Default value: FALSE
"is-editing" property"is-editing" gboolean : Read
Whether is in an editing mode.
Default value: FALSE
"length-threshold" property"length-threshold" gint : Write
Length Threshold.
Allowed values: >= 0
Default value: 0
"uniform-row-height" property"uniform-row-height" gboolean : Read / Write
Uniform row height.
Default value: FALSE
"vertical-draw-grid" property"vertical-draw-grid" gboolean : Write
Vertical Draw Grid.
Default value: FALSE
"alternating-row-colors" style property"alternating-row-colors" gboolean : Read
Whether to use alternating row colors.
Default value: TRUE
"expander-size" style property"expander-size" gint : Read
Size of the expander arrow.
Allowed values: >= 0
Default value: 10
"vertical-spacing" style property"vertical-spacing" gint : Read
Vertical space between rows. It is added to top and to bottom of a row.
Allowed values: >= 0
Default value: 3
"click" signalgboolean            user_function                      (ETree    *etree,
                                                        gint      arg1,
                                                        gpointer  arg2,
                                                        gint      arg3,
                                                        GdkEvent *arg4,
                                                        gpointer  user_data)      : Run Last
"cursor-activated" signalvoid                user_function                      (ETree   *etree,
                                                        gint     arg1,
                                                        gpointer arg2,
                                                        gpointer user_data)      : Run Last
"cursor-change" signalvoid                user_function                      (ETree   *etree,
                                                        gint     arg1,
                                                        gpointer arg2,
                                                        gpointer user_data)      : Run Last
"double-click" signalvoid                user_function                      (ETree    *etree,
                                                        gint      arg1,
                                                        gpointer  arg2,
                                                        gint      arg3,
                                                        GdkEvent *arg4,
                                                        gpointer  user_data)      : Run Last
"key-press" signalgboolean            user_function                      (ETree    *etree,
                                                        gint      arg1,
                                                        gpointer  arg2,
                                                        gint      arg3,
                                                        GdkEvent *arg4,
                                                        gpointer  user_data)      : Run Last
"right-click" signalgboolean            user_function                      (ETree    *etree,
                                                        gint      arg1,
                                                        gpointer  arg2,
                                                        gint      arg3,
                                                        GdkEvent *arg4,
                                                        gpointer  user_data)      : Run Last
"start-drag" signalvoid                user_function                      (ETree    *etree,
                                                        gint      arg1,
                                                        gpointer  arg2,
                                                        gint      arg3,
                                                        GdkEvent *arg4,
                                                        gpointer  user_data)      : Run Last
"tree-drag-begin" signalvoid                user_function                      (ETree          *etree,
                                                        gint            arg1,
                                                        gpointer        arg2,
                                                        gint            arg3,
                                                        GdkDragContext *arg4,
                                                        gpointer        user_data)      : Run Last
"tree-drag-data-delete" signalvoid                user_function                      (ETree          *etree,
                                                        gint            arg1,
                                                        gpointer        arg2,
                                                        gint            arg3,
                                                        GdkDragContext *arg4,
                                                        gpointer        user_data)      : Run Last
"tree-drag-data-get" signalvoid                user_function                      (ETree            *etree,
                                                        gint              arg1,
                                                        gpointer          arg2,
                                                        gint              arg3,
                                                        GdkDragContext   *arg4,
                                                        GtkSelectionData *arg5,
                                                        guint             arg6,
                                                        guint             arg7,
                                                        gpointer          user_data)      : Run Last
"tree-drag-data-received" signalvoid                user_function                      (ETree            *etree,
                                                        gint              arg1,
                                                        gpointer          arg2,
                                                        gint              arg3,
                                                        GdkDragContext   *arg4,
                                                        gint              arg5,
                                                        gint              arg6,
                                                        GtkSelectionData *arg7,
                                                        guint             arg8,
                                                        guint             arg9,
                                                        gpointer          user_data)      : Run Last
"tree-drag-drop" signalgboolean            user_function                      (ETree          *etree,
                                                        gint            arg1,
                                                        gpointer        arg2,
                                                        gint            arg3,
                                                        GdkDragContext *arg4,
                                                        gint            arg5,
                                                        gint            arg6,
                                                        guint           arg7,
                                                        gpointer        user_data)      : Run Last
"tree-drag-end" signalvoid                user_function                      (ETree          *etree,
                                                        gint            arg1,
                                                        gpointer        arg2,
                                                        gint            arg3,
                                                        GdkDragContext *arg4,
                                                        gpointer        user_data)      : Run Last
"tree-drag-leave" signalvoid                user_function                      (ETree          *etree,
                                                        gint            arg1,
                                                        gpointer        arg2,
                                                        gint            arg3,
                                                        GdkDragContext *arg4,
                                                        guint           arg5,
                                                        gpointer        user_data)      : Run Last
"tree-drag-motion" signalgboolean            user_function                      (ETree          *etree,
                                                        gint            arg1,
                                                        gpointer        arg2,
                                                        gint            arg3,
                                                        GdkDragContext *arg4,
                                                        gint            arg5,
                                                        gint            arg6,
                                                        guint           arg7,
                                                        gpointer        user_data)      : Run Last