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);
GtkWidget *         e_shell_content_get_searchbar       (EShellContent *shell_content);
guint32             e_shell_content_check_state         (EShellContent *shell_content);
struct _EShellView * e_shell_content_get_shell_view     (EShellContent *shell_content);
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);
gchar *             e_shell_content_get_search_name     (EShellContent *shell_content);
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);

Object Hierarchy

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

Implemented Interfaces

EShellContent implements AtkImplementorIface and GtkBuildable.

Properties

  "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_get_searchbar ()

GtkWidget *         e_shell_content_get_searchbar       (EShellContent *shell_content);

Returns the search bar widget returned by the construct_searchbar method in EShellContentClass.

shell_content :

Returns :

the search bar widget

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_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_get_search_name ()

gchar *             e_shell_content_get_search_name     (EShellContent *shell_content);

Returns a newly-allocated string containing a suitable name for the current search criteria. This is used as the suggested name in the Save Search dialog. Free the returned string with g_free().

shell_content :

an EShellContent

Returns :

a name for the current search criteria

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 :

Property Details

The "shell-view" property

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

The EShellView to which the content widget belongs.