EHTMLEditor

EHTMLEditor

Functions

Properties

char * filename Read / Write
gboolean paste-plain-prefer-pre Read / Write

Signals

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── GtkContainer
                ╰── GtkGrid
                    ╰── EHTMLEditor

Description

Functions

e_html_editor_new ()

void
e_html_editor_new (GAsyncReadyCallback callback,
                   gpointer user_data);

Constructs a new EHTMLEditor asynchronously. The result is returned by e_html_editor_new_finish(), which should be called inside callback .

Parameters

callback

a callback to be called when the editor is ready

 

user_data

a used data passed into the callback

 

Since: 3.22


e_html_editor_new_finish ()

GtkWidget *
e_html_editor_new_finish (GAsyncResult *result,
                          GError **error);

Finishes the call of e_html_editor_new().

Parameters

result

a GAsyncResult passed to callback from e_html_editor_new()

 

error

an optional GError

 

Returns

A newly created EHTMLEditor.

[transfer-full]

Since: 3.22


e_html_editor_get_content_editor ()

EContentEditor *
e_html_editor_get_content_editor (EHTMLEditor *editor);

Returns instance of EContentEditor used in the editor .

Parameters

editor

an EHTMLEditor

 

e_html_editor_register_content_editor ()

void
e_html_editor_register_content_editor (EHTMLEditor *editor,
                                       const gchar *name,
                                       EContentEditor *cnt_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);

Returns GtkUIManager that manages all the actions in the editor .

Parameters

editor

an EHTMLEditor

 

e_html_editor_get_action ()

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

Parameters

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);

Parameters

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_style_combo_box ()

GtkWidget *
e_html_editor_get_style_combo_box (EHTMLEditor *editor);

e_html_editor_get_filename ()

const gchar *
e_html_editor_get_filename (EHTMLEditor *editor);

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

Parameters

editor

an EHTMLEditor

 

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()).

Parameters

editor

an EHTMLEditor

 

filename

Target file

 

e_html_editor_get_activity_bar ()

EActivityBar *
e_html_editor_get_activity_bar (EHTMLEditor *editor);

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.

Parameters

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.

Parameters

editor

an EHTMLEditor

 

child

a GtkWidget

 

e_html_editor_update_spell_actions ()

void
e_html_editor_update_spell_actions (EHTMLEditor *editor);

e_html_editor_save ()

void
e_html_editor_save (EHTMLEditor *editor,
                    const gchar *filename,
                    gboolean as_html,
                    GCancellable *cancellable,
                    GAsyncReadyCallback callback,
                    gpointer user_data);

Starts an asynchronous save of the current content of the EContentEditor into given file. When as_html is FALSE , the content is first converted into plain text.

Finish the call with e_html_editor_save_finish() from the callback .

Parameters

editor

an EHTMLEditor

 

filename

file into which to save the content

 

as_html

whether the content should be saved as HTML or plain text

 

cancellable

an optional GCancellable, or NULL

 

callback

a GAsyncReadyCallback to call when the save is finished.

[scope async]

user_data

user data passed to callback .

[closure callback]

Since: 3.38


e_html_editor_save_finish ()

gboolean
e_html_editor_save_finish (EHTMLEditor *editor,
                           GAsyncResult *result,
                           GError **error);

Finished the previous call of e_html_editor_save().

Parameters

editor

an EHTMLEditor

 

result

a GAsyncResult of the operation

 

error

return location for a GError, or NULL

 

Returns

whether the save succeeded.

Since: 3.38


e_html_editor_add_cid_part ()

void
e_html_editor_add_cid_part (EHTMLEditor *editor,
                            CamelMimePart *mime_part);

Add the mime_part with its Content-ID (if not set, one is assigned), which can be later obtained with e_html_editor_ref_cid_part();

Parameters

editor

an EHTMLEditor

 

mime_part

a CamelMimePart

 

Since: 3.38


e_html_editor_remove_cid_part ()

void
e_html_editor_remove_cid_part (EHTMLEditor *editor,
                               const gchar *cid_uri);

Removes CID part with given cid_uri , previously added with e_html_editor_add_cid_part(). The function does nothing if no such part is stored.

Parameters

editor

an EHTMLEditor

 

cid_uri

a Content ID URI (starts with "cid:") to remove

 

Since: 3.38


e_html_editor_remove_all_cid_parts ()

void
e_html_editor_remove_all_cid_parts (EHTMLEditor *editor);

Removes all CID parts previously added with e_html_editor_add_cid_part().

Parameters

editor

an EHTMLEditor

 

Since: 3.38


e_html_editor_ref_cid_part ()

CamelMimePart *
e_html_editor_ref_cid_part (EHTMLEditor *editor,
                            const gchar *cid_uri);

References a CamelMimePart with given cid_uri as Content ID, if previously added with e_html_editor_add_cid_part(). The cid_uri should start with "cid:".

The returned non-NULL object is references, thus it should be freed with g_object_unref(), when no longer needed.

Parameters

editor

an EHTMLEditor

 

cid_uri

a Content ID URI (starts with "cid:") to obtain the part for

 

Returns

a CamelMimePart with given Content ID, or NULL, if not found.

[transfer full][nullable]

Since: 3.38

Types and Values

E_HTML_EDITOR_MAX_INDENT_LEVEL

#define E_HTML_EDITOR_MAX_INDENT_LEVEL 10

Property Details

The “filename” property

  “filename”                 char *

Owner: EHTMLEditor

Flags: Read / Write

Default value: NULL


The “paste-plain-prefer-pre” property

  “paste-plain-prefer-pre”   gboolean

Owner: EHTMLEditor

Flags: Read / Write

Default value: FALSE

Signal Details

The “spell-languages-changed” signal

void
user_function (EHTMLEditor *ehtmleditor,
               gpointer     user_data)

Flags: Run Last


The “update-actions” signal

void
user_function (EHTMLEditor *ehtmleditor,
               guint        arg1,
               char        *arg2,
               gpointer     user_data)

Flags: Run Last