]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/caret.h
revision contributed by Utensil Candel
[wxWidgets.git] / interface / caret.h
index 2a12a4f258d80c3deda29f7654d2ffa79f11e90a..3b386e6e9a3032193b579ff7f4184301e90e0464 100644 (file)
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        caret.h
-// Purpose:     documentation for wxCaret class
+// Purpose:     interface of wxCaret
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -24,8 +24,7 @@
     @library{wxcore}
     @category{misc}
 
-    @seealso
-    wxCaret::GetBlinkTime
+    @see wxCaret::GetBlinkTime
 */
 class wxCaret
 {
@@ -59,49 +58,41 @@ public:
     //@{
     /**
         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).
@@ -111,14 +102,14 @@ public:
     /**
         Returns @true if the caret was created successfully.
     */
-#define bool IsOk()     /* implementation is private */
+    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;
 
     //@{
     /**
@@ -130,12 +121,12 @@ public:
 
     /**
         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.
-        
-        @sa GetBlinkTime()
+                 carets permanently (until the next time it is called),
+                 even for the carets in other applications.
+
+        @see GetBlinkTime()
     */
     static void SetBlinkTime(int milliseconds);
 
@@ -151,5 +142,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);
+    void Show(bool show = true);
 };
+