wxJavaScript

back to gui 

wxCaret

^{generated from ../src/mod_gui/misc/caret.cpp}

A caret is a blinking cursor showing the position where the typed text will appear. The text controls usually have a caret but wxCaret class also allows to use a caret in other windows.

Constants

Class Properties

Name	Type	Description
blinkTime	Integer	The blink time which is measured in milliseconds and is the time elapsed between 2 inversions of the caret.

Constructor

wxCaret

wxCaret()
 

wxCaret(Window, 
        Width, 
        Height)
 

Name	Type	Default	Description
Window	wxWindow
Width	Integer
Height	Integer

wxCaret(Window, 
        Size)
 

Name	Type	Default	Description
Window	wxWindow
Size	wxSize

Constructs a new wxCaret object.

Properties

Name	Type	Description
ok	Boolean	Returns true if the caret was created successfully.
position	wxPoint	The caret position in pixels
size	wxSize	Get/Set the caret size
visible	Boolean	Returns true if the caret is visible and false if it is permanently hidden (if it is is blinking and not shown currently but will be after the next blink, this property still returns true).
window	wxWindow	Get the window the caret is associated with.

Methods

create

create()
 

create(Window, 
       Width, 
       Height)
 

Name	Type	Default	Description
Window	wxWindow
Width	Integer
Height	Integer

create(Window, 
       Size)
 

Name	Type	Default	Description
Window	wxWindow
Size	wxSize

Constructs a new wxCaret object.

hide

hide()
 

move

move(Point)
 

Name	Type	Default	Description
Point	wxPoint

Move the caret to given position.

show

show(Sw = true)
 

Name	Type	Default	Description
Sw	Boolean	true

Show/hide the caret