e-virtual-tree

e-virtual-tree

Functions

GtkCellRenderer * e_cell_renderer_button_new ()
GtkCellRenderer * e_cell_renderer_toggle_new ()
void (*EVirtualTreeCellDataFunc) ()
gchar * (*EVirtualTreeSearchFunc) ()
gboolean (*EVirtualTreeRowColorFunc) ()
gchar * (*EVirtualTreeRowTooltipMarkupFunc) ()
GtkWidget * e_virtual_tree_new ()
void e_virtual_tree_set_model ()
EVirtualTreeModel * e_virtual_tree_get_model ()
guint e_virtual_tree_add_column ()
GtkTreeViewColumn * e_virtual_tree_get_column ()
void e_virtual_tree_column_pack_start ()
void e_virtual_tree_column_pack_end ()
void e_virtual_tree_column_pack_span ()
void e_virtual_tree_column_set_accessible_name ()
void e_virtual_tree_column_clear_renderers ()
void e_virtual_tree_set_column_expand ()
void e_virtual_tree_set_column_min_width ()
void e_virtual_tree_set_expander_column ()
void e_virtual_tree_set_expander_visible ()
void e_virtual_tree_set_group_depth ()
guint e_virtual_tree_get_group_depth ()
void e_virtual_tree_set_editable ()
gboolean e_virtual_tree_get_editable ()
void e_virtual_tree_set_selection_mode ()
GtkSelectionMode e_virtual_tree_get_selection_mode ()
GPtrArray * e_virtual_tree_get_selected_rows ()
void e_virtual_tree_select_row ()
void e_virtual_tree_unselect_row ()
void e_virtual_tree_select_all ()
void e_virtual_tree_unselect_all ()
gboolean e_virtual_tree_row_is_selected ()
void e_virtual_tree_set_cursor ()
void e_virtual_tree_set_cursor_centered ()
gint e_virtual_tree_get_cursor ()
gboolean e_virtual_tree_row_is_visible ()
void e_virtual_tree_scroll_cursor_into_view ()
void e_virtual_tree_scroll_to_row ()
GtkTreeView * e_virtual_tree_get_tree_view ()
gboolean e_virtual_tree_get_cell_rect ()
void e_virtual_tree_set_search_func ()
void e_virtual_tree_set_selected_row_color_func ()
void e_virtual_tree_set_unselected_row_color_func ()
void e_virtual_tree_set_row_tooltip_markup_func ()
void e_virtual_tree_enable_drag_source ()
void e_virtual_tree_enable_drag_dest ()
void e_virtual_tree_set_column_state_filename ()
const gchar * e_virtual_tree_get_column_state_filename ()
void e_virtual_tree_save_column_state_to_key_file ()
void e_virtual_tree_load_column_state_from_key_file ()
GKeyFile * e_virtual_tree_convert_legacy_etable_state ()
gboolean e_virtual_tree_get_applying_proportional_widths ()
void e_virtual_tree_set_header_click_sort_policy ()
EAutomaticActionPolicy e_virtual_tree_get_header_click_sort_policy ()
void e_virtual_tree_set_column_sort ()
void e_virtual_tree_clear_sort ()
gboolean e_virtual_tree_get_column_sort ()
void e_virtual_tree_set_column_group ()
void e_virtual_tree_clear_group ()
gboolean e_virtual_tree_get_column_group ()
void e_virtual_tree_set_column_groupable ()
gboolean e_virtual_tree_get_column_groupable ()
gboolean e_virtual_tree_get_allow_grouping ()
guint e_virtual_tree_get_n_columns ()
const gchar * e_virtual_tree_get_column_id ()
const gchar * e_virtual_tree_get_column_title ()
void e_virtual_tree_freeze_state_changed ()
void e_virtual_tree_thaw_state_changed ()
void e_virtual_tree_show_customize_popover ()
void e_virtual_tree_set_empty_message ()
const gchar * e_virtual_tree_get_empty_message ()
gconstpointer e_virtual_tree_get_cursor_key ()
GObject * e_virtual_tree_get_cursor_object ()
guint e_virtual_tree_selected_count ()
gboolean e_virtual_tree_is_dragging ()
EPrintable * e_virtual_tree_get_printable ()

Properties

