// 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__
-#pragma interface "caret.h"
-#endif
+#include "wx/defs.h"
+
+#if wxUSE_CARET
// ---------------------------------------------------------------------------
// forward declarations
(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
// --------------------------------------------------------------
// 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
// ----------
// 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 )
{
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
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()
int m_countVisible;
private:
- DECLARE_NO_COPY_CLASS(wxCaretBase);
+ DECLARE_NO_COPY_CLASS(wxCaretBase)
};
// ---------------------------------------------------------------------------
#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_