EShellContent

EShellContent — the right side of the main window

Synopsis

#include <shell/e-shell-content.h>

                    EShellContent;
GtkWidget *         e_shell_content_new                 (struct _EShellView *shell_view);
guint32             e_shell_content_check_state         (EShellContent *shell_content);
struct _EShellView * e_shell_content_get_shell_view     (EShellContent *shell_content);
GtkRadioAction *    e_shell_content_get_filter_action   (EShellContent *shell_content);
void                e_shell_content_set_filter_action   (EShellContent *shell_content,
                                                         GtkRadioAction *filter_action);
gint                e_shell_content_get_filter_value    (EShellContent *shell_content);
void                e_shell_content_set_filter_value    (EShellContent *shell_content,
                                                         gint filter_value);
gboolean            e_shell_content_get_filter_visible  (EShellContent *shell_content);
void                e_shell_content_set_filter_visible  (EShellContent *shell_content,
                                                         gboolean filter_visible);
void                e_shell_content_add_filter_separator_before
                                                        (EShellContent *shell_content,
                                                         gint action_value);
void                e_shell_content_add_filter_separator_after
                                                        (EShellContent *shell_content,
                                                         gint action_value);
ERuleContext *      e_shell_content_get_search_context  (EShellContent *shell_content);
const gchar *       e_shell_content_get_search_hint     (EShellContent *shell_content);
void                e_shell_content_set_search_hint     (EShellContent *shell_content,
                                                         const gchar *search_hint);
EFilterRule *       e_shell_content_get_search_rule     (EShellContent *shell_content);
void                e_shell_content_set_search_rule     (EShellContent *shell_content,
                                                         EFilterRule *search_rule);
const gchar *       e_shell_content_get_search_text     (EShellContent *shell_content);
void                e_shell_content_set_search_text     (EShellContent *shell_content,
                                                         const gchar *search_text);
gboolean            e_shell_content_get_search_visible  (EShellContent *shell_content);
void                e_shell_content_set_search_visible  (EShellContent *shell_content,
                                                         gboolean search_visible);
GtkRadioAction *    e_shell_content_get_scope_action    (EShellContent *shell_content);
void                e_shell_content_set_scope_action    (EShellContent *shell_content,
                                                         GtkRadioAction *scope_action);
gint                e_shell_content_get_scope_value     (EShellContent *shell_content);
void                e_shell_content_set_scope_value     (EShellContent *shell_content,
                                                         gint scope_value);
gboolean            e_shell_content_get_scope_visible   (EShellContent *shell_content);
void                e_shell_content_set_scope_visible   (EShellContent *shell_content,
                                                         gboolean scope_visible);
const gchar *       e_shell_content_get_view_id         (EShellContent *shell_content);
void                e_shell_content_set_view_id         (EShellContent *shell_content,
                                                         const gchar *view_id);
void                e_shell_content_run_advanced_search_dialog
                                                        (EShellContent *shell_content);
void                e_shell_content_run_edit_searches_dialog
                                                        (EShellContent *shell_content);
void                e_shell_content_run_save_search_dialog
                                                        (EShellContent *shell_content);
void                e_shell_content_restore_state       (EShellContent *shell_content,
                                                         const gchar *group_name);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkBin
                                 +----EShellContent

Implemented Interfaces

EShellContent implements AtkImplementorIface and GtkBuildable.

Properties

  "filter-action"            GtkRadioAction*       : Read / Write
  "filter-value"             gint                  : Read / Write
  "filter-visible"           gboolean              : Read / Write / Construct
  "scope-action"             GtkRadioAction*       : Read / Write
  "scope-value"              gint                  : Read / Write
  "scope-visible"            gboolean              : Read / Write / Construct
  "search-context"           ERuleContext*         : Read
  "search-hint"              gchar*                : Read / Write
  "search-radio-action"      GtkRadioAction*       : Read / Write
  "search-rule"              EFilterRule*          : Read / Write
  "search-text"              gchar*                : Read / Write
  "search-visible"           gboolean              : Read / Write / Construct
  "shell-view"               EShellView*           : Read / Write / Construct Only

Description

Details

EShellContent

typedef struct _EShellContent EShellContent;

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


e_shell_content_new ()

GtkWidget *         e_shell_content_new                 (struct _EShellView *shell_view);

Creates a new EShellContent instance belonging to shell_view.

shell_view :

an EShellView

Returns :

a new EShellContent instance

e_shell_content_check_state ()

guint32             e_shell_content_check_state         (EShellContent *shell_content);

EShellContent subclasses should implement the check_state method in EShellContentClass to return a set of flags describing the current content 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()).

shell_content :

an EShellContent

Returns :

a set of flags describing the current shell_content selection

e_shell_content_get_shell_view ()

struct _EShellView * e_shell_content_get_shell_view     (EShellContent *shell_content);

Returns the EShellView that was passed to e_shell_content_new().

shell_content :

an EShellContent

Returns :

the EShellView to which shell_content belongs

e_shell_content_get_filter_action ()

GtkRadioAction *    e_shell_content_get_filter_action   (EShellContent *shell_content);

shell_content :

Returns :


e_shell_content_set_filter_action ()

void                e_shell_content_set_filter_action   (EShellContent *shell_content,
                                                         GtkRadioAction *filter_action);

shell_content :

filter_action :


e_shell_content_get_filter_value ()

gint                e_shell_content_get_filter_value    (EShellContent *shell_content);

shell_content :

Returns :


e_shell_content_set_filter_value ()

