Applied patch #15286: documentation and col/rowspan demo by dghart

[wxWidgets.git] / interface / wx / caret.h

diff --git a/interface/wx/caret.h b/interface/wx/caret.h
index c967ee764a19775820df962fbd9a6a5f839697a9..a9d4211b14ddb4aabfdc77d1b26aabfa988ddf73 100644 (file)
--- 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;
     //@}
 
     /**
@@ -81,7 +95,7 @@ public:
     /**
         Hides the caret, same as Show(@false).
     */
-    void Hide();
+    virtual void Hide();
 
     /**
         Returns @true if the caret was created successfully.
@@ -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;
@@ -126,6 +140,6 @@ public:
         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.
     */
-    void Show(bool show = true);
+    virtual void Show(bool show = true);
 };