Wrappers for *ToText

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

diff --git a/include/wx/caret.h b/include/wx/caret.h
index bdc4279c56031c6f9b4db4d7def85be84fb5e930..0967690a1b986ee0a21ae3c603c08cc037be4d70 100644 (file)
--- a/include/wx/caret.h
+++ b/include/wx/caret.h
@@ -5,13 +5,21 @@
 // Modified by:
 // Created:     23.05.99
 // RCS-ID:      $Id$
-// Copyright:   (c) wxWindows team
+// Copyright:   (c) wxWidgets team
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_CARET_H_BASE_
 #define _WX_CARET_H_BASE_
 
+#include "wx/defs.h"
+
+#if wxUSE_CARET
+
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
+#pragma interface "caret.h"
+#endif
+
 // ---------------------------------------------------------------------------
 // forward declarations
 // ---------------------------------------------------------------------------
@@ -91,6 +99,15 @@ public:
         // get the window we're associated with
     wxWindow *GetWindow() const { return (wxWindow *)m_window; }
 
+        // change the size of the caret
+    void SetSize(int width, int height) {
+        m_width = width;
+        m_height = height;
+        DoSize();
+    }
+    void SetSize(const wxSize& size) { SetSize(size.x, size.y); }
+
+
     // operations
     // ----------
 
@@ -146,6 +163,7 @@ protected:
     virtual void DoShow() = 0;
     virtual void DoHide() = 0;
     virtual void DoMove() = 0;
+    virtual void DoSize() { }
 
     // the common initialization
     void Init()
@@ -169,7 +187,7 @@ protected:
     int m_countVisible;
 
 private:
-    DECLARE_NO_COPY_CLASS(wxCaretBase);
+    DECLARE_NO_COPY_CLASS(wxCaretBase)
 };
 
 // ---------------------------------------------------------------------------
@@ -178,11 +196,44 @@ private:
 
 #if defined(__WXMSW__)
     #include "wx/msw/caret.h"
-#elif  defined(__WXPM__)
-    #include "wx/os2/caret.h"
 #else
     #include "wx/generic/caret.h"
 #endif // platform
 
+// ----------------------------------------------------------------------------
+// wxCaretSuspend: a simple class which hides the caret in its ctor and
+// restores it in the dtor, this should be used when drawing on the screen to
+// avoid overdrawing the caret
+// ----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxCaretSuspend
+{
+public:
+    wxCaretSuspend(wxWindow *win)
+    {
+        m_caret = win->GetCaret();
+        m_show = FALSE;        
+        if ( m_caret && m_caret->IsVisible() )
+        {
+            m_caret->Hide();
+            m_show = TRUE;
+        }
+    }
+
+    ~wxCaretSuspend()
+    {
+        if ( m_caret && m_show )
+            m_caret->Show();
+    }
+
+private:
+    wxCaret *m_caret;
+    bool     m_show;
+
+    DECLARE_NO_COPY_CLASS(wxCaretSuspend)
+};
+
+#endif // wxUSE_CARET
+
 #endif // _WX_CARET_H_BASE_