Back to index

lightning-sunbird  0.9+nobinonly
nsIPlaintextEditor.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037  
00038 #include "nsISupports.idl"
00039 
00040 %{C++
00041 #include "nsIDOMKeyEvent.h"
00042 %}
00043 
00044 [ptr] native nsIDOMKeyEvent(nsIDOMKeyEvent);
00045 
00046 [scriptable, uuid(b5f39ed4-1dd1-11b2-9d00-fd54d6f54962)]
00047 interface nsIPlaintextEditor : nsISupports
00048 {
00049 
00050   /* the bits in an editor behavior mask. */
00051   const short eEditorPlaintextBit = 0;                  /* only plain text entry is allowed via events */
00052   const short eEditorSingleLineBit = 1;                 /* enter key and CR-LF handled specially */
00053   const short eEditorPasswordBit = 2;                   /* text is not entered into content, only a representative character */
00054   const short eEditorReadonlyBit = 3;                   /* editing events are disabled.  Editor may still accept focus. */
00055   const short eEditorDisabledBit = 4;                   /* all events are disabled (like scrolling).  Editor will not accept focus. */
00056   const short eEditorFilterInputBit = 5;                /* text input is limited to certain character types, use mFilter */
00057   const short eEditorMailBit = 6;                       /* use mail-compose editting rules */
00058   const short eEditorUseAsyncUpdatesBit = 7;            /* prevent immediate reflows and view refreshes */
00059   const short eEditorEnableWrapHackBit = 8;             /* allow the editor to set font: monospace on the root node */
00060   const short eEditorWidgetBit = 9;                     /* bit for widgets */
00061   const short eEditorNoCSSBit = 10;                     /* this HTML editor should not create css styles */
00062 
00063   const long eEditorPlaintextMask            = 1;
00064   const long eEditorSingleLineMask           = 2;
00065   const long eEditorPasswordMask             = 4;
00066   const long eEditorReadonlyMask             = 8;
00067   const long eEditorDisabledMask             = 16;
00068   const long eEditorFilterInputMask          = 32;
00069   const long eEditorMailMask                 = 64;
00070   const long eEditorUseAsyncUpdatesMask      = 128;
00071   const long eEditorEnableWrapHackMask       = 256;
00072   const long eEditorWidgetMask               = 512;
00073   const long eEditorNoCSSMask                = 1024;
00074 
00079   readonly attribute long textLength;
00080 
00085   attribute long maxTextLength;
00086 
00093   attribute long wrapWidth;
00094 
00099   [noscript]void handleKeyPress(in nsIDOMKeyEvent aKeyEvent);
00100 
00109    void insertText(in DOMString aStringToInsert);
00110   
00117   void insertLineBreak();
00118 };