X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/87fbe614866ed932f1eefa1abaf1b39ef1427309..c50a4038e3c3a13e3d493c432017d371d4916ce6:/include/wx/caret.h diff --git a/include/wx/caret.h b/include/wx/caret.h index 5a2926285a..16caa514d8 100644 --- a/include/wx/caret.h +++ b/include/wx/caret.h @@ -5,14 +5,18 @@ // 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_ -#ifdef __GNUG__ +#include "wx/defs.h" + +#if wxUSE_CARET + +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) #pragma interface "caret.h" #endif @@ -96,7 +100,11 @@ public: 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; } + void SetSize(int width, int height) { + m_width = width; + m_height = height; + DoSize(); + } void SetSize(const wxSize& size) { SetSize(size.x, size.y); } @@ -110,7 +118,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 - virtual void Show(bool show = TRUE) + virtual void Show(bool show = true) { if ( show ) { @@ -123,7 +131,7 @@ public: 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 @@ -148,13 +156,14 @@ protected: m_width = width; m_height = height; - return TRUE; + return true; } // pure virtuals to implement in the derived class virtual void DoShow() = 0; virtual void DoHide() = 0; virtual void DoMove() = 0; + virtual void DoSize() { } // the common initialization void Init() @@ -178,7 +187,7 @@ protected: int m_countVisible; private: - DECLARE_NO_COPY_CLASS(wxCaretBase); + DECLARE_NO_COPY_CLASS(wxCaretBase) }; // --------------------------------------------------------------------------- @@ -191,5 +200,40 @@ private: #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_