gboolean editable Read / Write
char * empty-message Read / Write
guint group-depth Read / Write
EAutomaticActionPolicy header-click-sort-policy Read / Write
EVirtualTreeModel * model Read / Write
GtkSelectionMode selection-mode Read / Write

Signals

gboolean cell-clicked Run Last
void cell-edited Run Last
void column-state-changed Run Last
void cursor-changed Run Last
gpointer get-legacy-etable-column-map Action
void header-clicked Run Last
gboolean right-click Run Last
void row-activated Run Last
void row-expanded Run Last
void selection-changed Run Last
void tree-drag-begin Run Last
void tree-drag-data-get Run Last
void tree-drag-data-received Run Last
gboolean tree-drag-drop Run Last
void tree-drag-end Run Last
gboolean tree-drag-motion Run Last

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ├── GtkCellRenderer
        │   ├── GtkCellRendererText
        │   │   ╰── ECellRendererButton
        │   ╰── GtkCellRendererToggle
        │       ╰── ECellRendererToggle
        ╰── GtkWidget
            ╰── GtkContainer
                ╰── GtkBox
                    ╰── EVirtualTree

Implemented Interfaces

EVirtualTree implements AtkImplementorIface, GtkBuildable, GtkOrientable and GtkScrollable.

Description

Functions

e_cell_renderer_button_new ()

GtkCellRenderer *
e_cell_renderer_button_new (void);

Creates a new GtkCellRendererText subclass which paints itself as a themed button (background and frame from the "button" style class) before drawing its text, for actions embedded in an EVirtualTree row.

Returns

a new GtkCellRenderer.

[transfer full]

Since: 3.64


e_cell_renderer_toggle_new ()

GtkCellRenderer *
e_cell_renderer_toggle_new (void);

Creates a new GtkCellRendererToggle subclass which paints the same check/radio indicator as its parent class. All other behavior (activation, editing) is inherited unchanged.

Returns

a new GtkCellRenderer.

[transfer full]

Since: 3.64


EVirtualTreeCellDataFunc ()

void
(*EVirtualTreeCellDataFunc) (EVirtualTree *self,
                             GtkCellRenderer *renderer,
                             GObject *row_object,
                             guint visible_row,
                             gpointer user_data);

EVirtualTreeSearchFunc ()

gchar *
(*EVirtualTreeSearchFunc) (EVirtualTree *self,
                           GObject *row_object,
                           gpointer user_data);

EVirtualTreeRowColorFunc ()

gboolean
(*EVirtualTreeRowColorFunc) (EVirtualTree *self,
                             GObject *row_object,
                             guint visible_row,
                             GdkRGBA *out_color,
                             gpointer user_data);

EVirtualTreeRowTooltipMarkupFunc ()

gchar *
(*EVirtualTreeRowTooltipMarkupFunc) (EVirtualTree *self,
                                     GObject *row_object,
                                     gpointer user_data);

e_virtual_tree_new ()

GtkWidget *
e_virtual_tree_new (EVirtualTreeModel *model);

e_virtual_tree_set_model ()

void
e_virtual_tree_set_model (EVirtualTree *self,
                          EVirtualTreeModel *model);

e_virtual_tree_get_model ()

EVirtualTreeModel *
e_virtual_tree_get_model (EVirtualTree *self);

e_virtual_tree_add_column ()

guint
e_virtual_tree_add_column (EVirtualTree *self,
                           const gchar *column_id,
                           const gchar *title);

e_virtual_tree_get_column ()

GtkTreeViewColumn *
e_virtual_tree_get_column (EVirtualTree *self,
                           guint column_index);

e_virtual_tree_column_pack_start ()

void
e_virtual_tree_column_pack_start (EVirtualTree *self,
                                  guint column_index,
                                  guint line,
                                  GtkCellRenderer *renderer,
                                  gboolean expand,
                                  EVirtualTreeCellDataFunc func,
                                  gpointer user_data,
                                  GDestroyNotify destroy);

e_virtual_tree_column_pack_end ()

void
e_virtual_tree_column_pack_end (EVirtualTree *self,
                                guint column_index,
                                guint line,
                                GtkCellRenderer *renderer,
                                gboolean expand,
                                EVirtualTreeCellDataFunc func,
                                gpointer user_data,
                                GDestroyNotify destroy);

