// Name: caret.h
// Purpose: interface of wxCaret
// Author: wxWidgets team
-// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
the @a window.
*/
wxCaret(wxWindow* window, int width, int height);
- wxCaret(wxWindowBase* window, const wxSize& size);
+ wxCaret(wxWindow* window, const wxSize& size);
//@}
//@{
Creates a caret with the given size (in pixels) and associates it with
the @a window (same as the equivalent constructors).
*/
- bool Create(wxWindowBase* window, int width, int height);
- bool Create(wxWindowBase* window, const wxSize& size);
+ bool Create(wxWindow* window, int width, int height);
+ bool Create(wxWindow* window, const wxSize& size);
//@}
/**
//@{
/**
Get the caret position (in pixels).
+
+ @beginWxPerlOnly
+ In wxPerl there are two methods instead of a single overloaded
+ method:
+ - GetPosition(): returns a Wx::Point object.
+ - GetPositionXY(): returns a 2-element list (x, y).
+ @endWxPerlOnly
*/
void GetPosition(int* x, int* y) const;
wxPoint GetPosition() const;
//@{
/**
Get the caret size.
+
+ @beginWxPerlOnly
+ In wxPerl there are two methods instead of a single overloaded
+ method:
+ - GetSize(): returns a Wx::Size object.
+ - GetSizeWH(): returns a 2-element list (width, height).
+ @endWxPerlOnly
*/
void GetSize(int* width, int* height) const;
wxSize GetSize() 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
+ hidden (if it is blinking and not shown currently but will be after
the next blink, this method still returns @true).
*/
bool IsVisible() const;