gecko-dev/editor/idl/nsIPlaintextEditor.idl

109 lines
4.1 KiB
Plaintext

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* The contents of this file are subject to the Netscape Public
* License Version 1.1 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.mozilla.org/NPL/
*
* Software distributed under the License is distributed on an "AS
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
* implied. See the License for the specific language governing
* rights and limitations under the License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is Netscape
* Communications Corporation. Portions created by Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All
* Rights Reserved.
*
* Contributor(s):
*/
#include "nsISupports.idl"
%{C++
#include "nsIDOMKeyEvent.h"
%}
[ptr] native nsIDOMKeyEvent(nsIDOMKeyEvent);
[scriptable, uuid(b5f39ed4-1dd1-11b2-9d00-fd54d6f54962)]
interface nsIPlaintextEditor : nsISupports
{
/* the bits in an editor behavior mask. */
const short eEditorPlaintextBit = 0; /* only plain text entry is allowed via events */
const short eEditorSingleLineBit = 1; /* enter key and CR-LF handled specially */
const short eEditorPasswordBit = 2; /* text is not entered into content, only a representative character */
const short eEditorReadonlyBit = 3; /* editing events are disabled. Editor may still accept focus. */
const short eEditorDisabledBit = 4; /* all events are disabled (like scrolling). Editor will not accept focus. */
const short eEditorFilterInputBit = 5; /* text input is limited to certain character types, use mFilter */
const short eEditorMailBit = 6; /* use mail-compose editting rules */
const short eEditorDisableForcedUpdatesBit = 7; /* prevent immediate view refreshes */
const short eEditorDisableForcedReflowsBit = 8; /* prevent immediate reflows */
const short eEditorEnableWrapHackBit = 9; /* allow the editor to set font: monospace on the root node */
const short eEditorWidgetBit = 10; /* bit for widgets */
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 eEditorDisableForcedUpdatesMask = 128;
const long eEditorDisableForcedReflowsMask = 256;
const long eEditorEnableWrapHackMask = 512;
const long eEditorWidgetMask = 1024;
/**
* The length of the contents in characters.
*/
readonly attribute long textLength;
/**
* The maximum number of characters allowed.
*/
attribute long maxTextLength;
/** Get and set the body wrap width.
*
* Special values:
* 0 = wrap to window width
* -1 = no wrap at all
*/
attribute long wrapWidth;
/**
* EditorKeyPress consumes a keyevent.
* @param aKeyEvent key event to consume
*/
[noscript]void handleKeyPress(in nsIDOMKeyEvent aKeyEvent);
/**
* 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.
*
* @param aString the string to be inserted
*/
void insertText(in wstring aStringToInsert);
/**
* 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 insertLineBreak();
/**
* Set selection to start of text.
* This will be moved to a different API eventually!
* Should probably be done through the selection controller.
*/
void collapseSelectionToStart();
};