]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wx/caret.h
support for iPhone callbacks
[wxWidgets.git] / interface / wx / caret.h
index b5d870635e7c97247ea0002da34c6fd2a3018af6..a9d4211b14ddb4aabfdc77d1b26aabfa988ddf73 100644 (file)
@@ -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,6 +60,13 @@ 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;
     wxPoint GetPosition() const;
@@ -68,6 +75,13 @@ public:
     //@{
     /**
         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;
@@ -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;