document various enumerations defined in defs.h; give a name to the anonymous enum...

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

diff --git a/include/wx/caret.h b/include/wx/caret.h
index d1dba597613cc89830eb2ddcc426f96ddefd1e64..b89796ff88062fbd26b0a8f7ab821bf5db276f0e 100644 (file)
--- a/include/wx/caret.h
+++ b/include/wx/caret.h
@@ -1,11 +1,11 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        caret.h
+// Name:        wx/caret.h

 // Purpose:     wxCaretBase class - the interface of wxCaret
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     23.05.99
 // RCS-ID:      $Id$
 // Purpose:     wxCaretBase class - the interface of wxCaret
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     23.05.99
 // RCS-ID:      $Id$

-// Copyright:   (c) wxWindows team
+// Copyright:   (c) wxWidgets team

 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 


@@ -16,16 +16,12 @@
 
 #if wxUSE_CARET
 
 
 #if wxUSE_CARET
 

-#if defined(__GNUG__) && !defined(__APPLE__)
-#pragma interface "caret.h"
-#endif
-

 // ---------------------------------------------------------------------------
 // forward declarations
 // ---------------------------------------------------------------------------
 
 // ---------------------------------------------------------------------------
 // forward declarations
 // ---------------------------------------------------------------------------
 

-class WXDLLEXPORT wxWindow;
-class WXDLLEXPORT wxWindowBase;
+class WXDLLIMPEXP_FWD_CORE wxWindow;
+class WXDLLIMPEXP_FWD_CORE wxWindowBase;

 
 // ----------------------------------------------------------------------------
 // headers we have to include
 
 // ----------------------------------------------------------------------------
 // headers we have to include


@@ -38,7 +34,7 @@ class WXDLLEXPORT wxWindowBase;
 // appear. It can be either a solid block or a custom bitmap (TODO)
 // ----------------------------------------------------------------------------
 
 // appear. It can be either a solid block or a custom bitmap (TODO)
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxCaretBase
+class WXDLLIMPEXP_CORE wxCaretBase

 {
 public:
     // ctors
 {
 public:
     // ctors


@@ -61,6 +57,9 @@ public:
         (void)Create(window, size);
     }
 
         (void)Create(window, size);
     }
 

+    // a virtual dtor has been provided since this class has virtual members
+    virtual ~wxCaretBase() { }
+

     // Create() functions - same as ctor but returns the success code
     // --------------------------------------------------------------
 
     // Create() functions - same as ctor but returns the success code
     // --------------------------------------------------------------
 


@@ -118,7 +117,7 @@ public:
         // show/hide the caret (should be called by wxWindow when needed):
         // Show() must be called as many times as Hide() + 1 to make the caret
         // visible
         // show/hide the caret (should be called by wxWindow when needed):
         // Show() must be called as many times as Hide() + 1 to make the caret
         // visible

-    virtual void Show(bool show = TRUE)
+    virtual void Show(bool show = true)

         {
             if ( show )
             {
         {
             if ( show )
             {


@@ -131,7 +130,7 @@ public:
                     DoHide();
             }
         }
                     DoHide();
             }
         }

-    virtual void Hide() { Show(FALSE); }
+    virtual void Hide() { Show(false); }

 
         // blink time is measured in milliseconds and is the time elapsed
         // between 2 inversions of the caret (blink time of the caret is common
 
         // blink time is measured in milliseconds and is the time elapsed
         // between 2 inversions of the caret (blink time of the caret is common


@@ -156,7 +155,7 @@ protected:
         m_width = width;
         m_height = height;
 
         m_width = width;
         m_height = height;
 

-        return TRUE;
+        return true;

     }
 
     // pure virtuals to implement in the derived class
     }
 
     // pure virtuals to implement in the derived class


@@ -168,7 +167,7 @@ protected:
     // the common initialization
     void Init()
     {
     // the common initialization
     void Init()
     {

-        m_window = (wxWindowBase *)NULL;
+        m_window = NULL;

         m_x = m_y = 0;
         m_width = m_height = 0;
         m_countVisible = 0;
         m_x = m_y = 0;
         m_width = m_height = 0;
         m_countVisible = 0;


@@ -206,27 +205,48 @@ private:
 // avoid overdrawing the caret
 // ----------------------------------------------------------------------------
 
 // avoid overdrawing the caret
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxCaretSuspend
+#ifdef wxHAS_CARET_USING_OVERLAYS
+
+// we don't need to hide the caret if it's rendered using overlays
+class WXDLLIMPEXP_CORE wxCaretSuspend
+{
+public:
+    wxCaretSuspend(wxWindow *WXUNUSED(win)) {}
+
+    DECLARE_NO_COPY_CLASS(wxCaretSuspend)
+};
+
+#else // !wxHAS_CARET_USING_OVERLAYS
+
+class WXDLLIMPEXP_CORE wxCaretSuspend

 {
 public:
     wxCaretSuspend(wxWindow *win)
     {
         m_caret = win->GetCaret();
 {
 public:
     wxCaretSuspend(wxWindow *win)
     {
         m_caret = win->GetCaret();

-        if ( m_caret )
+        m_show = false;
+        if ( m_caret && m_caret->IsVisible() )
+        {

             m_caret->Hide();
             m_caret->Hide();

+            m_show = true;
+        }

     }
 
     ~wxCaretSuspend()
     {
     }
 
     ~wxCaretSuspend()
     {

-        if ( m_caret )
+        if ( m_caret && m_show )

             m_caret->Show();
     }
 
 private:
     wxCaret *m_caret;
             m_caret->Show();
     }
 
 private:
     wxCaret *m_caret;

+    bool     m_show;
+
+    DECLARE_NO_COPY_CLASS(wxCaretSuspend)

 };
 
 };
 

+#endif // wxHAS_CARET_USING_OVERLAYS/!wxHAS_CARET_USING_OVERLAYS
+

 #endif // wxUSE_CARET
 
 #endif // _WX_CARET_H_BASE_
 #endif // wxUSE_CARET
 
 #endif // _WX_CARET_H_BASE_

-