Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIPlaintextEditor Interface Reference

import "nsIPlaintextEditor.idl";

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

List of all members.

Public Member Functions

void handleKeyPress (in nsIDOMKeyEvent aKeyEvent)
 EditorKeyPress consumes a keyevent.
void insertText (in DOMString aStringToInsert)
 Inserts a string at the current location, given by the selection.
void insertLineBreak ()
 Insert a line break into the content model.

Public Attributes

const short eEditorPlaintextBit = 0
const short eEditorSingleLineBit = 1
const short eEditorPasswordBit = 2
const short eEditorReadonlyBit = 3
const short eEditorDisabledBit = 4
const short eEditorFilterInputBit = 5
const short eEditorMailBit = 6
const short eEditorUseAsyncUpdatesBit = 7
const short eEditorEnableWrapHackBit = 8
const short eEditorWidgetBit = 9
const short eEditorNoCSSBit = 10
const long eEditorPlaintextMask = 1
const long eEditorSingleLineMask = 2
const long eEditorPasswordMask = 4
const long eEditorReadonlyMask = 8
const long eEditorDisabledMask = 16
const long eEditorFilterInputMask = 32
const long eEditorMailMask = 64
const long eEditorUseAsyncUpdatesMask = 128
const long eEditorEnableWrapHackMask = 256
const long eEditorWidgetMask = 512
const long eEditorNoCSSMask = 1024
readonly attribute long textLength
 The length of the contents in characters.
attribute long maxTextLength
 The maximum number of characters allowed.
attribute long wrapWidth
 Get and set the body wrap width.

Detailed Description

Definition at line 47 of file nsIPlaintextEditor.idl.


Member Function Documentation

EditorKeyPress consumes a keyevent.

Parameters:
aKeyEventkey event to consume

Insert a line break into the content model.

The interpretation of a break is up to the implementation: it may enter a character, split a node in the tree, etc. This may be more efficient than calling InsertText with a newline.

void nsIPlaintextEditor::insertText ( in DOMString  aStringToInsert)

Inserts a string at the current location, given by the selection.

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

Member Data Documentation

Definition at line 55 of file nsIPlaintextEditor.idl.

Definition at line 67 of file nsIPlaintextEditor.idl.

Definition at line 59 of file nsIPlaintextEditor.idl.

Definition at line 71 of file nsIPlaintextEditor.idl.

Definition at line 56 of file nsIPlaintextEditor.idl.

Definition at line 68 of file nsIPlaintextEditor.idl.

Definition at line 57 of file nsIPlaintextEditor.idl.

Definition at line 69 of file nsIPlaintextEditor.idl.

Definition at line 61 of file nsIPlaintextEditor.idl.

Definition at line 73 of file nsIPlaintextEditor.idl.

Definition at line 53 of file nsIPlaintextEditor.idl.

Definition at line 65 of file nsIPlaintextEditor.idl.

Definition at line 51 of file nsIPlaintextEditor.idl.

Definition at line 63 of file nsIPlaintextEditor.idl.

Definition at line 54 of file nsIPlaintextEditor.idl.

Definition at line 66 of file nsIPlaintextEditor.idl.

Definition at line 52 of file nsIPlaintextEditor.idl.

Definition at line 64 of file nsIPlaintextEditor.idl.

Definition at line 58 of file nsIPlaintextEditor.idl.

Definition at line 70 of file nsIPlaintextEditor.idl.

Definition at line 60 of file nsIPlaintextEditor.idl.

Definition at line 72 of file nsIPlaintextEditor.idl.

The maximum number of characters allowed.

default: -1 (unlimited).

Definition at line 85 of file nsIPlaintextEditor.idl.

The length of the contents in characters.

XXX change this type to 'unsigned long'

Definition at line 79 of file nsIPlaintextEditor.idl.

Get and set the body wrap width.

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

Definition at line 93 of file nsIPlaintextEditor.idl.


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