Back to index

lightning-sunbird  0.9+nobinonly
nsITextServicesDocument.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 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 #ifndef nsITextServicesDocument_h__
00039 #define nsITextServicesDocument_h__
00040 
00041 #include "nsISupports.h"
00042 
00043 class nsIDOMDocument;
00044 class nsIDOMRange;
00045 class nsIPresShell;
00046 class nsIEditor;
00047 class nsString;
00048 class nsITextServicesFilter;
00049 
00050 /*
00051 TextServicesDocument interface to outside world
00052 */
00053 
00054 #define NS_ITEXTSERVICESDOCUMENT_IID            \
00055 { /* 019718E1-CDB5-11d2-8D3C-000000000000 */    \
00056 0x019718e1, 0xcdb5, 0x11d2,                     \
00057 { 0x8d, 0x3c, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0 } }
00058 
00059 
00065 class nsITextServicesDocument  : public nsISupports{
00066 public:
00067 
00068   NS_DEFINE_STATIC_IID_ACCESSOR(NS_ITEXTSERVICESDOCUMENT_IID)
00069 
00070   typedef enum { eDSNormal=0, eDSUndlerline } TSDDisplayStyle;
00071 
00072   typedef enum { eBlockNotFound=0, // There is no text block (TB) in or before the selection (S).
00073                  eBlockOutside,    // No TB in S, but found one before/after S.
00074                  eBlockInside,     // S extends beyond the start and end of TB.
00075                  eBlockContains,   // TB contains entire S.
00076                  eBlockPartial     // S begins or ends in TB but extends outside of TB.
00077   } TSDBlockSelectionStatus;
00078 
00087   NS_IMETHOD InitWithDocument(nsIDOMDocument *aDOMDocument, nsIPresShell *aPresShell) = 0;
00088 
00093   NS_IMETHOD GetDocument(nsIDOMDocument **aDocument) = 0;
00094 
00102   NS_IMETHOD InitWithEditor(nsIEditor *aEditor) = 0;
00103 
00114   NS_IMETHOD SetExtent(nsIDOMRange* aDOMRange) = 0;
00115 
00124   NS_IMETHOD GetExtent(nsIDOMRange** aDOMRange) = 0;
00125 
00132   NS_IMETHOD ExpandRangeToWordBoundaries(nsIDOMRange *aRange) = 0;
00133 
00138   NS_IMETHOD SetFilter(nsITextServicesFilter *aFilter) = 0;
00139 
00146   NS_IMETHOD CanEdit(PRBool *aCanEdit) = 0;
00147 
00153   NS_IMETHOD GetCurrentTextBlock(nsString *aStr) = 0;
00154 
00161   NS_IMETHOD FirstBlock() = 0;
00162 
00169   NS_IMETHOD LastBlock() = 0;
00170 
00182   NS_IMETHOD FirstSelectedBlock(TSDBlockSelectionStatus *aSelectionStatus, PRInt32 *aSelectionOffset, PRInt32 *aSelectionLength) = 0;
00183 
00195   NS_IMETHOD LastSelectedBlock(TSDBlockSelectionStatus *aSelectionStatus, PRInt32 *aSelectionOffset, PRInt32 *aSelectionLength) = 0;
00196 
00205   NS_IMETHOD PrevBlock() = 0;
00206 
00215   NS_IMETHOD NextBlock() = 0;
00216 
00227   NS_IMETHOD IsDone(PRBool *aIsDone) = 0;
00228 
00239   NS_IMETHOD SetSelection(PRInt32 aOffset, PRInt32 aLength) = 0;
00240 
00245   NS_IMETHOD ScrollSelectionIntoView() = 0;
00246 
00253   NS_IMETHOD DeleteSelection() = 0;
00254 
00261   NS_IMETHOD InsertText(const nsString *aText) = 0;
00262 
00268   NS_IMETHOD SetDisplayStyle(TSDDisplayStyle aStyle) = 0;
00269 
00276   NS_IMETHOD GetDOMRangeFor(PRInt32 aOffset, PRInt32 aLength, nsIDOMRange** aRange) = 0;
00277 };
00278 
00279 #endif // nsITextServicesDocument_h__
00280