|  |  |  | Evolution Utilities Reference Manual |  | 
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Properties | Signals | ||||
struct ETableSortInfo; ETableSortInfo * e_table_sort_info_new (struct _ETableSpecification *specification); void e_table_sort_info_parse_context_push (GMarkupParseContext *context,struct _ETableSpecification *specification); ETableSortInfo * e_table_sort_info_parse_context_pop (GMarkupParseContext *context); struct _ETableSpecification * e_table_sort_info_ref_specification (ETableSortInfo *sort_info); gboolean e_table_sort_info_get_can_group (ETableSortInfo *sort_info); void e_table_sort_info_set_can_group (ETableSortInfo *sort_info,gboolean can_group); guint e_table_sort_info_grouping_get_count (ETableSortInfo *sort_info); void e_table_sort_info_grouping_truncate (ETableSortInfo *sort_info,guint length); ETableColumnSpecification * e_table_sort_info_grouping_get_nth (ETableSortInfo *sort_info,guint n,GtkSortType *out_sort_type); void e_table_sort_info_grouping_set_nth (ETableSortInfo *sort_info,guint n,ETableColumnSpecification *spec,GtkSortType sort_type); guint e_table_sort_info_sorting_get_count (ETableSortInfo *sort_info); void e_table_sort_info_sorting_remove (ETableSortInfo *sort_info,guint n); void e_table_sort_info_sorting_truncate (ETableSortInfo *sort_info,guint length); ETableColumnSpecification * e_table_sort_info_sorting_get_nth (ETableSortInfo *sort_info,guint n,GtkSortType *out_sort_type); void e_table_sort_info_sorting_set_nth (ETableSortInfo *sort_info,guint n,ETableColumnSpecification *spec,GtkSortType sort_type); void e_table_sort_info_sorting_insert (ETableSortInfo *sort_info,guint n,ETableColumnSpecification *spec,GtkSortType sort_type); void e_table_sort_info_load_from_node (ETableSortInfo *sort_info,xmlNode *node,gdouble state_version); xmlNode * e_table_sort_info_save_to_node (ETableSortInfo *sort_info,xmlNode *parent); ETableSortInfo * e_table_sort_info_duplicate (ETableSortInfo *sort_info);
ETableSortInfo *    e_table_sort_info_new               (struct _ETableSpecification *specification);
This creates a new ETableSortInfo object that contains no grouping and no sorting defined as of yet. This object is used to keep track of multi-level sorting and multi-level grouping of an ETable.
| 
 | an ETableSpecification | 
| Returns : | A new ETableSortInfo object | 
void e_table_sort_info_parse_context_push (GMarkupParseContext *context,struct _ETableSpecification *specification);
Creates a new ETableSortInfo from a segment of XML data being fed to
context.  Call this function for the appropriate opening tag from the
start_element callback of a GMarkupParser,
then call e_table_sort_info_parse_context_pop() for the corresponding
closing tag from the end_element callback.
| 
 | a GMarkupParseContext | 
| 
 | an ETableSpecification | 
ETableSortInfo *    e_table_sort_info_parse_context_pop (GMarkupParseContext *context);
Creates a new ETableSortInfo from a segment of XML data being fed to
context.  Call e_table_sort_info_parse_context_push() for the appropriate
opening tag from the start_element callback of a
GMarkupParser, then call this function for the corresponding closing tag
from the end_element callback.
Unreference the newly-created ETableSortInfo with g_object_unref() when
finished with it.
| 
 | a GMarkupParseContext | 
| Returns : | an ETableSortInfo | 
struct _ETableSpecification * e_table_sort_info_ref_specification
                                                        (ETableSortInfo *sort_info);
Returns the ETableSpecification passed to e_table_sort_info_new().
The returned ETableSpecification is referenced for thread-safety and must
be unreferenced with g_object_unref() when finished with it.
| 
 | an ETableSortInfo | 