e_virtual_tree_column_pack_span ()

void
e_virtual_tree_column_pack_span (EVirtualTree *self,
                                 guint column_index,
                                 GtkCellRenderer *renderer,
                                 EVirtualTreeCellDataFunc func,
                                 gpointer user_data,
                                 GDestroyNotify destroy);

e_virtual_tree_column_set_accessible_name ()

void
e_virtual_tree_column_set_accessible_name
                               (EVirtualTree *self,
                                guint column_index,
                                const gchar *name);

e_virtual_tree_column_clear_renderers ()

void
e_virtual_tree_column_clear_renderers (EVirtualTree *self,
                                       guint column_index);

e_virtual_tree_set_column_expand ()

void
e_virtual_tree_set_column_expand (EVirtualTree *self,
                                  guint column_index,
                                  gboolean expand);

e_virtual_tree_set_column_min_width ()

void
e_virtual_tree_set_column_min_width (EVirtualTree *self,
                                     guint column_index,
                                     gint min_width);

e_virtual_tree_set_expander_column ()

void
e_virtual_tree_set_expander_column (EVirtualTree *self,
                                    guint column_index,
                                    guint line);

e_virtual_tree_set_expander_visible ()

void
e_virtual_tree_set_expander_visible (EVirtualTree *self,
                                     gboolean visible);

e_virtual_tree_set_group_depth ()

void
e_virtual_tree_set_group_depth (EVirtualTree *self,
                                guint depth);

e_virtual_tree_get_group_depth ()

guint
e_virtual_tree_get_group_depth (EVirtualTree *self);

e_virtual_tree_set_editable ()

void
e_virtual_tree_set_editable (EVirtualTree *self,
                             gboolean editable);

e_virtual_tree_get_editable ()

gboolean
e_virtual_tree_get_editable (EVirtualTree *self);

e_virtual_tree_set_selection_mode ()

void
e_virtual_tree_set_selection_mode (EVirtualTree *self,
                                   GtkSelectionMode mode);

e_virtual_tree_get_selection_mode ()

GtkSelectionMode
e_virtual_tree_get_selection_mode (EVirtualTree *self);

e_virtual_tree_get_selected_rows ()

GPtrArray *
e_virtual_tree_get_selected_rows (EVirtualTree *self);

e_virtual_tree_select_row ()

void
e_virtual_tree_select_row (EVirtualTree *self,
                           guint row);

e_virtual_tree_unselect_row ()

void
e_virtual_tree_unselect_row (EVirtualTree *self,
                             guint row);

e_virtual_tree_select_all ()

void
e_virtual_tree_select_all (EVirtualTree *self);

e_virtual_tree_unselect_all ()

void
e_virtual_tree_unselect_all (EVirtualTree *self);

e_virtual_tree_row_is_selected ()

gboolean
e_virtual_tree_row_is_selected (EVirtualTree *self,
                                guint row);

e_virtual_tree_set_cursor ()

void
e_virtual_tree_set_cursor (EVirtualTree *self,
                           gint row);

e_virtual_tree_set_cursor_centered ()

void
e_virtual_tree_set_cursor_centered (EVirtualTree *self,
                                    gint row);

e_virtual_tree_get_cursor ()

gint
e_virtual_tree_get_cursor (EVirtualTree *self);

e_virtual_tree_row_is_visible ()

gboolean
e_virtual_tree_row_is_visible (EVirtualTree *self,
                               guint row);

e_virtual_tree_scroll_cursor_into_view ()

void
e_virtual_tree_scroll_cursor_into_view
                               (EVirtualTree *self);

e_virtual_tree_scroll_to_row ()

void
e_virtual_tree_scroll_to_row (EVirtualTree *self,
                              guint row);

e_virtual_tree_get_tree_view ()

GtkTreeView *
e_virtual_tree_get_tree_view (EVirtualTree *self);

e_virtual_tree_get_cell_rect ()

gboolean
e_virtual_tree_get_cell_rect (EVirtualTree *self,
                              guint column_index,
                              guint visible_row,
                              GdkRectangle *out_rect);

e_virtual_tree_set_search_func ()

