Back to index

lightning-sunbird  0.9+nobinonly
nsITextWidget.h
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 the GNU General Public License Version 2 or later (the "GPL"), or
00026  * 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 #ifndef nsITextWidget_h__
00038 #define nsITextWidget_h__
00039 
00040 #include "nsIWidget.h"
00041 #include "nsString.h"
00042 
00043 // {F8030011-C342-11d1-97F0-00609703C14E}
00044 #define NS_ITEXTWIDGET_IID \
00045 { 0xf8030011, 0xc342, 0x11d1, { 0x97, 0xf0, 0x0, 0x60, 0x97, 0x3, 0xc1, 0x4e } }
00046 
00047 
00048 struct nsTextWidgetInitData : public nsWidgetInitData {
00049   nsTextWidgetInitData()
00050     : mIsPassword(PR_FALSE),
00051       mIsReadOnly(PR_FALSE)
00052   {
00053   }
00054 
00055   PRBool mIsPassword;
00056   PRBool mIsReadOnly;
00057 };
00058 
00059 
00068 class nsITextWidget : public nsISupports
00069 {
00070 
00071   public:
00072     NS_DEFINE_STATIC_IID_ACCESSOR(NS_ITEXTWIDGET_IID)
00073 
00074     
00084     NS_IMETHOD GetText(nsString &aTextBuffer, PRUint32 aBufferSize, PRUint32& aActualSize) = 0;
00085 
00095     NS_IMETHOD SetText(const nsString &aText, PRUint32& aActualSize) = 0;
00096 
00110     NS_IMETHOD InsertText(const nsString &aText, PRUint32 aStartPos, PRUint32 aEndPos, PRUint32& aActualSize) = 0;
00111 
00117     NS_IMETHOD RemoveText(void) = 0;
00118 
00127     NS_IMETHOD SetPassword(PRBool aIsPassword) = 0;
00128 
00136     NS_IMETHOD SetMaxTextLength(PRUint32 aChars) = 0;
00137 
00138 
00148     NS_IMETHOD SetReadOnly(PRBool aNewReadOnlyFlag, PRBool& aOldReadOnlyFlag) = 0;
00149     
00155     NS_IMETHOD SelectAll() = 0;
00156 
00164     NS_IMETHOD SetSelection(PRUint32 aStartSel, PRUint32 aEndSel) = 0;
00165 
00173     NS_IMETHOD GetSelection(PRUint32 *aStartSel, PRUint32 *aEndSel) = 0;
00174 
00181     NS_IMETHOD SetCaretPosition(PRUint32 aPosition) = 0;
00182 
00189     NS_IMETHOD GetCaretPosition(PRUint32& aPosition) = 0;
00190 
00191 };
00192 
00193 #endif // nsITextWidget_h__
00194