EShellSidebar

typedef struct _EShellSidebar EShellSidebar;

Contains only private data that should be read and manipulated using the functions below.

e_shell_sidebar_new ()

GtkWidget *         e_shell_sidebar_new                 (struct _EShellView *shell_view);

Creates a new EShellSidebar instance belonging to shell_view.

e_shell_sidebar_get_shell_view ()

struct _EShellView * e_shell_sidebar_get_shell_view     (EShellSidebar *shell_sidebar);

Returns the EShellView that was passed to e_shell_sidebar_new().

e_shell_sidebar_get_primary_text ()

const gchar *       e_shell_sidebar_get_primary_text    (EShellSidebar *shell_sidebar);

Returns the primary text for shell_sidebar.

The primary text is displayed in bold at the top of the sidebar. It defaults to the shell view's label (as seen on the switcher button), but typically shows the name of the selected item in the sidebar.

e_shell_sidebar_set_primary_text ()

void                e_shell_sidebar_set_primary_text    (EShellSidebar *shell_sidebar,
                                                         const gchar *primary_text);

Sets the primary text for shell_sidebar.

The primary text is displayed in bold at the top of the sidebar. It defaults to the shell view's label (as seen on the switcher button), but typically shows the name of the selected item in the sidebar.

e_shell_sidebar_get_secondary_text ()

const gchar *       e_shell_sidebar_get_secondary_text  (EShellSidebar *shell_sidebar);

Returns the secondary text for shell_sidebar.

The secondary text is displayed in a smaller font at the top of the sidebar. It typically shows information about the contents of the selected sidebar item, such as total number of items, number of selected items, etc.

e_shell_sidebar_set_secondary_text ()

void                e_shell_sidebar_set_secondary_text  (EShellSidebar *shell_sidebar,
                                                         const gchar *secondary_text);

Sets the secondary text for shell_sidebar.

The secondary text is displayed in a smaller font at the top of the sidebar. It typically shows information about the contents of the selected sidebar item, such as total number of items, number of selected items, etc.

The "primary-text" property

  "primary-text"             gchar*                : Read / Write

Default value: NULL

The "secondary-text" property

  "secondary-text"           gchar*                : Read / Write

Default value: NULL

The "shell-view" property

  "shell-view"               EShellView*           : Read / Write / Construct Only

The EShellView to which the sidebar widget belongs.