]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/mutexlck.tex
AddPendingEvent() is not virtual
[wxWidgets.git] / docs / latex / wx / mutexlck.tex
1 \section{\class{wxMutexLocker}}\label{wxmutexlocker}
2
3 This is a small helper class to be used with \helpref{wxMutex}{wxmutex}
4 objects. A wxMutexLocker acquires a mutex lock in the constructor and releases
5 (or unlocks) the mutex in the destructor making it much more difficult to
6 forget to release a mutex (which, in general, will promptly lead to the serious
7 problems). See \helpref{wxMutex}{wxmutex} for an example of wxMutexLocker
8 usage.
9
10 \wxheading{Derived from}
11
12 None.
13
14 \wxheading{Include files}
15
16 <wx/thread.h>
17
18 \wxheading{See also}
19
20 \helpref{wxMutex}{wxmutex}, \helpref{wxCriticalSectionLocker}{wxcriticalsectionlocker}
21
22 \latexignore{\rtfignore{\wxheading{Members}}}
23
24 \membersection{wxMutexLocker::wxMutexLocker}\label{wxmutexlockerctor}
25
26 \func{}{wxMutexLocker}{\param{wxMutex\&}{ mutex}}
27
28 Constructs a wxMutexLocker object associated with mutex and locks it.
29 Call \helpref{IsLocked}{wxmutexlockerisok} to check if the mutex was
30 successfully locked.
31
32 \membersection{wxMutexLocker::\destruct{wxMutexLocker}}\label{wxmutexlockerdtor}
33
34 \func{}{\destruct{wxMutexLocker}}{\void}
35
36 Destructor releases the mutex if it was successfully acquired in the ctor.
37
38 \membersection{wxMutexLocker::IsOk}\label{wxmutexlockerisok}
39
40 \constfunc{bool}{IsOk}{\void}
41
42 Returns true if mutex was acquired in the constructor, false otherwise.
43