WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

@mozilla.org/editor/texteditor;1

This component implements the following interfaces:

Constants

PRInt16 nsIEditor.eNone = 0
PRInt16 nsIEditor.eNext = 1
PRInt16 nsIEditor.ePrevious = 2
PRInt16 nsIEditor.eNextWord = 3
PRInt16 nsIEditor.ePreviousWord = 4
PRInt16 nsIEditor.eToBeginningOfLine = 5
PRInt16 nsIEditor.eToEndOfLine = 6
PRInt32 nsIPlaintextEditor.eEditorPlaintextMask = 1
PRInt32 nsIPlaintextEditor.eEditorSingleLineMask = 2
PRInt32 nsIPlaintextEditor.eEditorPasswordMask = 4
PRInt32 nsIPlaintextEditor.eEditorReadonlyMask = 8
PRInt32 nsIPlaintextEditor.eEditorDisabledMask = 16
PRInt32 nsIPlaintextEditor.eEditorFilterInputMask = 32
PRInt32 nsIPlaintextEditor.eEditorMailMask = 64
PRInt32 nsIPlaintextEditor.eEditorUseAsyncUpdatesMask = 128
PRInt32 nsIPlaintextEditor.eEditorEnableWrapHackMask = 256
PRInt32 nsIPlaintextEditor.eEditorWidgetMask = 512
PRInt32 nsIPlaintextEditor.eEditorNoCSSMask = 1024
PRInt32 nsIPlaintextEditor.eEditorAllowInteraction = 2048
PRInt32 nsIPlaintextEditor.eNewlinesPasteIntact = 0
PRInt32 nsIPlaintextEditor.eNewlinesPasteToFirst = 1
PRInt32 nsIPlaintextEditor.eNewlinesReplaceWithSpaces = 2
PRInt32 nsIPlaintextEditor.eNewlinesStrip = 3
PRInt32 nsIPlaintextEditor.eNewlinesReplaceWithCommas = 4
PRInt32 nsIPlaintextEditor.eNewlinesStripSurroundingWhitespace = 5

Properties

char* nsIEditor.contentsMIMEType

The MimeType of the document

readonly nsIDOMDocument nsIEditor.document

The DOM Document this editor is associated with, refcounted.

ACString nsIEditor.documentCharacterSet

readonly PRBool nsIEditor.documentIsEmpty

readonly PRBool nsIEditor.documentModified

PRUint32 nsIEditor.flags

readonly PRBool nsIEditor.isDocumentEditable

PRInt32 nsIPlaintextEditor.maxTextLength

The maximum number of characters allowed. default: -1 (unlimited).

PRInt32 nsIPlaintextEditor.newlineHandling

Get and set newline handling.

Values are the constants defined above.

readonly DOMString nsIPhonetic.phonetic

Phonetic get the phonetic value of the input text

readonly nsIDOMElement nsIEditor.rootElement

The body element, i.e. the root of the editable document.

readonly nsISelection nsIEditor.selection

readonly nsISelectionController nsIEditor.selectionController

The selection controller for the current presentation, refcounted.

readonly PRInt32 nsIPlaintextEditor.textLength

The length of the contents in characters. XXX change this type to 'unsigned long'

nsITransactionManager nsIEditor.transactionManager

TransactionManager Get the transaction manager the editor is using.

PRInt32 nsIPlaintextEditor.wrapWidth

Get and set the body wrap width.

Special values: 0 = wrap to window width -1 = no wrap at all

Methods

