EShell

EShell — the backbone of Evolution

Synopsis


#include <shell/e-shell.h>

                    EShell;
enum                EShellLineStatus;
EShell *            e_shell_new                         (gboolean online);
GList *             e_shell_list_modules                (EShell *shell);
const gchar *       e_shell_get_canonical_name          (EShell *shell,
                                                         const gchar *name);
EShellModule *      e_shell_get_module_by_name          (EShell *shell,
                                                         const gchar *name);
EShellModule *      e_shell_get_module_by_scheme        (EShell *shell,
                                                         const gchar *scheme);
GtkWidget *         e_shell_create_window               (EShell *shell);
gboolean            e_shell_handle_uri                  (EShell *shell,
                                                         const gchar *uri);
void                e_shell_send_receive                (EShell *shell,
                                                         GtkWindow *parent);
gboolean            e_shell_get_online_mode             (EShell *shell);
void                e_shell_set_online_mode             (EShell *shell,
                                                         gboolean online_mode);
EShellLineStatus    e_shell_get_line_status             (EShell *shell);
void                e_shell_set_line_status             (EShell *shell,
                                                         EShellLineStatus status);
GtkWidget *         e_shell_get_preferences_window      (void);
gboolean            e_shell_is_busy                     (EShell *shell);
gboolean            e_shell_do_quit                     (EShell *shell);
gboolean            e_shell_quit                        (EShell *shell);

Object Hierarchy

  GObject
   +----EShell

Properties

  "online-mode"              gboolean              : Read / Write / Construct

Signals

  "handle-uri"                                     : Run Last / Action
  "send-receive"                                   : Run Last / Action
  "window-created"                                 : Run Last
  "window-destroyed"                               : Run Last

Description

Details

EShell

typedef struct _EShell EShell;

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

enum EShellLineStatus

enum EShellLineStatus {
	E_SHELL_LINE_STATUS_ONLINE,
	E_SHELL_LINE_STATUS_GOING_OFFLINE, /* NB: really means changing state in either direction */
	E_SHELL_LINE_STATUS_OFFLINE,
	E_SHELL_LINE_STATUS_FORCED_OFFLINE
};

e_shell_new ()

EShell *            e_shell_new                         (gboolean online);

online :

Returns :

e_shell_list_modules ()

GList *             e_shell_list_modules                (EShell *shell);

shell :

Returns :

e_shell_get_canonical_name ()

const gchar *       e_shell_get_canonical_name          (EShell *shell,
                                                         const gchar *name);

shell :

name :

Returns :

e_shell_get_module_by_name ()

EShellModule *      e_shell_get_module_by_name          (EShell *shell,
                                                         const gchar *name);

shell :

name :

Returns :

e_shell_get_module_by_scheme ()

EShellModule *      e_shell_get_module_by_scheme        (EShell *shell,
                                                         const gchar *scheme);

shell :

scheme :

Returns :

e_shell_create_window ()

GtkWidget *         e_shell_create_window               (EShell *shell);

shell :

Returns :

e_shell_handle_uri ()

gboolean            e_shell_handle_uri                  (EShell *shell,
                                                         const gchar *uri);

shell :

uri :

Returns :

e_shell_send_receive ()

void                e_shell_send_receive                (EShell *shell,
                                                         GtkWindow *parent);

shell :

parent :

e_shell_get_online_mode ()

gboolean            e_shell_get_online_mode             (EShell *shell);

shell :

Returns :

e_shell_set_online_mode ()

void                e_shell_set_online_mode             (EShell *shell,
                                                         gboolean online_mode);

shell :

online_mode :

e_shell_get_line_status ()

EShellLineStatus    e_shell_get_line_status             (EShell *shell);

shell :

Returns :

e_shell_set_line_status ()

void                e_shell_set_line_status             (EShell *shell,
                                                         EShellLineStatus status);

shell :

status :

e_shell_get_preferences_window ()

GtkWidget *         e_shell_get_preferences_window      (void);

Returns :

e_shell_is_busy ()

gboolean            e_shell_is_busy                     (EShell *shell);

shell :

Returns :

e_shell_do_quit ()

gboolean            e_shell_do_quit                     (EShell *shell);

shell :

Returns :

e_shell_quit ()

gboolean            e_shell_quit                        (EShell *shell);

shell :

Returns :

Property Details

The "online-mode" property

  "online-mode"              gboolean              : Read / Write / Construct

Whether the shell is online.

Default value: TRUE

Signal Details

The "handle-uri" signal

gboolean            user_function                      (EShell  *eshell,
                                                        gchar   *arg1,
                                                        gpointer user_data)      : Run Last / Action

eshell :

 the object which received the signal.

arg1 :

user_data :

 user data set when the signal handler was connected.

Returns :

The "send-receive" signal

void                user_function                      (EShell    *eshell,
                                                        GtkWindow *arg1,
                                                        gpointer   user_data)      : Run Last / Action

eshell :

 the object which received the signal.

arg1 :

user_data :

 user data set when the signal handler was connected.

The "window-created" signal

void                user_function                      (EShell       *eshell,
                                                        EShellWindow *arg1,
                                                        gpointer      user_data)      : Run Last

eshell :

 the object which received the signal.

arg1 :

user_data :

 user data set when the signal handler was connected.

The "window-destroyed" signal

void                user_function                      (EShell  *eshell,
                                                        gboolean arg1,
                                                        gpointer user_data)      : Run Last

eshell :

 the object which received the signal.

arg1 :

user_data :

 user data set when the signal handler was connected.
Generated by GTK-Doc V1.11