Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIEditorMailSupport Interface Reference

import "nsIEditorMailSupport.idl";

Inheritance diagram for nsIEditorMailSupport:
Inheritance graph
[legend]
Collaboration diagram for nsIEditorMailSupport:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void pasteAsQuotation (in long aSelectionType)
 Paste the text in the OS clipboard at the cursor position, as a quotation (whose representation is dependant on the editor type), replacing the selected text (if any).
nsIDOMNode insertAsQuotation (in AString aQuotedText)
 Insert a string as quoted text (whose representation is dependant on the editor type), replacing the selected text (if any).
void insertTextWithQuotations (in DOMString aStringToInsert)
 Inserts a plaintext string at the current location, with special processing for lines beginning with ">", which will be treated as mail quotes and inserted as plaintext quoted blocks.
void pasteAsCitedQuotation (in AString aCitation, in long aSelectionType)
 Paste a string as quoted text, whose representation is dependant on the editor type, replacing the selected text (if any)
nsIDOMNode insertAsCitedQuotation (in AString aQuotedText, in AString aCitation, in boolean aInsertHTML)
 Insert a string as quoted text (whose representation is dependant on the editor type), replacing the selected text (if any), including, if possible, a "cite" attribute.
void rewrap (in boolean aRespectNewlines)
 Rewrap the selected part of the document, re-quoting if necessary.
void stripCites ()
 Strip any citations in the selected part of the document.
nsISupportsArray getEmbeddedObjects ()
 Get a list of IMG and OBJECT tags in the current document.

Detailed Description

Definition at line 46 of file nsIEditorMailSupport.idl.


Member Function Documentation

Get a list of IMG and OBJECT tags in the current document.

nsIDOMNode nsIEditorMailSupport::insertAsCitedQuotation ( in AString  aQuotedText,
in AString  aCitation,
in boolean  aInsertHTML 
)

Insert a string as quoted text (whose representation is dependant on the editor type), replacing the selected text (if any), including, if possible, a "cite" attribute.

Parameters:
aQuotedTextThe actual text to be quoted
aCitationThe "mid" URL of the source message
aInsertHTMLInsert as html? (vs plaintext)
Returns:
The node which was inserted

Insert a string as quoted text (whose representation is dependant on the editor type), replacing the selected text (if any).

Parameters:
aQuotedTextThe actual text to be quoted
Returns:
The node which was inserted
void nsIEditorMailSupport::insertTextWithQuotations ( in DOMString  aStringToInsert)

Inserts a plaintext string at the current location, with special processing for lines beginning with ">", which will be treated as mail quotes and inserted as plaintext quoted blocks.

If the selection is not collapsed, the selection is deleted and the insertion takes place at the resulting collapsed selection.

Parameters:
aStringthe string to be inserted
void nsIEditorMailSupport::pasteAsCitedQuotation ( in AString  aCitation,
in long  aSelectionType 
)

Paste a string as quoted text, whose representation is dependant on the editor type, replacing the selected text (if any)

Parameters:
aCitationThe "mid" URL of the source message
aSelectionTypeText or html?

Paste the text in the OS clipboard at the cursor position, as a quotation (whose representation is dependant on the editor type), replacing the selected text (if any).

Parameters:
aSelectionTypeText or html?

Rewrap the selected part of the document, re-quoting if necessary.

Parameters:
aRespectNewlinesTry to maintain newlines in the original?

Strip any citations in the selected part of the document.


The documentation for this interface was generated from the following file: