gecko-dev/layout/base/nsICaret.h
shanjian%netscape.com 819a855d2b #59405 IME candidate window position is not correct in text field on New card and To field
r = sfraser sr=kin a=blizzard
Handle the difference of cursor coordinate required by different platform.
nsICaret.h
nsCaret.cpp
nsEditor.cpp
nsPlaintextEditor.cpp
nsHTMLEditor.cpp
2001-04-19 22:46:29 +00:00

133 lines
4.0 KiB
C++

/* -*- 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):
*/
#ifndef nsICaret_h__
#define nsICaret_h__
#include "nsISupports.h"
#include "nsCOMPtr.h"
#include "nsIPresShell.h"
class nsIRenderingContext;
class nsIFrame;
class nsIView;
struct nsRect;
struct nsPoint;
// IID for the nsICaret interface
#define NS_ICARET_IID \
{ 0xa6cf90e1, 0x15b3, 0x11d2, {0x93, 0x2e, 0x00, 0x80, 0x5f, 0x8a, 0xdd, 0x32} }
class nsICaret: public nsISupports
{
public:
static const nsIID& GetIID() { static nsIID iid = NS_ICARET_IID; return iid; }
typedef enum EViewCoordinates {
eTopLevelWindowCoordinates,
eRenderingViewCoordinates,
eClosestViewCoordinates,
eIMECoordinates
} EViewCoordinates;
NS_IMETHOD Init(nsIPresShell *inPresShell) = 0;
NS_IMETHOD SetCaretDOMSelection(nsISelection *aDOMSel) = 0;
/** SetCaretVisible will set the visibility of the caret
* @param inMakeVisible PR_TRUE to show the caret, PR_FALSE to hide it
*/
NS_IMETHOD SetCaretVisible(PRBool inMakeVisible) = 0;
/** GetCaretVisible will get the visibility of the caret
* @param inMakeVisible PR_TRUE it is shown, PR_FALSE it is hidden
*/
NS_IMETHOD GetCaretVisible(PRBool *outMakeVisible) = 0;
/** SetCaretReadOnly set the appearance of the caret
* @param inMakeReadonly PR_TRUE to show the caret in a 'read only' state,
* PR_FALSE to show the caret in normal, editing state
*/
NS_IMETHOD SetCaretReadOnly(PRBool inMakeReadonly) = 0;
/** GetCaretCoordinates
* Get the position of the caret in coordinates relative to the typed specified (aRelativeToType).
* If the selection is collapsed, this returns the caret location
* and true in outIsCollapsed.
* If the selection is not collapsed, this returns the location of the focus pos,
* and false in outIsCollapsed.
*/
NS_IMETHOD GetCaretCoordinates(EViewCoordinates aRelativeToType, nsISelection *aDOMSel, nsRect *outCoordinates, PRBool *outIsCollapsed) = 0;
/** ClearFrameRefs
* The caret stores a reference to the frame that the caret was last drawn in.
* This is called to tell the caret that that frame is going away.
*/
NS_IMETHOD ClearFrameRefs(nsIFrame* aFrame) = 0;
/** Erase Caret
* this will erase the caret if its drawn and reset drawn status
*/
NS_IMETHOD EraseCaret() = 0;
/** Set Caret Width
* this will set the caret width to the passed in value.
*/
NS_IMETHOD SetCaretWidth(nscoord aPixels) = 0;
};
extern nsresult NS_NewCaret(nsICaret** aInstancePtrResult);
// handy stack-based class for temporarily disabling the caret
class StCaretHider
{
public:
StCaretHider(nsICaret* aSelCon)
: mWasVisible(PR_FALSE), mCaret(aSelCon)
{
if (mCaret)
{
mCaret->GetCaretVisible(&mWasVisible);
if (mWasVisible)
mCaret->SetCaretVisible(PR_FALSE);
}
}
~StCaretHider()
{
if (mCaret && mWasVisible)
mCaret->SetCaretVisible(PR_TRUE);
// nsCOMPtr releases mPresShell
}
protected:
PRBool mWasVisible;
nsCOMPtr<nsICaret> mCaret;
};
#endif // nsICaret_h__