X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9d9c1c24d7d1a68da02a7fbb4b4c7459139a1df6..d3fa4bc22e84e3ca4d88cc1772f2d414140a1017:/interface/wx/caret.h?ds=sidebyside diff --git a/interface/wx/caret.h b/interface/wx/caret.h index 637e305c94..a9d4211b14 100644 --- a/interface/wx/caret.h +++ b/interface/wx/caret.h @@ -3,7 +3,7 @@ // Purpose: interface of wxCaret // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @@ -38,7 +38,7 @@ public: the @a window. */ wxCaret(wxWindow* window, int width, int height); - wxCaret(wxWindowBase* window, const wxSize& size); + wxCaret(wxWindow* window, const wxSize& size); //@} //@{ @@ -46,8 +46,8 @@ public: 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); //@} /** @@ -60,17 +60,31 @@ public: //@{ /** 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; - const wxPoint GetPosition() 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; - const wxSize GetSize() const; + wxSize GetSize() const; //@} /** @@ -90,7 +104,7 @@ public: /** 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;