A caret is a blinking cursor showing the position where the typed text will
appear. The text controls usually have a caret but Caret class also allows
to use a caret in other windows.
Currently, the caret appears as a rectangle of the given size. In the future,
it will be possible to specify a bitmap to be used for the caret shape.
A caret is always associated with a window and the current caret can be
retrieved using Window#get_caret. The same caret
can’t be reused in two different windows.
No base class
Create the caret of given (in pixels) width and height and associates it
with the given window.
Create the caret of given (in pixels) width and height and associates it
with the given window (same as constructor).
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).
Get the caret position (in pixels).
Get the caret size.
Get the window the caret is associated with.
Same as Caret::Show.
Returns true if the caret was created successfully.
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 method still returns true).
Move the caret to given position (in logical coordinates).
Sets the blink time for all the carets.
Under Windows, this function will change the blink time for all carets
permanently (until the next time it is called), even for the carets in other
applications.
Changes the size of the caret.
Shows or hides the caret. Notice that if the caret was hidden $N$ times, it
must be shown $N$ times as well to reappear on the screen.
[This page automatically generated from the Textile source at 2023-06-09 00:45:33 +0000]