Top | ![]() |
![]() |
![]() |
![]() |
gboolean | can-copy | Read |
gboolean | can-cut | Read |
gboolean | can-paste | Read |
gboolean | can-redo | Read |
gboolean | can-undo | Read |
gboolean | changed | Read / Write |
gboolean | html-mode | Read / Write / Construct |
gboolean | inline-spelling | Read / Write / Construct |
gboolean | magic-links | Read / Write / Construct |
gboolean | magic-smileys | Read / Write / Construct |
ESpellChecker * | spell-checker | Read |
gboolean | unicode-smileys | Read / Write / Construct |
GObject ╰── GInitiallyUnowned ╰── GtkWidget ╰── GtkContainer ╰── WebKitWebView ╰── EHTMLEditorView
EHTMLEditorView *
e_html_editor_view_new (void
);
Returns a new instance of the editor.
EHTMLEditorSelection *
e_html_editor_view_get_selection (EHTMLEditorView *view
);
Returns an EHTMLEditorSelection object which represents current selection or cursor position within the editor document. The EHTMLEditorSelection allows programmer to manipulate with formatting, selection, styles etc.
An always valid EHTMLEditorSelection object. The object is owned by
the view
and should never be free'd.
gboolean e_html_editor_view_exec_command (EHTMLEditorView *view
,EHTMLEditorViewCommand command
,const gchar *value
);
The function will fail when value
is NULL
or empty but the current command
requires a value to be passed. The value
is ignored when the command
does
not expect any value.
view |
||
command |
an EHTMLEditorViewCommand to execute |
|
value |
value of the command (or |
gboolean
e_html_editor_view_get_changed (EHTMLEditorView *view
);
Whether content of the editor has been changed.
void e_html_editor_view_set_changed (EHTMLEditorView *view
,gboolean changed
);
Sets whether document has been changed or not. The editor is tracking changes automatically, but sometimes it's necessary to change the dirty flag to force "Save changes" dialog for example.
gboolean
e_html_editor_view_get_html_mode (EHTMLEditorView *view
);
Whether the editor is in HTML mode or plain text mode. In HTML mode, more formatting options are avilable an the email is sent as multipart/alternative.
void e_html_editor_view_set_html_mode (EHTMLEditorView *view
,gboolean html_mode
);
When switching from HTML to plain text mode, user will be prompted whether he/she really wants to switch the mode and lose all formatting. When user declines, the property is not changed. When they accept, the all formatting is lost.
void
e_html_editor_view_save_history_for_drop
(EHTMLEditorView *view
);
gboolean
e_html_editor_view_get_inline_spelling
(EHTMLEditorView *view
);
Returns whether automatic spellchecking is enabled or not. When enabled, editor will perform spellchecking as user is typing. Otherwise spellcheck has to be run manually from menu.
void e_html_editor_view_set_inline_spelling (EHTMLEditorView *view
,gboolean inline_spelling
);
Enables or disables automatic spellchecking.
gboolean
e_html_editor_view_get_magic_links (EHTMLEditorView *view
);
Returns whether automatic links conversion is enabled. When enabled, the editor will automatically convert any HTTP links into clickable HTML links.
void e_html_editor_view_set_magic_links (EHTMLEditorView *view
,gboolean magic_links
);
Enables or disables automatic links conversion.
void e_html_editor_view_insert_smiley (EHTMLEditorView *view
,EEmoticon *emoticon
);
gboolean
e_html_editor_view_get_magic_smileys (EHTMLEditorView *view
);
Returns whether automatic conversion of smileys is enabled or disabled. When enabled, the editor will automatically convert text smileys ( :-), ;-),...) into images or Unicode characters.
void e_html_editor_view_set_magic_smileys (EHTMLEditorView *view
,gboolean magic_smileys
);
Enables or disables magic smileys.
gboolean
e_html_editor_view_get_unicode_smileys
(EHTMLEditorView *view
);
Returns whether to use Unicode characters for smileys.
Since: 3.16
void e_html_editor_view_set_unicode_smileys (EHTMLEditorView *view
,gboolean unicode_smileys
);
Enables or disables the usage of Unicode characters for smileys.
Since: 3.16
ESpellChecker *
e_html_editor_view_get_spell_checker (EHTMLEditorView *view
);
Returns an ESpellChecker object that is used to perform spellchecking.
gchar * e_html_editor_view_get_text_html (EHTMLEditorView *view
,const gchar *from_domain
,GList **inline_images
);
Returns processed HTML content of the editor document (without elements attributes used in Evolution composer)
gchar * e_html_editor_view_get_text_html_for_drafts_with_images (EHTMLEditorView *view
,const gchar *from_domain
,GList **inline_images
);
gchar *
e_html_editor_view_get_text_html_for_drafts
(EHTMLEditorView *view
);
Returns HTML content of the editor document (with elements attributes used in Evolution composer)
gchar *
e_html_editor_view_get_body_text_html_for_drafts
(EHTMLEditorView *view
);
gchar *
e_html_editor_view_get_text_plain (EHTMLEditorView *view
);
Returns plain text content of the view
. The algorithm removes any
formatting or styles from the document and keeps only the text and line
breaks.
void e_html_editor_view_convert_and_insert_plain_text (EHTMLEditorView *view
,const gchar *text
);
void e_html_editor_view_convert_and_insert_html_to_plain_text (EHTMLEditorView *view
,const gchar *html
);
void e_html_editor_view_convert_element_from_html_to_plain_text (EHTMLEditorView *view
,WebKitDOMElement *element
);
void e_html_editor_view_set_text_html (EHTMLEditorView *view
,const gchar *text
);
Loads given text
into the editor, destroying any content already present.
void e_html_editor_view_set_text_plain (EHTMLEditorView *view
,const gchar *text
);
Loads given text
into the editor, destryoing any content already present.
void
e_html_editor_view_paste_as_text (EHTMLEditorView *view
);
Pastes current content of clipboard into the editor without formatting
void
e_html_editor_view_paste_clipboard_quoted
(EHTMLEditorView *view
);
Pastes current content of clipboard into the editor as quoted text
void
e_html_editor_view_remove_embed_styles
(EHTMLEditorView *view
);
void
e_html_editor_view_update_fonts (EHTMLEditorView *view
);
Forces the editor to reload font settings from WebKitWebSettings and apply it on the content of the editor document.
void e_html_editor_view_check_magic_links (EHTMLEditorView *view
,gboolean while_typing
);
Check if actual selection in given editor is link. If so, it is surrounded with ANCHOR element.
WebKitDOMElement * e_html_editor_view_quote_plain_text_element (EHTMLEditorView *view
,WebKitDOMElement *element
);
WebKitDOMElement *
e_html_editor_view_quote_plain_text (EHTMLEditorView *view
);
Quote text inside citation blockquotes in plain text mode.
As this function is cloning and replacing all citation blockquotes keep on mind that any pointers to nodes inside these blockquotes will be invalidated.
void
e_html_editor_view_dequote_plain_text (EHTMLEditorView *view
);
Dequote already quoted plain text in editor. Editor have to be quoted with e_html_editor_view_quote_plain_text otherwise it's not working.
void
e_html_editor_view_turn_spell_check_off
(EHTMLEditorView *view
);
void
e_html_editor_view_force_spell_check_for_current_paragraph
(EHTMLEditorView *view
);
void
e_html_editor_view_force_spell_check (EHTMLEditorView *view
);
void
e_html_editor_view_force_spell_check_in_viewport
(EHTMLEditorView *view
);
void e_html_editor_view_quote_plain_text_element_after_wrapping (WebKitDOMDocument *document
,WebKitDOMElement *element
,gint quote_level
);
void e_html_editor_view_add_inline_image_from_mime_part (EHTMLEditorView *view
,CamelMimePart *part
);
This adds the mime part part
to composer
as an inline image.
void
remove_image_attributes_from_element (WebKitDOMElement *element
);
gboolean
e_html_editor_view_is_message_from_draft
(EHTMLEditorView *view
);
void e_html_editor_view_set_is_editting_message (EHTMLEditorView *view
,gboolean value
);
void e_html_editor_view_set_is_message_from_draft (EHTMLEditorView *view
,gboolean value
);
void e_html_editor_view_set_is_message_from_selection (EHTMLEditorView *view
,gboolean value
);
gboolean
e_html_editor_view_is_message_from_edit_as_new
(EHTMLEditorView *view
);
void e_html_editor_view_set_is_message_from_edit_as_new (EHTMLEditorView *view
,gboolean value
);
gboolean
e_html_editor_view_content_is_new_message
(EHTMLEditorView *view
);
void e_html_editor_view_set_content_is_new_message (EHTMLEditorView *view
,gboolean value
);
void e_html_editor_view_insert_quoted_text (EHTMLEditorView *view
,const gchar *text
);
void e_html_editor_view_set_link_color (EHTMLEditorView *view
,GdkRGBA *color
);
void e_html_editor_view_set_visited_link_color (EHTMLEditorView *view
,GdkRGBA *color
);
void
e_html_editor_view_fix_file_uri_images
(EHTMLEditorView *view
);
void e_html_editor_view_insert_new_history_event (EHTMLEditorView *view
,EHTMLEditorViewHistoryEvent *event
);
gboolean
e_html_editor_view_is_undo_redo_in_progress
(EHTMLEditorView *view
);
void e_html_editor_view_set_undo_redo_in_progress (EHTMLEditorView *view
,gboolean value
);
void
e_html_editor_view_block_style_updated_callbacks
(EHTMLEditorView *view
);
void
e_html_editor_view_unblock_style_updated_callbacks
(EHTMLEditorView *view
);
gboolean
e_html_editor_view_is_pasting_content_from_itself
(EHTMLEditorView *view
);
void
e_html_editor_view_remove_input_event_listener_from_body
(EHTMLEditorView *view
);
void
e_html_editor_view_register_input_event_listener_on_body
(EHTMLEditorView *view
);
gchar * e_html_editor_view_insert_signature (EHTMLEditorView *view
,const gchar *content
,gboolean is_html
,const gchar *id
,gboolean *set_signature_from_message
,gboolean *check_if_signature_is_changed
,gboolean *ignore_next_signature_change
);
void
e_html_editor_view_reconnect_paste_clipboard_signals
(EHTMLEditorView *view
);
typedef struct { gint from; /* From what format we are changing. */ gint to; /* To what format we are changing. */ } EHTMLEditorViewStyleChange;
typedef struct { WebKitDOMNode *from; /* From what node we are changing. */ WebKitDOMNode *to; /* To what node we are changing. */ } EHTMLEditorViewDOMChange;
typedef struct { gchar *from; /* From what format we are changing. */ gchar *to; /* To what format we are changing. */ } EHTMLEditorViewStringChange;
typedef struct { EHTMLEditorViewSelectionPoint start; EHTMLEditorViewSelectionPoint end; } EHTMLEditorViewSelection;
typedef struct { enum EHTMLEditorViewHistoryEventType type; EHTMLEditorViewSelection before; EHTMLEditorViewSelection after; union { WebKitDOMDocumentFragment *fragment; EHTMLEditorViewStyleChange style; EHTMLEditorViewStringChange string; EHTMLEditorViewDOMChange dom; } data; } EHTMLEditorViewHistoryEvent;
“can-copy”
property“can-copy” gboolean
Determines whether it's possible to copy to clipboard. The action is usually disabled when there is no selection to copy.
Flags: Read
Default value: FALSE
“can-cut”
property“can-cut” gboolean
Determines whether it's possible to cut to clipboard. The action is usually disabled when there is no selection to cut.
Flags: Read
Default value: FALSE
“can-paste”
property“can-paste” gboolean
Determines whether it's possible to paste from clipboard. The action is usually disabled when there is no valid content in clipboard to paste.
Flags: Read
Default value: FALSE
“can-redo”
property“can-redo” gboolean
Determines whether it's possible to redo previous action. The action is usually disabled when there is no action to redo.
Flags: Read
Default value: FALSE
“can-undo”
property“can-undo” gboolean
Determines whether it's possible to undo last action. The action is usually disabled when there is no previous action to undo.
Flags: Read
Default value: FALSE
“changed”
property“changed” gboolean
Determines whether document has been modified
Flags: Read / Write
Default value: FALSE
“html-mode”
property“html-mode” gboolean
Determines whether HTML or plain text mode is enabled.
Flags: Read / Write / Construct
Default value: TRUE
“inline-spelling”
property“inline-spelling” gboolean
Check your spelling as you type.
Flags: Read / Write / Construct
Default value: TRUE
“magic-links”
property“magic-links” gboolean
Determines whether automatic conversion of text links into HTML links is enabled.
Flags: Read / Write / Construct
Default value: TRUE
“magic-smileys”
property“magic-smileys” gboolean
Determines whether automatic conversion of text smileys into images or Unicode characters is enabled.
Flags: Read / Write / Construct
Default value: TRUE
“spell-checker”
property“spell-checker” ESpellChecker *
The ESpellChecker used for spell checking.
Flags: Read
“unicode-smileys”
property“unicode-smileys” gboolean
Determines whether Unicode characters should be used for smileys.
Flags: Read / Write / Construct
Default value: TRUE
“is-ready”
signalvoid user_function (EHTMLEditorView *ehtmleditorview, gpointer user_data)
Flags: Run Last
“paste-primary-clipboard”
signalvoid user_function (EHTMLEditorView *ehtmleditorview, gpointer user_data)
Flags: Run Last
“popup-event”
signalgboolean user_function (EHTMLEditorView *ehtmleditorview, GdkEvent *arg1, gpointer user_data)
Flags: Run Last