void
e_virtual_tree_set_search_func (EVirtualTree *self,
                                EVirtualTreeSearchFunc func,
                                gpointer user_data,
                                GDestroyNotify destroy);

e_virtual_tree_set_selected_row_color_func ()

void
e_virtual_tree_set_selected_row_color_func
                               (EVirtualTree *self,
                                EVirtualTreeRowColorFunc func,
                                gpointer user_data,
                                GDestroyNotify destroy);

Sets a function to be called to determine a row's own color. The row's own color is used as its background outright when the row is selected; when unselected it has no effect on the row background painted by EVirtualTree.

Parameters

self

an EVirtualTree

 

func

an EVirtualTreeRowColorFunc, or NULL to unset.

[nullable]

user_data

data to pass to func

 

destroy

a GDestroyNotify to free user_data , or NULL.

[nullable]

Since: 3.64


e_virtual_tree_set_unselected_row_color_func ()

void
e_virtual_tree_set_unselected_row_color_func
                               (EVirtualTree *self,
                                EVirtualTreeRowColorFunc func,
                                gpointer user_data,
                                GDestroyNotify destroy);

Sets a function to be called to determine a row's own background color, used only while the row is not selected; when selected, the row falls back to the usual selection appearance instead. The text color of any GtkCellRendererText in the row is overridden with a color computed by e_utils_get_text_color_for_background() to keep good contrast with the row's background.

Parameters

self

an EVirtualTree

 

func

an EVirtualTreeRowColorFunc, or NULL to unset.

[nullable]

user_data

data to pass to func

 

destroy

a GDestroyNotify to free user_data , or NULL.

[nullable]

Since: 3.64


e_virtual_tree_set_row_tooltip_markup_func ()

void
e_virtual_tree_set_row_tooltip_markup_func
                               (EVirtualTree *self,
                                EVirtualTreeRowTooltipMarkupFunc func,
                                gpointer user_data,
                                GDestroyNotify destroy);

Sets a function to be called to build a whole-row tooltip markup for the row under the pointer. When func returns non-NULL markup for a row, it is shown anchored to the whole row, instead of the default per-cell ellipsized-text tooltip.

Parameters

self

an EVirtualTree

 

func

an EVirtualTreeRowTooltipMarkupFunc, or NULL to unset.

[nullable]

user_data

data to pass to func

 

destroy

a GDestroyNotify to free user_data , or NULL.

[nullable]

Since: 3.64


e_virtual_tree_enable_drag_source ()

void
e_virtual_tree_enable_drag_source (EVirtualTree *self,
                                   GdkModifierType start_button_mask,
                                   const GtkTargetEntry *targets,
                                   gint n_targets,
                                   GdkDragAction actions);

e_virtual_tree_enable_drag_dest ()

void
e_virtual_tree_enable_drag_dest (EVirtualTree *self,
                                 const GtkTargetEntry *targets,
                                 gint n_targets,
                                 GdkDragAction actions);

e_virtual_tree_set_column_state_filename ()

void
e_virtual_tree_set_column_state_filename
                               (EVirtualTree *self,
                                const gchar *filename);

e_virtual_tree_get_column_state_filename ()

const gchar *
e_virtual_tree_get_column_state_filename
                               (EVirtualTree *self);

e_virtual_tree_save_column_state_to_key_file ()

void
e_virtual_tree_save_column_state_to_key_file
                               (EVirtualTree *self,
                                GKeyFile *key_file);

e_virtual_tree_load_column_state_from_key_file ()

void
e_virtual_tree_load_column_state_from_key_file
                               (EVirtualTree *self,
                                GKeyFile *key_file);

e_virtual_tree_convert_legacy_etable_state ()

GKeyFile *
e_virtual_tree_convert_legacy_etable_state
                               (const gchar *xml_data,
                                gssize length,
                                const gchar * const *legacy_column_ids,
                                guint n_legacy_column_ids);

e_virtual_tree_get_applying_proportional_widths ()

gboolean
e_virtual_tree_get_applying_proportional_widths
                               (EVirtualTree *self);

e_virtual_tree_set_header_click_sort_policy ()

void
e_virtual_tree_set_header_click_sort_policy
                               (EVirtualTree *self,
                                EAutomaticActionPolicy policy);