| Returns : | an ETableSpecification | 
gboolean            e_table_sort_info_get_can_group     (ETableSortInfo *sort_info);
void e_table_sort_info_set_can_group (ETableSortInfo *sort_info,gboolean can_group);
guint               e_table_sort_info_grouping_get_count
                                                        (ETableSortInfo *sort_info);
| 
 | an ETableSortInfo | 
| Returns : | the number of grouping criteria in the object. | 
void e_table_sort_info_grouping_truncate (ETableSortInfo *sort_info,guint length);
This routine can be used to reduce or grow the number of grouping criteria in the object.
| 
 | an ETableSortInfo | 
| 
 | position where the truncation happens. | 
ETableColumnSpecification * e_table_sort_info_grouping_get_nth (ETableSortInfo *sort_info,guint n,GtkSortType *out_sort_type);
| 
 | an ETableSortInfo | 
| 
 | Item information to fetch. | 
| 
 | return location for a GtkSortType value, or NULL | 
| Returns : | the description of the n-th grouping criteria in theinfoobject. | 
void e_table_sort_info_grouping_set_nth (ETableSortInfo *sort_info,guint n,ETableColumnSpecification *spec,GtkSortType sort_type);
Sets the grouping criteria for index n to spec and sort_type.
| 
 | an ETableSortInfo | 
| 
 | Item information to fetch. | 
| 
 | an ETableColumnSpecification | 
| 
 | a GtkSortType | 
guint               e_table_sort_info_sorting_get_count (ETableSortInfo *sort_info);
void e_table_sort_info_sorting_remove (ETableSortInfo *sort_info,guint n);
Removes the sorting element at the given index. The following sorting elements are moved down one place.
| 
 | an ETableSortInfo | 
| 
 | the index of the element to remove | 
void e_table_sort_info_sorting_truncate (ETableSortInfo *sort_info,guint length);
This routine can be used to reduce or grow the number of sort criteria in the object.
| 
 | an ETableSortInfo | 
| 
 | position where the truncation happens. | 
ETableColumnSpecification * e_table_sort_info_sorting_get_nth (ETableSortInfo *sort_info,guint n,GtkSortType *out_sort_type);
| 
 | an ETableSortInfo | 
| 
 | Item information to fetch. | 
| 
 | return location for a GtkSortType value, or NULL | 
| Returns : | the description of the n-th grouping criteria in theinfoobject. | 
void e_table_sort_info_sorting_set_nth (ETableSortInfo *sort_info,guint n,ETableColumnSpecification *spec,GtkSortType sort_type);
Sets the sorting criteria for index n to spec and sort_type.
| 
 | an ETableSortInfo | 
| 
 | Item information to fetch. | 
| 
 | an ETableColumnSpecification | 
| 
 | a GtkSortType | 
void e_table_sort_info_sorting_insert (ETableSortInfo *sort_info,guint n,ETableColumnSpecification *spec,GtkSortType sort_type);
void e_table_sort_info_load_from_node (ETableSortInfo *sort_info,xmlNode *node,gdouble state_version);
This loads the state for the ETableSortInfo object info from the
xml node node.
| 
 | an ETableSortInfo | 
| 
 | pointer to the xmlNode that describes the sorting and grouping information | 
xmlNode * e_table_sort_info_save_to_node (ETableSortInfo *sort_info,xmlNode *parent);
This function is used
| 
 | an ETableSortInfo | 
| 
 | xmlNode that will be hosting the saved state of the infoobject. | 
| Returns : | the node that has been appended to parentas a child containing
the sorting and grouping information for this ETableSortInfo object. | 
ETableSortInfo *    e_table_sort_info_duplicate         (ETableSortInfo *sort_info);
"specification" property"specification" ETableSpecification* : Read / Write / Construct Only
Specification for the table state.
"group-info-changed" signalvoid                user_function                      (ETableSortInfo *etablesortinfo,
                                                        gpointer        user_data)           : Run Last
"sort-info-changed" signalvoid                user_function                      (ETableSortInfo *etablesortinfo,
                                                        gpointer        user_data)           : Run Last