Back to index

lightning-sunbird  0.9+nobinonly
Public Types | Public Member Functions
nsICaret Class Reference

#include <nsICaret.h>

Inheritance diagram for nsICaret:
Inheritance graph
[legend]
Collaboration diagram for nsICaret:
Collaboration graph
[legend]

List of all members.

Public Types

enum  EViewCoordinates { eTopLevelWindowCoordinates, eRenderingViewCoordinates, eClosestViewCoordinates, eIMECoordinates }

Public Member Functions

NS_IMETHOD Init (nsIPresShell *inPresShell)=0
NS_IMETHOD Terminate ()=0
NS_IMETHOD GetCaretDOMSelection (nsISelection **aDOMSel)=0
NS_IMETHOD SetCaretDOMSelection (nsISelection *aDOMSel)=0
NS_IMETHOD SetCaretVisible (PRBool inMakeVisible)=0
 SetCaretVisible will set the visibility of the caret.
NS_IMETHOD GetCaretVisible (PRBool *outMakeVisible)=0
 GetCaretVisible will get the visibility of the caret.
NS_IMETHOD SetCaretReadOnly (PRBool inMakeReadonly)=0
 SetCaretReadOnly set the appearance of the caret.
NS_IMETHOD GetCaretCoordinates (EViewCoordinates aRelativeToType, nsISelection *aDOMSel, nsRect *outCoordinates, PRBool *outIsCollapsed, nsIView **outView)=0
 GetCaretCoordinates Get the position of the caret in coordinates relative to the typed specified (aRelativeToType).
NS_IMETHOD EraseCaret ()=0
 Erase Caret this will erase the caret if its drawn and reset drawn status.
NS_IMETHOD SetVisibilityDuringSelection (PRBool aVisibilityDuringSelection)=0
NS_IMETHOD DrawAtPosition (nsIDOMNode *aNode, PRInt32 aOffset)=0
 DrawAtPosition.
NS_IMETHOD GetCaretFrameForNodeOffset (nsIContent *aContentNode, PRInt32 aOffset, nsIFrameSelection::HINT aFrameHint, PRUint8 aBidiLevel, nsIFrame **aReturnFrame, PRInt32 *aReturnOffset)=0
 GetCaretFrameForNodeOffset Get the frame and content offset at which the caret is drawn, invoking the bidi caret positioning algorithm if necessary.

Detailed Description

Definition at line 62 of file nsICaret.h.


Member Enumeration Documentation

Enumerator:
eTopLevelWindowCoordinates 
eRenderingViewCoordinates 
eClosestViewCoordinates 
eIMECoordinates 

Definition at line 67 of file nsICaret.h.


Member Function Documentation

NS_IMETHOD nsICaret::DrawAtPosition ( nsIDOMNode aNode,
PRInt32  aOffset 
) [pure virtual]

DrawAtPosition.

Draw the caret explicitly, at the specified node and offset. To avoid drawing glitches, you should call EraseCaret() after each call to DrawAtPosition().

Implemented in nsCaret.

NS_IMETHOD nsICaret::EraseCaret ( ) [pure virtual]

Erase Caret this will erase the caret if its drawn and reset drawn status.

Implemented in nsCaret.

NS_IMETHOD nsICaret::GetCaretCoordinates ( EViewCoordinates  aRelativeToType,
nsISelection aDOMSel,
nsRect outCoordinates,
PRBool outIsCollapsed,
nsIView **  outView 
) [pure virtual]

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.

Implemented in nsCaret.

NS_IMETHOD nsICaret::GetCaretDOMSelection ( nsISelection **  aDOMSel) [pure virtual]

Implemented in nsCaret.

NS_IMETHOD nsICaret::GetCaretFrameForNodeOffset ( nsIContent aContentNode,
PRInt32  aOffset,
nsIFrameSelection::HINT  aFrameHint,
PRUint8  aBidiLevel,
nsIFrame **  aReturnFrame,
PRInt32 aReturnOffset 
) [pure virtual]

GetCaretFrameForNodeOffset Get the frame and content offset at which the caret is drawn, invoking the bidi caret positioning algorithm if necessary.

Implemented in nsCaret.

NS_IMETHOD nsICaret::GetCaretVisible ( PRBool outMakeVisible) [pure virtual]

GetCaretVisible will get the visibility of the caret.

Parameters:
inMakeVisiblePR_TRUE it is shown, PR_FALSE it is hidden

Implemented in nsCaret.

NS_IMETHOD nsICaret::Init ( nsIPresShell inPresShell) [pure virtual]

Implemented in nsCaret.

Implemented in nsCaret.

NS_IMETHOD nsICaret::SetCaretReadOnly ( PRBool  inMakeReadonly) [pure virtual]

SetCaretReadOnly set the appearance of the caret.

Parameters:
inMakeReadonlyPR_TRUE to show the caret in a 'read only' state, PR_FALSE to show the caret in normal, editing state

Implemented in nsCaret.

NS_IMETHOD nsICaret::SetCaretVisible ( PRBool  inMakeVisible) [pure virtual]

SetCaretVisible will set the visibility of the caret.

Parameters:
inMakeVisiblePR_TRUE to show the caret, PR_FALSE to hide it

Implemented in nsCaret.

NS_IMETHOD nsICaret::SetVisibilityDuringSelection ( PRBool  aVisibilityDuringSelection) [pure virtual]

Implemented in nsCaret.

NS_IMETHOD nsICaret::Terminate ( ) [pure virtual]

Implemented in nsCaret.


The documentation for this class was generated from the following file: