File: wupdlock.h

package info (click to toggle)
wxpython4.0 4.2.3%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 221,752 kB
  • sloc: cpp: 962,555; python: 230,573; ansic: 170,731; makefile: 51,756; sh: 9,342; perl: 1,564; javascript: 584; php: 326; xml: 200
file content (53 lines) | stat: -rw-r--r-- 1,577 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
///////////////////////////////////////////////////////////////////////////////
// Name:        wx/wupdlock.h
// Purpose:     wxWindowUpdateLocker prevents window redrawing
// Author:      Vadim Zeitlin
// Created:     2006-03-06
// Copyright:   (c) 2006 Vadim Zeitlin <vadim@wxwidgets.org>
// Licence:     wxWindows licence
///////////////////////////////////////////////////////////////////////////////

#ifndef _WX_WUPDLOCK_H_
#define _WX_WUPDLOCK_H_

#include "wx/window.h"

// ----------------------------------------------------------------------------
// wxWindowUpdateLocker prevents updates to the window during its lifetime
// ----------------------------------------------------------------------------

class wxWindowUpdateLocker
{
public:
    // Prefer using the ctor below if possible, this ctor is only useful if
    // Lock() must be called only conditionally.
    wxWindowUpdateLocker() : m_win(NULL) { }

    // create an object preventing updates of the given window (which must have
    // a lifetime at least as great as ours)
    explicit wxWindowUpdateLocker(wxWindow *win) : m_win(win) { win->Freeze(); }

    // May be called only for the object constructed using the default ctor.
    void Lock(wxWindow *win)
    {
        wxASSERT( !m_win );

        m_win = win;
        win->Freeze();
    }

    // dtor thaws the window to permit updates again
    ~wxWindowUpdateLocker()
    {
        if ( m_win )
            m_win->Thaw();
    }

private:
    wxWindow *m_win;

    wxDECLARE_NO_COPY_CLASS(wxWindowUpdateLocker);
};

#endif // _WX_WUPDLOCK_H_