e_virtual_tree_get_header_click_sort_policy ()

EAutomaticActionPolicy
e_virtual_tree_get_header_click_sort_policy
                               (EVirtualTree *self);

e_virtual_tree_set_column_sort ()

void
e_virtual_tree_set_column_sort (EVirtualTree *self,
                                guint column_index,
                                GtkSortType sort_order,
                                gint sort_priority);

e_virtual_tree_clear_sort ()

void
e_virtual_tree_clear_sort (EVirtualTree *self);

e_virtual_tree_get_column_sort ()

gboolean
e_virtual_tree_get_column_sort (EVirtualTree *self,
                                guint column_index,
                                GtkSortType *out_sort_order,
                                gint *out_priority);

e_virtual_tree_set_column_group ()

void
e_virtual_tree_set_column_group (EVirtualTree *self,
                                 guint column_index,
                                 GtkSortType sort_order,
                                 gint group_priority);

e_virtual_tree_clear_group ()

void
e_virtual_tree_clear_group (EVirtualTree *self);

e_virtual_tree_get_column_group ()

gboolean
e_virtual_tree_get_column_group (EVirtualTree *self,
                                 guint column_index,
                                 GtkSortType *out_sort_order,
                                 gint *out_priority);

e_virtual_tree_set_column_groupable ()

void
e_virtual_tree_set_column_groupable (EVirtualTree *self,
                                     guint column_index,
                                     gboolean groupable);

e_virtual_tree_get_column_groupable ()

gboolean
e_virtual_tree_get_column_groupable (EVirtualTree *self,
                                     guint column_index);

e_virtual_tree_get_allow_grouping ()

gboolean
e_virtual_tree_get_allow_grouping (EVirtualTree *self);

e_virtual_tree_get_n_columns ()

guint
e_virtual_tree_get_n_columns (EVirtualTree *self);

e_virtual_tree_get_column_id ()

const gchar *
e_virtual_tree_get_column_id (EVirtualTree *self,
                              guint column_index);

e_virtual_tree_get_column_title ()

const gchar *
e_virtual_tree_get_column_title (EVirtualTree *self,
                                 guint column_index);

e_virtual_tree_freeze_state_changed ()

void
e_virtual_tree_freeze_state_changed (EVirtualTree *self);

e_virtual_tree_thaw_state_changed ()

void
e_virtual_tree_thaw_state_changed (EVirtualTree *self);

e_virtual_tree_show_customize_popover ()

void
e_virtual_tree_show_customize_popover (EVirtualTree *self);

e_virtual_tree_set_empty_message ()

void
e_virtual_tree_set_empty_message (EVirtualTree *self,
                                  const gchar *message);

e_virtual_tree_get_empty_message ()

const gchar *
e_virtual_tree_get_empty_message (EVirtualTree *self);

e_virtual_tree_get_cursor_key ()

gconstpointer
e_virtual_tree_get_cursor_key (EVirtualTree *self);

e_virtual_tree_get_cursor_object ()

GObject *
e_virtual_tree_get_cursor_object (EVirtualTree *self);

e_virtual_tree_selected_count ()

guint
e_virtual_tree_selected_count (EVirtualTree *self);

e_virtual_tree_is_dragging ()

gboolean
e_virtual_tree_is_dragging (EVirtualTree *self);

e_virtual_tree_get_printable ()

EPrintable *
e_virtual_tree_get_printable (EVirtualTree *self);

Types and Values

E_TYPE_VIRTUAL_TREE

#define E_TYPE_VIRTUAL_TREE (e_virtual_tree_get_type ())

E_TYPE_CELL_RENDERER_BUTTON

#define E_TYPE_CELL_RENDERER_BUTTON (e_cell_renderer_button_get_type ())

E_TYPE_CELL_RENDERER_TOGGLE

#define E_TYPE_CELL_RENDERER_TOGGLE (e_cell_renderer_toggle_get_type ())

ECellRendererButton

typedef struct _ECellRendererButton ECellRendererButton;

ECellRendererToggle

typedef struct _ECellRendererToggle ECellRendererToggle;

EVirtualTree

typedef struct _EVirtualTree EVirtualTree;

Property Details

The “editable” property

  “editable”                 gboolean

Owner: EVirtualTree

