revision contributed by Utensil Candel

[wxWidgets.git] / interface / caret.h

diff --git a/interface/caret.h b/interface/caret.h
index dd642a6ba283000cf23382d4da52fff67ddd46d6..3b386e6e9a3032193b579ff7f4184301e90e0464 100644 (file)
--- a/interface/caret.h
+++ b/interface/caret.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        caret.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        caret.h

-// Purpose:     documentation for wxCaret class
+// Purpose:     interface of wxCaret

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -9,25 +9,24 @@
 /**
     @class wxCaret
     @wxheader{caret.h}
 /**
     @class wxCaret
     @wxheader{caret.h}

-    
+

     A caret is a blinking cursor showing the position where the typed text will
     appear. The text controls usually have a caret but wxCaret class also allows
     to use a caret in other windows.
     A caret is a blinking cursor showing the position where the typed text will
     appear. The text controls usually have a caret but wxCaret class also allows
     to use a caret in other windows.

-    
+

     Currently, the caret appears as a rectangle of the given size. In the future,
     it will be possible to specify a bitmap to be used for the caret shape.
     Currently, the caret appears as a rectangle of the given size. In the future,
     it will be possible to specify a bitmap to be used for the caret shape.

-    
+

     A caret is always associated with a window and the current caret can be
     retrieved using wxWindow::GetCaret. The same caret
     can't be reused in two different windows.
     A caret is always associated with a window and the current caret can be
     retrieved using wxWindow::GetCaret. The same caret
     can't be reused in two different windows.

-    
+

     @library{wxcore}
     @category{misc}
     @library{wxcore}
     @category{misc}

-    
-    @seealso
-    wxCaret::GetBlinkTime
+
+    @see wxCaret::GetBlinkTime

 */
 */

-class wxCaret 
+class wxCaret

 {
 public:
     //@{
 {
 public:
     //@{


@@ -36,8 +35,8 @@ public:
         with the given window.
     */
     wxCaret();
         with the given window.
     */
     wxCaret();

-        wxCaret(wxWindow* window, int width, int height);
-        wxCaret(wxWindowBase* window, const wxSize& size);
+    wxCaret(wxWindow* window, int width, int height);
+    wxCaret(wxWindowBase* window, const wxSize& size);

     //@}
 
     //@{
     //@}
 
     //@{


@@ -46,7 +45,7 @@ public:
         with the given window (same as constructor).
     */
     bool Create(wxWindowBase* window, int width, int height);
         with the given window (same as constructor).
     */
     bool Create(wxWindowBase* window, int width, int height);

-        bool Create(wxWindowBase* window, const wxSize& size);
+    bool Create(wxWindowBase* window, const wxSize& size);

     //@}
 
     /**
     //@}
 
     /**


@@ -59,49 +58,41 @@ public:
     //@{
     /**
         Get the caret position (in pixels).
     //@{
     /**
         Get the caret position (in pixels).

-        
-        
-        
+

         @b GetPosition()
         @b GetPosition()

-        
-        
+

         Returns a Wx::Point
         Returns a Wx::Point

-        
+

         @b GetPositionXY()
         @b GetPositionXY()

-        
-        
+

         Returns a 2-element list
          @c ( x, y )
     */
         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.
     //@}
 
     //@{
     /**
         Get the caret size.

-        
-        
-        
+

         @b GetSize()
         @b GetSize()

-        
-        
+

         Returns a Wx::Size
         Returns a Wx::Size

-        
+

         @b GetSizeWH()
         @b GetSizeWH()

-        
-        
+

         Returns a 2-element list
          @c ( width, height )
     */
         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.
     */
     //@}
 
     /**
         Get the window the caret is associated with.
     */

-    wxWindow* GetWindow();
+    wxWindow* GetWindow() const;

 
     /**
         Same as wxCaret::Show(@false).
 
     /**
         Same as wxCaret::Show(@false).


@@ -111,31 +102,31 @@ public:
     /**
         Returns @true if the caret was created successfully.
     */
     /**
         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).
     */
 
     /**
         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;

 
     //@{
     /**
         Move the caret to given position (in logical coordinates).
     */
     void Move(int x, int y);
 
     //@{
     /**
         Move the caret to given position (in logical coordinates).
     */
     void Move(int x, int y);

-        void Move(const wxPoint& pt);
+    void Move(const wxPoint& pt);

     //@}
 
     /**
         Sets the blink time for all the carets.
     //@}
 
     /**
         Sets the blink time for all the carets.

-        
+

         @remarks Under Windows, this function will change the blink time for all
         @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);
 
     */
     static void SetBlinkTime(int milliseconds);
 


@@ -144,12 +135,13 @@ public:
         Changes the size of the caret.
     */
     void SetSize(int width, int height);
         Changes the size of the caret.
     */
     void SetSize(int width, int height);

-        void SetSize(const wxSize& size);
+    void SetSize(const wxSize& size);

     //@}
 
     /**
         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.
     */
     //@}
 
     /**
         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);

 };
 };

+