Back to index

lightning-sunbird  0.9+nobinonly
nsICaret.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 nsICaret_h__
00039 #define nsICaret_h__
00040 
00041 #include "nsISupports.h"
00042 #include "nsCOMPtr.h"
00043 #include "nsCoord.h"
00044 #include "nsIFrameSelection.h"
00045 
00046 struct nsRect;
00047 struct nsPoint;
00048 
00049 class nsIRenderingContext;
00050 class nsIFrame;
00051 class nsIView;
00052 class nsIPresShell;
00053 class nsISelection;
00054 class nsIDOMNode;
00055 
00056 // IID for the nsICaret interface
00057 // dcb01833-509d-4fcb-8f7f-6beb006261b9
00058 #define NS_ICARET_IID \
00059 { 0xdcb01833, 0x509d, 0x4fcb, \
00060   { 0x8f, 0x7f, 0x6b, 0xeb, 0x00, 0x62, 0x61, 0xb9 } }
00061 
00062 class nsICaret: public nsISupports
00063 {
00064 public:
00065   NS_DEFINE_STATIC_IID_ACCESSOR(NS_ICARET_IID)
00066 
00067   enum EViewCoordinates {
00068       eTopLevelWindowCoordinates,
00069       eRenderingViewCoordinates,
00070       eClosestViewCoordinates,
00071       eIMECoordinates
00072     };
00073 
00074   NS_IMETHOD Init(nsIPresShell *inPresShell) = 0;
00075   NS_IMETHOD Terminate() = 0;
00076   
00077   NS_IMETHOD GetCaretDOMSelection(nsISelection **aDOMSel) = 0;
00078   NS_IMETHOD SetCaretDOMSelection(nsISelection *aDOMSel) = 0;
00079 
00083   NS_IMETHOD SetCaretVisible(PRBool inMakeVisible) = 0;
00084 
00088   NS_IMETHOD GetCaretVisible(PRBool *outMakeVisible) = 0;
00089 
00094   NS_IMETHOD SetCaretReadOnly(PRBool inMakeReadonly) = 0;
00095 
00103   NS_IMETHOD GetCaretCoordinates(EViewCoordinates aRelativeToType, nsISelection *aDOMSel, nsRect *outCoordinates, PRBool *outIsCollapsed, nsIView **outView) = 0;
00104 
00108   NS_IMETHOD EraseCaret() = 0;
00109 
00110   NS_IMETHOD SetVisibilityDuringSelection(PRBool aVisibilityDuringSelection) = 0;
00111   
00119   NS_IMETHOD DrawAtPosition(nsIDOMNode* aNode, PRInt32 aOffset) = 0;
00120 
00125   NS_IMETHOD GetCaretFrameForNodeOffset (nsIContent* aContentNode, PRInt32 aOffset, nsIFrameSelection::HINT aFrameHint, PRUint8 aBidiLevel,
00126                                          nsIFrame** aReturnFrame, PRInt32* aReturnOffset) = 0;
00127     
00128 };
00129 
00130 nsresult
00131 NS_NewCaret(nsICaret** aInstancePtrResult);
00132 
00133 
00134 // handy stack-based class for temporarily disabling the caret
00135 
00136 class StCaretHider
00137 {
00138 public:
00139                StCaretHider(nsICaret* aSelCon)
00140                : mWasVisible(PR_FALSE), mCaret(aSelCon)
00141                {
00142                  if (mCaret)
00143                  {
00144                    mCaret->GetCaretVisible(&mWasVisible);
00145                    if (mWasVisible)
00146                      mCaret->SetCaretVisible(PR_FALSE);
00147                  }
00148                }
00149                
00150                ~StCaretHider()
00151                {
00152                  if (mCaret && mWasVisible)
00153                    mCaret->SetCaretVisible(PR_TRUE);
00154                  // nsCOMPtr releases mPresShell
00155                }
00156 
00157 protected:
00158 
00159     PRBool                  mWasVisible;
00160     nsCOMPtr<nsICaret>  mCaret;
00161 };
00162 
00163 
00164 #endif  // nsICaret_h__
00165