pjs/layout/base/nsICaret.h

112 строки
3.4 KiB
C
Исходник Обычный вид История

1999-02-12 02:49:08 +03:00
/* -*- 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/
1999-02-12 02:49:08 +03:00
*
* 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.
1999-02-12 02:49:08 +03:00
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is Netscape
1999-02-12 02:49:08 +03:00
* Communications Corporation. Portions created by Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All
* Rights Reserved.
*
* Contributor(s):
1999-02-12 02:49:08 +03:00
*/
1999-09-18 03:12:17 +04:00
#ifndef nsICaret_h__
#define nsICaret_h__
#include "nsISupports.h"
1999-09-15 03:41:19 +04:00
#include "nsCOMPtr.h"
#include "nsIPresShell.h"
1999-02-12 02:49:08 +03:00
1999-09-18 03:12:17 +04:00
class nsIRenderingContext;
class nsIFrame;
class nsIView;
struct nsRect;
struct nsPoint;
1999-02-12 02:49:08 +03:00
// 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:
1999-03-03 22:48:57 +03:00
static const nsIID& GetIID() { static nsIID iid = NS_ICARET_IID; return iid; }
1999-02-12 02:49:08 +03:00
1999-07-15 02:18:29 +04:00
NS_IMETHOD Init(nsIPresShell *inPresShell) = 0;
1999-02-12 02:49:08 +03:00
/** 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;
/** 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;
/** GetWindowRelativeCoordinates
* Get the position of the caret in (top-level) window coordinates.
* 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 GetWindowRelativeCoordinates(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;
1999-02-12 02:49:08 +03:00
};
extern nsresult NS_NewCaret(nsICaret** aInstancePtrResult);
1999-09-15 03:41:19 +04:00
// handy stack-based class for temporarily disabling the caret
class StCaretHider
{
public:
2000-04-27 11:37:12 +04:00
StCaretHider(nsISelectionController* aSelCon)
: mWasVisible(PR_FALSE), mSelCon(nsnull)
1999-09-15 03:41:19 +04:00
{
2000-04-27 11:37:12 +04:00
mSelCon = aSelCon; // addrefs
if (mSelCon)
1999-09-15 03:41:19 +04:00
{
2000-04-27 11:37:12 +04:00
mSelCon->GetCaretEnabled(&mWasVisible);
1999-09-15 03:41:19 +04:00
if (mWasVisible)
2000-04-27 11:37:12 +04:00
mSelCon->SetCaretEnabled(PR_FALSE);
1999-09-15 03:41:19 +04:00
}
}
~StCaretHider()
{
2000-04-27 11:37:12 +04:00
if (mSelCon && mWasVisible)
mSelCon->SetCaretEnabled(PR_TRUE);
1999-09-15 03:41:19 +04:00
// nsCOMPtr releases mPresShell
}
protected:
PRBool mWasVisible;
2000-04-27 11:37:12 +04:00
nsCOMPtr<nsISelectionController> mSelCon;
1999-09-15 03:41:19 +04:00
};
1999-09-18 03:12:17 +04:00
#endif // nsICaret_h__