wxCaret

Methods

• wxCaret
  Default constructor.
• GetPosition
  Get the caret position (in pixels).
• GetSize
  Get the caret size.
• GetWindow
  Get the window the caret is associated with.
• Hide
  Hides the caret, same as Show(false).
• IsOk
  Returns true if the caret was created successfully.
• IsVisible
  Returns true if the caret is visible and false if it is permanently hidden (if it is blinking and not shown currently but will be after the next blink, this method still returns true).
• Move
  Move the caret to given position (in logical coordinates).
• SetSize
  Changes the size of the caret.
• Show
  Shows or hides the caret.

Static Methods

• GetBlinkTime
  Returns the blink time which is measured in milliseconds and is the time elapsed between 2 inversions of the caret (blink time of the caret is the same for all carets, so this functions is static).
• SetBlinkTime
  Sets the blink time for all the carets.

wxCaret

wxCaret ( )

Default constructor.
wxCaret ( wxWindow &$window, integer $width, integer $height )

Creates a caret with the given size (in pixels) and associates it with the window.

GetBlinkTime

static integer GetBlinkTime ( )

Returns the blink time which is measured in milliseconds and is the time elapsed between 2 inversions of the caret (blink time of the caret is the same for all carets, so this functions is static).

GetPosition

wxPoint GetPosition ( )

Get the caret position (in pixels).
GetPosition ( integer &$x, integer &$y )

Get the caret position (in pixels).

GetSize

wxSize GetSize ( )

Get the caret size.
GetSize ( integer &$width, integer &$height )

Get the caret size.

GetWindow

wxWindow& GetWindow ( )

Get the window the caret is associated with.

Hide

Hide ( )

Hides the caret, same as Show(false).

IsOk

bool IsOk ( )

Returns true if the caret was created successfully.

IsVisible

bool IsVisible ( )

Returns true if the caret is visible and false if it is permanently hidden (if it is blinking and not shown currently but will be after the next blink, this method still returns true).

Move

Move ( wxPoint $pt )

Move the caret to given position (in logical coordinates).
Move ( integer $x, integer $y )

Move the caret to given position (in logical coordinates).

SetBlinkTime

static SetBlinkTime ( integer $milliseconds )

Sets the blink time for all the carets.

SetSize

SetSize ( wxSize $size )

Changes the size of the caret.
SetSize ( integer $width, integer $height )

Changes the size of the caret.

Show

Show ( bool $show=true )

Shows or hides the caret.