void                e_shell_content_set_filter_value    (EShellContent *shell_content,
                                                         gint filter_value);

shell_content :

filter_value :


e_shell_content_get_filter_visible ()

gboolean            e_shell_content_get_filter_visible  (EShellContent *shell_content);

shell_content :

Returns :


e_shell_content_set_filter_visible ()

void                e_shell_content_set_filter_visible  (EShellContent *shell_content,
                                                         gboolean filter_visible);

shell_content :

filter_visible :


e_shell_content_add_filter_separator_before ()

void                e_shell_content_add_filter_separator_before
                                                        (EShellContent *shell_content,
                                                         gint action_value);

shell_content :

action_value :


e_shell_content_add_filter_separator_after ()

void                e_shell_content_add_filter_separator_after
                                                        (EShellContent *shell_content,
                                                         gint action_value);

shell_content :

action_value :


e_shell_content_get_search_context ()

ERuleContext *      e_shell_content_get_search_context  (EShellContent *shell_content);

shell_content :

Returns :


e_shell_content_get_search_hint ()

const gchar *       e_shell_content_get_search_hint     (EShellContent *shell_content);

shell_content :

Returns :


e_shell_content_set_search_hint ()

void                e_shell_content_set_search_hint     (EShellContent *shell_content,
                                                         const gchar *search_hint);

shell_content :

search_hint :


e_shell_content_get_search_rule ()

EFilterRule *       e_shell_content_get_search_rule     (EShellContent *shell_content);

shell_content :

Returns :


e_shell_content_set_search_rule ()

void                e_shell_content_set_search_rule     (EShellContent *shell_content,
                                                         EFilterRule *search_rule);

shell_content :

search_rule :


e_shell_content_get_search_text ()

const gchar *       e_shell_content_get_search_text     (EShellContent *shell_content);

shell_content :

Returns :


e_shell_content_set_search_text ()

void                e_shell_content_set_search_text     (EShellContent *shell_content,
                                                         const gchar *search_text);

shell_content :

search_text :


e_shell_content_get_search_visible ()

gboolean            e_shell_content_get_search_visible  (EShellContent *shell_content);

shell_content :

Returns :


e_shell_content_set_search_visible ()

void                e_shell_content_set_search_visible  (EShellContent *shell_content,
                                                         gboolean search_visible);

shell_content :

search_visible :


e_shell_content_get_scope_action ()

GtkRadioAction *    e_shell_content_get_scope_action    (EShellContent *shell_content);

shell_content :

Returns :


e_shell_content_set_scope_action ()

void                e_shell_content_set_scope_action    (EShellContent *shell_content,
                                                         GtkRadioAction *scope_action);

shell_content :

scope_action :


e_shell_content_get_scope_value ()

gint                e_shell_content_get_scope_value     (EShellContent *shell_content);

shell_content :

Returns :


e_shell_content_set_scope_value ()

void                e_shell_content_set_scope_value     (EShellContent *shell_content,
                                                         gint scope_value);

shell_content :

scope_value :


e_shell_content_get_scope_visible ()

gboolean            e_shell_content_get_scope_visible   (EShellContent *shell_content);

shell_content :

Returns :


e_shell_content_set_scope_visible ()

void                e_shell_content_set_scope_visible   (EShellContent *shell_content,
                                                         gboolean scope_visible);

shell_content :

scope_visible :


e_shell_content_get_view_id ()

const gchar *       e_shell_content_get_view_id         (EShellContent *shell_content);

shell_content :

Returns :


e_shell_content_set_view_id ()

void                e_shell_content_set_view_id         (EShellContent *shell_content,
                                                         const gchar *view_id);

shell_content :

view_id :


e_shell_content_run_advanced_search_dialog ()

void                e_shell_content_run_advanced_search_dialog
                                                        (EShellContent *shell_content);

shell_content :


e_shell_content_run_edit_searches_dialog ()

void                e_shell_content_run_edit_searches_dialog
                                                        (EShellContent *shell_content);

shell_content :


e_shell_content_run_save_search_dialog ()

void                e_shell_content_run_save_search_dialog
                                                        (EShellContent *shell_content);

shell_content :


e_shell_content_restore_state ()

void                e_shell_content_restore_state       (EShellContent *shell_content,
                                                         const gchar *group_name);

shell_content :

group_name :

Property Details

The "filter-action" property

  "filter-action"            GtkRadioAction*       : Read / Write


The "filter-value" property

  "filter-value"             gint                  : Read / Write

Default value: 0


The "filter-visible" property

  "filter-visible"           gboolean              : Read / Write / Construct

Default value: TRUE


The "scope-action" property

  "scope-action"             GtkRadioAction*       : Read / Write


The "scope-value" property

  "scope-value"              gint                  : Read / Write

Default value: 0


The "scope-visible" property

  "scope-visible"            gboolean              : Read / Write / Construct

Default value: FALSE


The "search-context" property

  "search-context"           ERuleContext*         : Read


The "search-hint" property

  "search-hint"              gchar*                : Read / Write

Default value: NULL


The "search-radio-action" property

  "search-radio-action"      GtkRadioAction*       : Read / Write


The "search-rule" property

  "search-rule"              EFilterRule*          : Read / Write


The "search-text" property

  "search-text"              gchar*                : Read / Write

Default value: NULL


The "search-visible" property

  "search-visible"           gboolean              : Read / Write / Construct

Default value: TRUE


The "shell-view" property

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

The EShellView to which the content widget belongs.