InterfaceMethod
nsIEditor void addDocumentStateListener ( nsIDocumentStateListener listener )
nsIEditor void addEditActionListener ( nsIEditActionListener listener )
nsIEditor void addEditorObserver ( nsIEditorObserver observer )
nsIEditorIMESupport [noscript] void beginComposition ( nsTextEventReplyPtr* reply )
nsIEditor void beginningOfDocument ( )
nsIEditor void beginPlaceHolderTransaction ( nsIAtom name )
nsIEditor void beginTransaction ( )
nsIEditor PRBool canCopy ( )
nsIEditor PRBool canCut ( )
nsIEditor PRBool canDrag ( nsIDOMEvent event )
nsIEditor PRBool canPaste ( PRInt32 selectionType )
nsIEditor void canRedo ( out PRBool isEnabled , out PRBool canRedo )
nsIEditor void canUndo ( out PRBool isEnabled , out PRBool canUndo )
nsIEditor void cloneAttribute ( AString attribute , nsIDOMNode destNode , nsIDOMNode sourceNode )
nsIEditor void cloneAttributes ( nsIDOMNode destNode , nsIDOMNode sourceNode )
nsIEditor void copy ( )
nsIEditor nsIDOMNode createNode ( AString tag , nsIDOMNode parent , PRInt32 position )
nsIEditor void cut ( )
nsIEditor void debugDumpContent ( )
nsIEditor void debugUnitTests ( out PRInt32 outNumTests , out PRInt32 outNumTestsFailed )
nsIEditor void deleteNode ( nsIDOMNode child )
nsIEditor void deleteSelection ( PRInt16 action )
nsIEditor void doDrag ( nsIDOMEvent event )
nsIEditor void doTransaction ( nsITransaction txn )
nsIEditor void dumpContentTree ( )
nsIEditor void enableUndo ( PRBool enable )
nsIEditorIMESupport void endComposition ( )
nsIEditor void endOfDocument ( )
nsIEditor void endPlaceHolderTransaction ( )
nsIEditor void endTransaction ( )
nsIEditorIMESupport void forceCompositionEnd ( )
nsIEditor PRBool getAttributeValue ( nsIDOMElement element , AString attributestr , out AString resultValue )
nsIEditorMailSupport nsISupportsArray getEmbeddedObjects ( )
nsIEditor nsIInlineSpellChecker getInlineSpellChecker ( PRBool autoCreate )
nsIEditor PRInt32 getModificationCount ( )
nsIEditorIMESupport [noscript] void getPreferredIMEState ( out PRUint32 state )
nsIEditorIMESupport [noscript] void getQueryCaretRect ( nsQueryCaretRectEventReplyPtr* reply )
nsIEditorIMESupport [noscript] void getReconversionString ( nsReconversionEventReplyPtr* reply )
nsISupportsWeakReference nsIWeakReference GetWeakReference ( )
nsIPlaintextEditor void handleKeyPress ( nsIDOMKeyEvent keyEvent )
nsIEditor void incrementModificationCount ( PRInt32 modCount )
nsIEditor [noscript] void init ( nsIDOMDocument doc , nsIPresShellPtr shell , nsIContent root , nsISelectionController selCon , PRUint32 flags )
nsIEditorMailSupport nsIDOMNode insertAsCitedQuotation ( AString quotedText , AString citation , PRBool insertHTML )
nsIEditorMailSupport nsIDOMNode insertAsQuotation ( AString quotedText )
nsIEditor void insertFromDrop ( nsIDOMEvent event )
nsIPlaintextEditor void insertLineBreak ( )
nsIEditor void insertNode ( nsIDOMNode node , nsIDOMNode parent , PRInt32 position )
nsIPlaintextEditor void insertText ( DOMString stringToInsert )
nsIEditorMailSupport void insertTextWithQuotations ( DOMString stringToInsert )
nsIEditor [notxpcom] PRBool isModifiableNode ( nsIDOMNode node )
nsIEditor void joinNodes ( nsIDOMNode leftNode , nsIDOMNode rightNode , nsIDOMNode parent )
nsIEditor void markNodeDirty ( nsIDOMNode node )
nsIEditorIMESupport void notifyIMEOnBlur ( )
nsIEditorIMESupport void notifyIMEOnFocus ( )
nsIEditor void outputToStream ( nsIOutputStream stream , AString formatType , ACString charsetOverride , PRUint32 flags )
nsIEditor AString outputToString ( AString formatType , PRUint32 flags )
nsIEditor void paste ( PRInt32 selectionType )
nsIEditorMailSupport void pasteAsCitedQuotation ( AString citation , PRInt32 selectionType )
nsIEditorMailSupport void pasteAsQuotation ( PRInt32 selectionType )
nsIEditor void postCreate ( )
nsIEditor void preDestroy ( )
nsIEditorIMESupport [noscript] void queryComposition ( nsTextEventReplyPtr* reply )
nsIEditor void redo ( PRUint32 count )
nsIEditor void removeAttribute ( nsIDOMElement element , AString attribute )
nsIEditor void removeAttributeOrEquivalent ( nsIDOMElement element , DOMString sourceAttrName , PRBool suppressTransaction )
nsIEditor void removeDocumentStateListener ( nsIDocumentStateListener listener )
nsIEditor void removeEditActionListener ( nsIEditActionListener listener )
nsIEditor void removeEditorObserver ( nsIEditorObserver observer )
nsIEditor void resetModificationCount ( )
nsIEditorMailSupport void rewrap ( PRBool respectNewlines )
nsIEditor void selectAll ( )
nsIEditor void setAttribute ( nsIDOMElement element , AString attributestr , AString attvalue )
nsIEditor void setAttributeOrEquivalent ( nsIDOMElement element , AString sourceAttrName , AString sourceAttrValue , PRBool suppressTransaction )
nsIEditorIMESupport [noscript] void setCompositionString ( DOMString compositionString , nsIPrivateTextRangeListPtr textRange , nsTextEventReplyPtr* reply )
nsIEditor void setShouldTxnSetSelection ( PRBool should )
nsIEditor void setSpellcheckUserOverride ( PRBool enable )
nsIPlaintextEditor void setWrapColumn ( PRInt32 wrapColumn )
nsIEditor PRBool shouldTxnSetSelection ( )
nsIEditor void splitNode ( nsIDOMNode existingRightNode , PRInt32 offset , out nsIDOMNode newLeftNode )
nsIEditorMailSupport void stripCites ( )
nsIEditor void switchTextDirection ( )
nsIEditor void syncRealTimeSpell ( )
nsIEditor void undo ( PRUint32 count )

Reference documentation is generated from Mozilla's source.

Copyright © 1999-2006 XULPlanet.com