Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/caret.h b/include/wx/caret.h
index 16caa514d81e9146183013a8bf5ec5e857be43f5..1c28b6df2c67cbd02608b206494fb2906484aaff 100644 (file)
--- a/include/wx/caret.h
+++ b/include/wx/caret.h
@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

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

 // Purpose:     wxCaretBase class - the interface of wxCaret
 // Author:      Vadim Zeitlin
 // Modified by:
 // Purpose:     wxCaretBase class - the interface of wxCaret
 // Author:      Vadim Zeitlin
 // Modified by:


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

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#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
     // --------------------------------------------------------------
 


@@ -148,7 +147,7 @@ public:
     virtual void OnKillFocus() { }
 
 protected:
     virtual void OnKillFocus() { }
 
 protected:

-    // these functions may be overriden in the derived classes, but they
+    // these functions may be overridden in the derived classes, but they

     // should call the base class version first
     virtual bool DoCreate(wxWindowBase *window, int width, int height)
     {
     // should call the base class version first
     virtual bool DoCreate(wxWindowBase *window, int width, int height)
     {


@@ -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;


@@ -187,7 +186,7 @@ protected:
     int m_countVisible;
 
 private:
     int m_countVisible;
 
 private:

-    DECLARE_NO_COPY_CLASS(wxCaretBase)
+    wxDECLARE_NO_COPY_CLASS(wxCaretBase);

 };
 
 // ---------------------------------------------------------------------------
 };
 
 // ---------------------------------------------------------------------------


@@ -206,7 +205,20 @@ 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)) {}
+
+    wxDECLARE_NO_COPY_CLASS(wxCaretSuspend);
+};
+
+#else // !wxHAS_CARET_USING_OVERLAYS
+
+class WXDLLIMPEXP_CORE wxCaretSuspend

 {
 public:
     wxCaretSuspend(wxWindow *win)
 {
 public:
     wxCaretSuspend(wxWindow *win)


@@ -230,10 +242,11 @@ private:
     wxCaret *m_caret;
     bool     m_show;
 
     wxCaret *m_caret;
     bool     m_show;
 

-    DECLARE_NO_COPY_CLASS(wxCaretSuspend)
+    wxDECLARE_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_

-