зеркало из https://github.com/mozilla/gecko-dev.git
247 строки
9.4 KiB
C++
247 строки
9.4 KiB
C++
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* vim: set ts=2 sw=2 et tw=78: */
|
|
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
/* the caret is the text cursor used, e.g., when editing */
|
|
|
|
#ifndef nsCaret_h__
|
|
#define nsCaret_h__
|
|
|
|
#include "mozilla/MemoryReporting.h"
|
|
#include "nsCoord.h"
|
|
#include "nsISelectionListener.h"
|
|
#include "nsIWeakReferenceUtils.h"
|
|
#include "CaretAssociationHint.h"
|
|
#include "nsPoint.h"
|
|
#include "nsRect.h"
|
|
|
|
class nsDisplayListBuilder;
|
|
class nsFrameSelection;
|
|
class nsIContent;
|
|
class nsIDOMNode;
|
|
class nsIFrame;
|
|
class nsINode;
|
|
class nsIPresShell;
|
|
class nsITimer;
|
|
class nsRenderingContext;
|
|
|
|
namespace mozilla {
|
|
namespace dom {
|
|
class Selection;
|
|
}
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
class nsCaret : public nsISelectionListener
|
|
{
|
|
public:
|
|
nsCaret();
|
|
|
|
protected:
|
|
virtual ~nsCaret();
|
|
|
|
public:
|
|
NS_DECL_ISUPPORTS
|
|
|
|
typedef mozilla::CaretAssociationHint CaretAssociationHint;
|
|
|
|
nsresult Init(nsIPresShell *inPresShell);
|
|
void Terminate();
|
|
|
|
void SetSelection(nsISelection *aDOMSel);
|
|
nsISelection* GetSelection();
|
|
|
|
/**
|
|
* Sets whether the caret should only be visible in nodes that are not
|
|
* user-modify: read-only, or whether it should be visible in all nodes.
|
|
*
|
|
* @param aIgnoreUserModify true to have the cursor visible in all nodes,
|
|
* false to have it visible in all nodes except
|
|
* those with user-modify: read-only
|
|
*/
|
|
void SetIgnoreUserModify(bool aIgnoreUserModify);
|
|
void CheckCaretDrawingState();
|
|
/** SetCaretVisible will set the visibility of the caret
|
|
* @param inMakeVisible true to show the caret, false to hide it
|
|
*/
|
|
void SetCaretVisible(bool intMakeVisible);
|
|
/** GetCaretVisible will get the visibility of the caret.
|
|
* This returns false if the caret is hidden for any reason (other than
|
|
* blinking off).
|
|
* @param outMakeVisible true if it is shown, false if it is hidden
|
|
* @return NS_OK
|
|
*/
|
|
nsresult GetCaretVisible(bool *outMakeVisible);
|
|
/** SetCaretReadOnly set the appearance of the caret
|
|
* @param inMakeReadonly true to show the caret in a 'read only' state,
|
|
* false to show the caret in normal, editing state
|
|
*/
|
|
void SetCaretReadOnly(bool inMakeReadonly);
|
|
/**
|
|
* @param aVisibility true if the caret should be visible even when the
|
|
* selection is not collapsed.
|
|
*/
|
|
void SetVisibilityDuringSelection(bool aVisibility);
|
|
|
|
/** EraseCaret
|
|
* this will erase the caret if its drawn and reset drawn status
|
|
*/
|
|
void EraseCaret();
|
|
/** UpdateCaretPosition
|
|
* Update the caret's current frame and rect, but don't draw yet. This is
|
|
* useful for flickerless moving of the caret (e.g., when the frame the
|
|
* caret is in reflows and is moved).
|
|
*/
|
|
void UpdateCaretPosition();
|
|
/** DrawAtPosition
|
|
*
|
|
* Draw the caret explicitly, at the specified node and offset.
|
|
* To avoid drawing glitches, you should call EraseCaret()
|
|
* after each call to DrawAtPosition().
|
|
*
|
|
* Note: This call breaks the caret's ability to blink at all.
|
|
**/
|
|
nsresult DrawAtPosition(nsIDOMNode* aNode, int32_t aOffset);
|
|
|
|
/**
|
|
* Returns a frame to paint in, and the bounds of the painted caret
|
|
* relative to that frame.
|
|
* The rectangle includes bidi decorations.
|
|
* Returns null if the caret should not be drawn (including if it's blinked
|
|
* off).
|
|
*/
|
|
nsIFrame* GetPaintGeometry(nsRect* aRect);
|
|
/**
|
|
* A simple wrapper around GetGeometry. Does not take any caret state into
|
|
* account other than the current selection.
|
|
*/
|
|
nsIFrame* GetGeometry(nsRect* aRect)
|
|
{
|
|
return GetGeometry(GetSelection(), aRect);
|
|
}
|
|
|
|
/** PaintCaret
|
|
* Actually paint the caret onto the given rendering context.
|
|
*/
|
|
void PaintCaret(nsDisplayListBuilder *aBuilder,
|
|
nsRenderingContext *aCtx,
|
|
nsIFrame *aForFrame,
|
|
const nsPoint &aOffset);
|
|
|
|
//nsISelectionListener interface
|
|
NS_DECL_NSISELECTIONLISTENER
|
|
|
|
/**
|
|
* Gets the position and size of the caret that would be drawn for
|
|
* the focus node/offset of aSelection (assuming it would be drawn,
|
|
* i.e., disregarding blink status). The geometry is stored in aRect,
|
|
* and we return the frame aRect is relative to.
|
|
* Only looks at the focus node of aSelection, so you can call it even if
|
|
* aSelection is not collapsed.
|
|
* This rect does not include any extra decorations for bidi.
|
|
* @param aRect must be non-null
|
|
*/
|
|
static nsIFrame* GetGeometry(nsISelection* aSelection,
|
|
nsRect* aRect);
|
|
static nsresult GetCaretFrameForNodeOffset(nsFrameSelection* aFrameSelection,
|
|
nsIContent* aContentNode,
|
|
int32_t aOffset,
|
|
CaretAssociationHint aFrameHint,
|
|
uint8_t aBidiLevel,
|
|
nsIFrame** aReturnFrame,
|
|
int32_t* aReturnOffset);
|
|
|
|
size_t SizeOfIncludingThis(mozilla::MallocSizeOf aMallocSizeOf) const;
|
|
|
|
protected:
|
|
static void CaretBlinkCallback(nsITimer *aTimer, void *aClosure);
|
|
|
|
// Schedule a repaint for the frame where the caret would appear.
|
|
// Does not check visibility etc.
|
|
void SchedulePaint();
|
|
void CheckSelectionLanguageChange();
|
|
|
|
void KillTimer();
|
|
nsresult PrimeTimer();
|
|
|
|
void StartBlinking();
|
|
void StopBlinking();
|
|
|
|
bool DrawAtPositionWithHint(nsIDOMNode* aNode,
|
|
int32_t aOffset,
|
|
CaretAssociationHint aFrameHint,
|
|
uint8_t aBidiLevel,
|
|
bool aInvalidate);
|
|
|
|
mozilla::dom::Selection* GetSelectionInternal();
|
|
|
|
struct Metrics {
|
|
nscoord mBidiIndicatorSize; // width and height of bidi indicator
|
|
nscoord mCaretWidth; // full caret width including bidi indicator
|
|
};
|
|
static Metrics ComputeMetrics(nsIFrame* aFrame, int32_t aOffset,
|
|
nscoord aCaretHeight);
|
|
static nsresult GetGeometryForFrame(nsIFrame* aFrame,
|
|
int32_t aFrameOffset,
|
|
nsRect* aRect,
|
|
nscoord* aBidiIndicatorSize);
|
|
|
|
// Returns true if the caret should be drawn. When |mDrawn| is true,
|
|
// this returns true, so that we erase the drawn caret. If |aIgnoreDrawnState|
|
|
// is true, we don't take into account whether the caret is currently
|
|
// drawn or not. This can be used to determine if the caret is drawn when
|
|
// it shouldn't be.
|
|
bool MustDrawCaret(bool aIgnoreDrawnState);
|
|
|
|
void DrawCaret(bool aInvalidate);
|
|
void DrawCaretAfterBriefDelay();
|
|
void ComputeCaretRects(nsIFrame* aFrame, int32_t aFrameOffset,
|
|
nsRect* aCaretRect, nsRect* aHookRect);
|
|
void ToggleDrawnStatus() { mDrawn = !mDrawn; }
|
|
|
|
nsFrameSelection* GetFrameSelection();
|
|
|
|
// Returns true if we should not draw the caret because of XUL menu popups.
|
|
// The caret should be hidden if:
|
|
// 1. An open popup contains the caret, but a menu popup exists before the
|
|
// caret-owning popup in the popup list (i.e. a menu is in front of the
|
|
// popup with the caret). If the menu itself contains the caret we don't
|
|
// hide it.
|
|
// 2. A menu popup is open, but there is no caret present in any popup.
|
|
// 3. The caret selection is empty.
|
|
bool IsMenuPopupHidingCaret();
|
|
|
|
nsWeakPtr mPresShell;
|
|
nsWeakPtr mDomSelectionWeak;
|
|
|
|
nsCOMPtr<nsITimer> mBlinkTimer;
|
|
|
|
bool mIsBlinking;
|
|
|
|
bool mVisible; // is the caret blinking
|
|
|
|
bool mDrawn; // Denotes when the caret is physically drawn on the screen.
|
|
bool mPendingDraw; // True when the last on-state draw was suppressed.
|
|
|
|
bool mReadOnly; // it the caret in readonly state (draws differently)
|
|
bool mShowDuringSelection; // show when text is selected
|
|
|
|
bool mIgnoreUserModify;
|
|
|
|
uint8_t mLastBidiLevel; // saved bidi level of the last draw request, to use when we erase
|
|
|
|
nsCOMPtr<nsIContent> mLastContent; // store the content the caret was last requested to be drawn
|
|
// in (by DrawAtPosition()/DrawCaret()),
|
|
// note that this can be different than where it was
|
|
// actually drawn (anon <BR> in text control)
|
|
int32_t mLastContentOffset; // the offset for the last request
|
|
|
|
CaretAssociationHint mLastHint; // the hint associated with the last request, see also
|
|
// mLastBidiLevel below
|
|
|
|
};
|
|
|
|
#endif //nsCaret_h__
|