Flags: Read / Write

Default value: FALSE


The “empty-message” property

  “empty-message”            char *

Owner: EVirtualTree

Flags: Read / Write

Default value: NULL


The “group-depth” property

  “group-depth”              guint

Owner: EVirtualTree

Flags: Read / Write

Default value: 0


The “header-click-sort-policy” property

  “header-click-sort-policy” EAutomaticActionPolicy

Owner: EVirtualTree

Flags: Read / Write

Default value: E_AUTOMATIC_ACTION_POLICY_ASK


The “model” property

  “model”                    EVirtualTreeModel *

Owner: EVirtualTree

Flags: Read / Write


The “selection-mode” property

  “selection-mode”           GtkSelectionMode

Owner: EVirtualTree

Flags: Read / Write

Default value: GTK_SELECTION_SINGLE

Signal Details

The “cell-clicked” signal

gboolean
user_function (EVirtualTree    *evirtualtree,
               guint            arg1,
               GObject         *arg2,
               guint            arg3,
               GtkCellRenderer *arg4,
               gpointer         user_data)

Flags: Run Last


The “cell-edited” signal

void
user_function (EVirtualTree    *evirtualtree,
               guint            arg1,
               GObject         *arg2,
               guint            arg3,
               GtkCellRenderer *arg4,
               char            *arg5,
               gpointer         user_data)

Flags: Run Last


The “column-state-changed” signal

void
user_function (EVirtualTree *evirtualtree,
               gpointer      user_data)

Flags: Run Last


The “cursor-changed” signal

void
user_function (EVirtualTree *evirtualtree,
               guint         arg1,
               GObject      *arg2,
               gpointer      user_data)

Flags: Run Last


The “get-legacy-etable-column-map” signal

gpointer
user_function (EVirtualTree *evirtualtree,
               gpointer      arg1,
               gpointer      user_data)

Flags: Action


The “header-clicked” signal

void
user_function (EVirtualTree *evirtualtree,
               guint         arg1,
               int           arg2,
               gboolean      arg3,
               gpointer      user_data)

Flags: Run Last


The “right-click” signal

gboolean
user_function (EVirtualTree *evirtualtree,
               guint         arg1,
               GObject      *arg2,
               GdkEvent     *arg3,
               gpointer      user_data)

Flags: Run Last


The “row-activated” signal

void
user_function (EVirtualTree *evirtualtree,
               guint         arg1,
               GObject      *arg2,
               gpointer      user_data)

Flags: Run Last


The “row-expanded” signal

void
user_function (EVirtualTree *evirtualtree,
               guint         arg1,
               GObject      *arg2,
               gboolean      arg3,
               gpointer      user_data)

Flags: Run Last


The “selection-changed” signal

void
user_function (EVirtualTree *evirtualtree,
               gpointer      user_data)

Flags: Run Last


The “tree-drag-begin” signal

void
user_function (EVirtualTree   *evirtualtree,
               guint           arg1,
               GdkDragContext *arg2,
               gpointer        user_data)

Flags: Run Last


The “tree-drag-data-get” signal

void
user_function (EVirtualTree     *evirtualtree,
               GdkDragContext   *arg1,
               GtkSelectionData *arg2,
               guint             arg3,
               guint             arg4,
               gpointer          user_data)

Flags: Run Last


The “tree-drag-data-received” signal

void
user_function (EVirtualTree     *evirtualtree,
               GdkDragContext   *arg1,
               guint             arg2,
               GtkSelectionData *arg3,
               guint             arg4,
               guint             arg5,
               gpointer          user_data)

Flags: Run Last


The “tree-drag-drop” signal

gboolean
user_function (EVirtualTree   *evirtualtree,
               GdkDragContext *arg1,
               guint           arg2,
               guint           arg3,
               gpointer        user_data)

Flags: Run Last


The “tree-drag-end” signal

void
user_function (EVirtualTree   *evirtualtree,
               GdkDragContext *arg1,
               gpointer        user_data)

Flags: Run Last


The “tree-drag-motion” signal

gboolean
user_function (EVirtualTree   *evirtualtree,
               GdkDragContext *arg1,
               guint           arg2,
               guint           arg3,
               gpointer        user_data)

Flags: Run Last