EHTMLEditor

EHTMLEditor

Synopsis

struct              EHTMLEditor;
GtkWidget *         e_html_editor_new                   (void);
EHTMLEditorView *   e_html_editor_get_view              (EHTMLEditor *editor);
GtkBuilder *        e_html_editor_get_builder           (EHTMLEditor *editor);
GtkUIManager *      e_html_editor_get_ui_manager        (EHTMLEditor *editor);
GtkAction *         e_html_editor_get_action            (EHTMLEditor *editor,
                                                         const gchar *action_name);
GtkActionGroup *    e_html_editor_get_action_group      (EHTMLEditor *editor,
                                                         const gchar *group_name);
GtkWidget *         e_html_editor_get_widget            (EHTMLEditor *editor,
                                                         const gchar *widget_name);
GtkWidget *         e_html_editor_get_managed_widget    (EHTMLEditor *editor,
                                                         const gchar *widget_path);
const gchar *       e_html_editor_get_filename          (EHTMLEditor *editor);
void                e_html_editor_set_filename          (EHTMLEditor *editor,
                                                         const gchar *filename);
EActivity *         e_html_editor_new_activity          (EHTMLEditor *editor);
void                e_html_editor_pack_above            (EHTMLEditor *editor,
                                                         GtkWidget *child);
gboolean            e_html_editor_save                  (EHTMLEditor *editor,
                                                         const gchar *filename,
                                                         gboolean as_html,
                                                         GError **error);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkWidget
               +----GtkContainer
                     +----GtkGrid
                           +----EHTMLEditor

Implemented Interfaces

EHTMLEditor implements AtkImplementorIface, GtkBuildable, GtkOrientable and EAlertSink.

Properties

  "filename"                 gchar*                : Read / Write

Signals

  "spell-languages-changed"                        : Run Last
  "update-actions"                                 : Run Last

Description

Details

struct EHTMLEditor

struct EHTMLEditor;

EHTMLEditor provides GUI for manipulating with properties of EHTMLEditorView and its EHTMLEditorSelection - i.e. toolbars and actions.


e_html_editor_new ()

GtkWidget *         e_html_editor_new                   (void);

Constructs a new EHTMLEditor.

Returns :

A newly created widget. [transfer-full]

e_html_editor_get_view ()

EHTMLEditorView *   e_html_editor_get_view              (EHTMLEditor *editor);

editor :

an EHTMLEditor

Returns :

instance of EHTMLEditorView used in the editor.

e_html_editor_get_builder ()

GtkBuilder *        e_html_editor_get_builder           (EHTMLEditor *editor);

e_html_editor_get_ui_manager ()

GtkUIManager *      e_html_editor_get_ui_manager        (EHTMLEditor *editor);

editor :

an EHTMLEditor

Returns :

GtkUIManager that manages all the actions in the editor.

e_html_editor_get_action ()

GtkAction *         e_html_editor_get_action            (EHTMLEditor *editor,
                                                         const gchar *action_name);

editor :

an EHTMLEditor

action_name :

name of action to lookup and return

Returns :

A GtkAction matching action_name or NULL if no such action exists.

e_html_editor_get_action_group ()

GtkActionGroup *    e_html_editor_get_action_group      (EHTMLEditor *editor,
                                                         const gchar *group_name);

editor :

an EHTMLEditor

group_name :

name of action group to lookup and return

Returns :

A GtkActionGroup matching group_name or NULL if not such action group exists.

e_html_editor_get_widget ()

GtkWidget *         e_html_editor_get_widget            (EHTMLEditor *editor,
                                                         const gchar *widget_name);

e_html_editor_get_managed_widget ()

GtkWidget *         e_html_editor_get_managed_widget    (EHTMLEditor *editor,
                                                         const gchar *widget_path);

e_html_editor_get_filename ()

const gchar *       e_html_editor_get_filename          (EHTMLEditor *editor);

editor :

an EHTMLEditor

Returns :

path and name of file to which content of the editor should be saved.

e_html_editor_set_filename ()

void                e_html_editor_set_filename          (EHTMLEditor *editor,
                                                         const gchar *filename);

Sets file to which content of the editor should be saved (see e_html_editor_save()).

editor :

an EHTMLEditor

filename :

Target file

e_html_editor_new_activity ()

EActivity *         e_html_editor_new_activity          (EHTMLEditor *editor);

Creates and configures a new EActivity so its progress is shown in the editor. The EActivity comes pre-loaded with a CamelOperation.

editor :

an EHTMLEditor

Returns :

a new EActivity for use with editor

e_html_editor_pack_above ()

void                e_html_editor_pack_above            (EHTMLEditor *editor,
                                                         GtkWidget *child);

Inserts child right between the toolbars and the editor widget itself.

editor :

an EHTMLEditor

child :

a GtkWidget

e_html_editor_save ()

gboolean            e_html_editor_save                  (EHTMLEditor *editor,
                                                         const gchar *filename,
                                                         gboolean as_html,
                                                         GError **error);

Saves current content of the EHTMLEditorView into given file. When as_html is FALSE, the content is first converted into plain text.

editor :

an EHTMLEditor

filename :

file into which to save the content

as_html :

whether the content should be saved as HTML or plain text

error :

[out] a GError

Returns :

TRUE when content is succesfully saved, FALSE otherwise.

Property Details

The "filename" property

  "filename"                 gchar*                : Read / Write

Default value: NULL

Signal Details

The "spell-languages-changed" signal

void                user_function                      (EHTMLEditor *ehtmleditor,
                                                        gpointer     user_data)        : Run Last

The "update-actions" signal

void                user_function                      (EHTMLEditor *ehtmleditor,
                                                        GdkEvent    *arg1,
                                                        gpointer     user_data)        : Run Last