Rogue Wave Views Annotated Text Package API Reference Guide |
Rogue Wave Views Documentation Home |
Annotated text gadget class. More...
#include <ilviews/annotext/cursor.h>
Public Member Functions | |
IlBoolean | isVisible () const |
Indicates the insertion cursor visibility. More... | |
void | setVisible (IlBoolean visible) |
Sets the insertion cursor visibility. More... | |
Public Member Functions inherited from IlvATCursor | |
IlvATCursor (const IlvAnnoText *atext) | |
Constructor. More... | |
virtual void | extract () |
Disconnects the cursor from the annotated text object. More... | |
IlvATZone * | getZone () const |
Returns the text zone containing the cursor. More... | |
virtual IlBoolean | isAtWordBoundary () const |
Indicates whether the cursor is located between two words. More... | |
IlBoolean | isConnected () const |
Indicates whether the cursor is connected to an annotated text object. More... | |
void | moveBackward (IlBoolean jumpcursor=IlTrue, IlBoolean visible=IlTrue) |
Move the cursor one step backward. More... | |
void | moveEndLine () |
Moves the cursor at the end of the current line. More... | |
void | moveEndParagraph (IlBoolean visible=IlTrue) |
Moves the cursor at the end of the current paragraph. More... | |
void | moveEndText () |
Moves the cursor at the beginning of the text. More... | |
void | moveEndZone (IlvATZone *zone, IlvPosition pos=IlvLeft) |
Moves the cursor at the end of the specified text zone. More... | |
void | moveForward (IlBoolean jumpcursor=IlTrue, IlBoolean visible=IlTrue) |
Move the cursor one step forward. More... | |
void | moveNextWord (IlBoolean visible=IlTrue) |
Moves the cursor to the next word boundary. More... | |
void | movePreviousWord (IlBoolean visible=IlTrue) |
Moves the cursor to the previous word boundary. More... | |
void | moveStartLine () |
Moves the cursor at the beginning of the current line. More... | |
void | moveStartParagraph (IlBoolean visible=IlTrue) |
Moves the cursor at the beginning of the current paragraph. More... | |
void | moveStartText () |
Moves the cursor at the beginning of the text. More... | |
void | moveStartZone (IlvATZone *zone, IlvPosition pos=IlvRight) |
Moves the cursor at the beginning of the specified zone. More... | |
virtual void | moveTo (IlvATCursor *cursor, IlvPosition side=IlvLeft) |
Moves the cursor next to a given cursor. More... | |
virtual IlBoolean | moveTo (const IlvPoint &point, const IlvTransformer *t=0) |
Moves the cursor to a given location. More... | |
IlBoolean | startsParagraph () const |
Indicates whether the cursor is located at the beginning of a paragraph. More... | |
Annotated text gadget class.
Library: ilvatext
This class is used by the text to represent an insertion mark. An instance of this class is automatically created when an IlvAnnoText
instance is created.The IlvAnnoText
class has a member function to retrieve the insertion cursor associated with it.
IlvAnnoText
, IlvATInteractor
, IlvATPalette
, IlvATZone
. IlBoolean IlvATInsertionCursor::isVisible | ( | ) | const |
Indicates the insertion cursor visibility.
IlTrue
if the IlvATInsertionCursor
is displayed (if its position is on the screen). Otherwise, it returns IlFalse
. void IlvATInsertionCursor::setVisible | ( | IlBoolean | visible | ) |
Sets the insertion cursor visibility.
visible | Specifies whether the insertion cursor must be displayed. |
© Copyright 2016, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.