![]() |
![]() |
![]() |
Evolution Utilities Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Signals |
struct ETableSortInfo; void e_table_sort_info_freeze (ETableSortInfo *info
); void e_table_sort_info_thaw (ETableSortInfo *info
); guint e_table_sort_info_grouping_get_count (ETableSortInfo *info
); void e_table_sort_info_grouping_truncate (ETableSortInfo *info
,gint length
); struct ETableSortColumn; ETableSortColumn e_table_sort_info_grouping_get_nth (ETableSortInfo *info
,gint n
); void e_table_sort_info_grouping_set_nth (ETableSortInfo *info
,gint n
,ETableSortColumn column
); guint e_table_sort_info_sorting_get_count (ETableSortInfo *info
); void e_table_sort_info_sorting_truncate (ETableSortInfo *info
,gint length
); ETableSortColumn e_table_sort_info_sorting_get_nth (ETableSortInfo *info
,gint n
); void e_table_sort_info_sorting_set_nth (ETableSortInfo *info
,gint n
,ETableSortColumn column
); ETableSortInfo * e_table_sort_info_new (void
); void e_table_sort_info_load_from_node (ETableSortInfo *info
,xmlNode *node
,gdouble state_version
); xmlNode * e_table_sort_info_save_to_node (ETableSortInfo *info
,xmlNode *parent
); ETableSortInfo * e_table_sort_info_duplicate (ETableSortInfo *info
); void e_table_sort_info_set_can_group (ETableSortInfo *info
,gboolean can_group
); gboolean e_table_sort_info_get_can_group (ETableSortInfo *info
);
void e_table_sort_info_freeze (ETableSortInfo *info
);
This functions allows the programmer to cluster various changes to the ETableSortInfo (grouping and sorting) without having the object emit "group_info_changed" or "sort_info_changed" signals on each change.
To thaw, invoke the e_table_sort_info_thaw()
function, which will
trigger any signals that might have been queued.
|
The ETableSortInfo object |
void e_table_sort_info_thaw (ETableSortInfo *info
);
This functions allows the programmer to cluster various changes to the ETableSortInfo (grouping and sorting) without having the object emit "group_info_changed" or "sort_info_changed" signals on each change.
This function will flush any pending signals that might be emited by this object.
|
The ETableSortInfo object |
guint e_table_sort_info_grouping_get_count
(ETableSortInfo *info
);
|
The ETableSortInfo object |
Returns : |
the number of grouping criteria in the object. |
void e_table_sort_info_grouping_truncate (ETableSortInfo *info
,gint length
);
This routine can be used to reduce or grow the number of grouping criteria in the object.
|
The ETableSortInfo object |
|
position where the truncation happens. |
ETableSortColumn e_table_sort_info_grouping_get_nth (ETableSortInfo *info
,gint n
);
|
The ETableSortInfo object |
|
Item information to fetch. |
Returns : |
the description of the n -th grouping criteria in the info object. |
void e_table_sort_info_grouping_set_nth (ETableSortInfo *info
,gint n
,ETableSortColumn column
);
Sets the grouping criteria for index n
to be given by column
(a column number and
whether it is ascending or descending).
|
The ETableSortInfo object |
|
Item information to fetch. |
|
new values for the grouping |
guint e_table_sort_info_sorting_get_count (ETableSortInfo *info
);
void e_table_sort_info_sorting_truncate (ETableSortInfo *info
,gint length
);
This routine can be used to reduce or grow the number of sort criteria in the object.
|
The ETableSortInfo object |
|
position where the truncation happens. |
ETableSortColumn e_table_sort_info_sorting_get_nth (ETableSortInfo *info
,gint n
);
|
The ETableSortInfo object |
|
Item information to fetch. |
Returns : |
the description of the n -th grouping criteria in the info object. |
void e_table_sort_info_sorting_set_nth (ETableSortInfo *info
,gint n
,ETableSortColumn column
);
Sets the sorting criteria for index n
to be given by column
(a
column number and whether it is ascending or descending).
|
The ETableSortInfo object |
|
Item information to fetch. |
|
new values for the sorting |
ETableSortInfo * e_table_sort_info_new (void
);
This creates a new e_table_sort_info 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 the ETable.
Returns : |
A new ETableSortInfo object |
void e_table_sort_info_load_from_node (ETableSortInfo *info
,xmlNode *node
,gdouble state_version
);
This loads the state for the ETableSortInfo
object info
from the
xml node node
.
|
The ETableSortInfo object |
|
pointer to the xmlNode that describes the sorting and grouping information |
xmlNode * e_table_sort_info_save_to_node (ETableSortInfo *info
,xmlNode *parent
);
This function is used
|
The ETableSortInfo object |
|
xmlNode that will be hosting the saved state of the info object. |
Returns : |
the node that has been appended to parent as a child containing
the sorting and grouping information for this ETableSortInfo object. |
void e_table_sort_info_set_can_group (ETableSortInfo *info
,gboolean can_group
);
"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