Added wxTreeCtrl::GetItemParent to deprecate GetParent.

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

diff --git a/include/wx/caret.h b/include/wx/caret.h
index 6a314bc94eee0cea858356e5da69087f2acca727..d1dba597613cc89830eb2ddcc426f96ddefd1e64 100644 (file)
--- a/include/wx/caret.h
+++ b/include/wx/caret.h
@@ -12,6 +12,14 @@
 #ifndef _WX_CARET_H_BASE_
 #define _WX_CARET_H_BASE_
 
+#include "wx/defs.h"
+
+#if wxUSE_CARET
+
+#if defined(__GNUG__) && !defined(__APPLE__)
+#pragma interface "caret.h"
+#endif
+
 // ---------------------------------------------------------------------------
 // forward declarations
 // ---------------------------------------------------------------------------
@@ -19,10 +27,16 @@
 class WXDLLEXPORT wxWindow;
 class WXDLLEXPORT wxWindowBase;
 
-// ---------------------------------------------------------------------------
+// ----------------------------------------------------------------------------
+// headers we have to include
+// ----------------------------------------------------------------------------
+
+#include "wx/gdicmn.h"  // for wxPoint, wxSize
+
+// ----------------------------------------------------------------------------
 // A caret is a blinking cursor showing the position where the typed text will
 // appear. It can be either a solid block or a custom bitmap (TODO)
-// ---------------------------------------------------------------------------
+// ----------------------------------------------------------------------------
 
 class WXDLLEXPORT wxCaretBase
 {
@@ -63,6 +77,9 @@ public:
         // is the caret valid?
     bool IsOk() const { return m_width != 0 && m_height != 0; }
 
+        // is the caret currently shown?
+    bool IsVisible() const { return m_countVisible > 0; }
+
         // get the caret position
     void GetPosition(int *x, int *y) const
     {
@@ -82,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
     // ----------
 
@@ -96,12 +122,12 @@ public:
         {
             if ( show )
             {
-                if ( ++m_countVisible > 0 )
+                if ( m_countVisible++ == 0 )
                     DoShow();
             }
             else
             {
-                if ( --m_countVisible < 1 )
+                if ( --m_countVisible == 0 )
                     DoHide();
             }
         }
@@ -137,6 +163,7 @@ protected:
     virtual void DoShow() = 0;
     virtual void DoHide() = 0;
     virtual void DoMove() = 0;
+    virtual void DoSize() { }
 
     // the common initialization
     void Init()
@@ -160,19 +187,46 @@ protected:
     int m_countVisible;
 
 private:
-    DECLARE_NO_COPY_CLASS(wxCaretBase);
+    DECLARE_NO_COPY_CLASS(wxCaretBase)
 };
 
 // ---------------------------------------------------------------------------
 // now include the real thing
 // ---------------------------------------------------------------------------
 
-#ifdef __WXMSW__
+#if defined(__WXMSW__)
     #include "wx/msw/caret.h"
 #else
-    // not implemented yet
-    typedef wxCaretBase wxCaret;
+    #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();
+        if ( m_caret )
+            m_caret->Hide();
+    }
+
+    ~wxCaretSuspend()
+    {
+        if ( m_caret )
+            m_caret->Show();
+    }
+
+private:
+    wxCaret *m_caret;
+};
+
+#endif // wxUSE_CARET
+
 #endif // _WX_CARET_H_BASE_