Evolution Shell Reference Manual | ||||
---|---|---|---|---|
Top | Description | Object Hierarchy | Implemented Interfaces | Properties |
Synopsis
#include <shell/e-shell-sidebar.h> struct EShellSidebar; GtkWidget * e_shell_sidebar_new (struct _EShellView *shell_view
); guint32 e_shell_sidebar_check_state (EShellSidebar *shell_sidebar
); struct _EShellView * e_shell_sidebar_get_shell_view (EShellSidebar *shell_sidebar
); const gchar * e_shell_sidebar_get_icon_name (EShellSidebar *shell_sidebar
); void e_shell_sidebar_set_icon_name (EShellSidebar *shell_sidebar
,const gchar *icon_name
); const gchar * e_shell_sidebar_get_primary_text (EShellSidebar *shell_sidebar
); void e_shell_sidebar_set_primary_text (EShellSidebar *shell_sidebar
,const gchar *primary_text
); const gchar * e_shell_sidebar_get_secondary_text (EShellSidebar *shell_sidebar
); void e_shell_sidebar_set_secondary_text (EShellSidebar *shell_sidebar
,const gchar *secondary_text
);
Object Hierarchy
GObject +----GInitiallyUnowned +----GtkWidget +----GtkContainer +----GtkBin +----EShellSidebar
Implemented Interfaces
EShellSidebar implements AtkImplementorIface, GtkBuildable, EAlertSink and EExtensible.
Properties
"icon-name" gchar* : Read / Write "primary-text" gchar* : Read / Write "secondary-text" gchar* : Read / Write "shell-view" EShellView* : Read / Write / Construct Only
Details
struct EShellSidebar
struct 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
.
|
an EShellView |
Returns : |
a new EShellSidebar instance |
e_shell_sidebar_check_state ()
guint32 e_shell_sidebar_check_state (EShellSidebar *shell_sidebar
);
EShellSidebar subclasses should implement the
<structfield>check_state</structfield> method in EShellSidebarClass
to return a set of flags describing the current sidebar selection.
Subclasses are responsible for defining their own flags. This is
primarily used to assist shell views with updating actions (see
e_shell_view_update_actions()
).
|
an EShellSidebar |
Returns : |
a set of flags describing the current shell_sidebar selection |
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()
.
|
an EShellSidebar |
Returns : |
the EShellView to which shell_sidebar belongs |
e_shell_sidebar_get_icon_name ()
const gchar * e_shell_sidebar_get_icon_name (EShellSidebar *shell_sidebar
);
Returns the icon name displayed at the top of the sidebar.
|
an EShellSidebar |
Returns : |
the icon name for shell_sidebar
|
e_shell_sidebar_set_icon_name ()
void e_shell_sidebar_set_icon_name (EShellSidebar *shell_sidebar
,const gchar *icon_name
);
Sets the icon name displayed at the top of the sidebar.
|
an EShellSidebar |
|
a themed icon name |
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.
|
an EShellSidebar |
Returns : |
the primary text for shell_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.
|
an EShellSidebar |
|
text to be displayed in a bold font |
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.
|
an EShellSidebar |
Returns : |
the secondary text for shell_sidebar
|
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.
|
an EShellSidebar |
|
text to be displayed in a smaller font |
Property Details
The "icon-name"
property
"icon-name" gchar* : Read / Write
The named icon is displayed at the top of the sidebar.
Default value: NULL
The "primary-text"
property
"primary-text" gchar* : Read / Write
The primary text is displayed in bold at the top of the sidebar.
Default value: NULL
The "secondary-text"
property
"secondary-text" gchar* : Read / Write
The secondary text is displayed in a smaller font at the top of the sidebar.
Default value: NULL
The "shell-view"
property
"shell-view" EShellView* : Read / Write / Construct Only
The EShellView to which the sidebar widget belongs.