ETableCol

ETableCol

Synopsis

struct              ETableCol;
ETableCol *         e_table_col_new                     (gint col_idx,
                                                         const gchar *text,
                                                         const gchar *icon_name,
                                                         gdouble expansion,
                                                         gint min_width,
                                                         ECell *ecell,
                                                         GCompareDataFunc compare,
                                                         gboolean resizable,
                                                         gboolean disabled,
                                                         gint priority);

Object Hierarchy

  GObject
   +----ETableCol

Properties

  "compare-col"              gint                  : Read / Write

Description

Details

struct ETableCol

struct ETableCol;

e_table_col_new ()

ETableCol *         e_table_col_new                     (gint col_idx,
                                                         const gchar *text,
                                                         const gchar *icon_name,
                                                         gdouble expansion,
                                                         gint min_width,
                                                         ECell *ecell,
                                                         GCompareDataFunc compare,
                                                         gboolean resizable,
                                                         gboolean disabled,
                                                         gint priority);

The ETableCol represents a column to be used inside an ETable. The ETableCol objects are inserted inside an ETableHeader (which is just a collection of ETableCols). The ETableHeader is the definition of the order in which columns are shown to the user.

The text argument is the the text that will be shown as a header to the user. col_idx reflects where the data for this ETableCol object will be fetch from an ETableModel. So even if the user changes the order of the columns being viewed (the ETableCols in the ETableHeader), the column will always point to the same column inside the ETableModel.

The ecell argument is an ECell object that needs to know how to render the data in the ETableModel for this specific row.

Data passed to compare can be (if not NULL) a cmp_cache, which can be accessed by e_table_sorting_utils_add_to_cmp_cache() and e_table_sorting_utils_lookup_cmp_cache().

col_idx :

the column we represent in the model

text :

a title for this column

icon_name :

name of the icon to be used for the header, or NULL

expansion :

FIXME

min_width :

minimum width in pixels for this column

ecell :

the renderer to be used for this column

compare :

comparision function for the elements stored in this column

resizable :

whether the column can be resized interactively by the user

priority :

FIXME

Returns :

the newly created ETableCol object.

Property Details

The "compare-col" property

  "compare-col"              gint                  : Read / Write

Width.

Allowed values: >= 0

Default value: 0