/////////////////////////////////////////////////////////////////////////////
// Name: caret.h
-// Purpose: documentation for wxCaret class
+// Purpose: interface of wxCaret
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@library{wxcore}
@category{misc}
- @seealso
- wxCaret::GetBlinkTime
+ @see wxCaret::GetBlinkTime
*/
class wxCaret
{
//@{
/**
Get the caret position (in pixels).
-
+
@b GetPosition()
-
+
Returns a Wx::Point
-
+
@b GetPositionXY()
-
+
Returns a 2-element list
@c ( x, y )
*/
- void GetPosition(int* x, int* y);
- wxPoint GetPosition();
+ void GetPosition(int* x, int* y) const;
+ const wxPoint GetPosition() const;
//@}
//@{
/**
Get the caret size.
-
+
@b GetSize()
-
+
Returns a Wx::Size
-
+
@b GetSizeWH()
-
+
Returns a 2-element list
@c ( width, height )
*/
- void GetSize(int* width, int* height);
- wxSize GetSize();
+ void GetSize(int* width, int* height) const;
+ const wxSize GetSize() const;
//@}
/**
Get the window the caret is associated with.
*/
- wxWindow* GetWindow();
+ wxWindow* GetWindow() const;
/**
Same as wxCaret::Show(@false).
/**
Returns @true if the caret was created successfully.
*/
- bool IsOk();
+ bool IsOk() const;
/**
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).
*/
- bool IsVisible();
+ bool IsVisible() const;
//@{
/**
/**
Sets the blink time for all the carets.
-
+
@remarks 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.
-
+
@see GetBlinkTime()
*/
static void SetBlinkTime(int milliseconds);
*/
void Show(bool show = true);
};
+