projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| 499b2ed8 JS |
1 | % |
| 2 | % automatically generated by HelpGen $Revision$ from | |
| 4cbc57f0 | 3 | % antiflickpl.h at 21/Jan/02 21:14:17 |
| 499b2ed8 JS |
4 | % |
| 5 | ||
| 6 | ||
| 7 | \section{\class{cbAntiflickerPlugin}}\label{cbantiflickerplugin} | |
| 8 | ||
| 4cbc57f0 JS |
9 | |
| 10 | Implements double-buffering to reduce flicker. | |
| 11 | Bitmap and memory DC buffers are shared 'resources' among all instances of | |
| 12 | antiflicker plugins within the application. | |
| 13 | ||
| 14 | Locking for multithreaded applications is not yet implemented. | |
| 15 | ||
| 499b2ed8 JS |
16 | \wxheading{Derived from} |
| 17 | ||
| 18 | \helpref{cbPluginBase}{cbpluginbase} | |
| 19 | ||
| 4cbc57f0 JS |
20 | \wxheading{Include files} |
| 21 | ||
| 22 | <antiflickpl.h> | |
| 23 | ||
| 499b2ed8 JS |
24 | \wxheading{Data structures} |
| 25 | ||
| 26 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 27 | ||
| 28 | ||
| 29 | \membersection{cbAntiflickerPlugin::cbAntiflickerPlugin}\label{cbantiflickerplugincbantiflickerplugin} | |
| 30 | ||
| 31 | \func{}{cbAntiflickerPlugin}{\void} | |
| 32 | ||
| 4cbc57f0 JS |
33 | Default constructor. |
| 34 | ||
| 499b2ed8 JS |
35 | |
| 36 | \func{}{cbAntiflickerPlugin}{\param{wxFrameLayout* }{pPanel}, \param{int }{paneMask = wxALL\_PANES}} | |
| 37 | ||
| 4cbc57f0 JS |
38 | Constructor taking frame layout panel, and pane mask. |
| 39 | ||
| 499b2ed8 JS |
40 | |
| 41 | \membersection{cbAntiflickerPlugin::\destruct{cbAntiflickerPlugin}}\label{cbantiflickerplugindtor} | |
| 42 | ||
| 43 | \func{}{\destruct{cbAntiflickerPlugin}}{\void} | |
| 44 | ||
| 4cbc57f0 JS |
45 | Destructor. |
| 46 | ||
| 499b2ed8 JS |
47 | |
| 48 | \membersection{cbAntiflickerPlugin::AllocNewBuffer}\label{cbantiflickerpluginallocnewbuffer} | |
| 49 | ||
| 50 | \func{wxDC*}{AllocNewBuffer}{\param{const wxRect\& }{forArea}} | |
| 51 | ||
| 4cbc57f0 JS |
52 | Allocates a suitable buffer. |
| 53 | ||
| 499b2ed8 JS |
54 | |
| 55 | \membersection{cbAntiflickerPlugin::FindSuitableBuffer}\label{cbantiflickerpluginfindsuitablebuffer} | |
| 56 | ||
| 57 | \func{wxDC*}{FindSuitableBuffer}{\param{const wxRect\& }{forArea}} | |
| 58 | ||
| 4cbc57f0 | 59 | Finds a suitable buffer. Returns NULL if a suitable buffer is not present. |
| 499b2ed8 JS |
60 | |
| 61 | ||
| 62 | \membersection{cbAntiflickerPlugin::GetClientDC}\label{cbantiflickerplugingetclientdc} | |
| 63 | ||
| 64 | \func{wxDC\&}{GetClientDC}{\void} | |
| 65 | ||
| 4cbc57f0 JS |
66 | Gets the client device context. |
| 67 | ||
| 499b2ed8 JS |
68 | |
| 69 | \membersection{cbAntiflickerPlugin::GetWindowDC}\label{cbantiflickerplugingetwindowdc} | |
| 70 | ||
| 71 | \func{wxDC\&}{GetWindowDC}{\void} | |
| 72 | ||
| 4cbc57f0 JS |
73 | Gets the window device context. |
| 74 | ||
| 499b2ed8 JS |
75 | |
| 76 | \membersection{cbAntiflickerPlugin::OnFinishDrawInArea}\label{cbantiflickerpluginonfinishdrawinarea} | |
| 77 | ||
| 78 | \func{void}{OnFinishDrawInArea}{\param{cbFinishDrawInAreaEvent\& }{event}} | |
| 79 | ||
| 4cbc57f0 JS |
80 | Handler for plugin event. |
| 81 | ||
| 499b2ed8 JS |
82 | |
| 83 | \membersection{cbAntiflickerPlugin::OnStartDrawInArea}\label{cbantiflickerpluginonstartdrawinarea} | |
| 84 | ||
| 85 | \func{void}{OnStartDrawInArea}{\param{cbStartDrawInAreaEvent\& }{event}} | |
| 86 | ||
| 4cbc57f0 | 87 | Handler for plugin event. |
| 499b2ed8 | 88 |