projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| 499b2ed8 JS |
1 | % |
| 2 | % automatically generated by HelpGen $Revision$ from | |
| 4cbc57f0 | 3 | % controlbar.h at 21/Jan/02 21:14:13 |
| 499b2ed8 JS |
4 | % |
| 5 | ||
| 6 | ||
| 7 | \section{\class{cbBarDimHandlerBase}}\label{cbbardimhandlerbase} | |
| 8 | ||
| 9 | ||
| 10 | Abstract interface for bar-size handler classes. | |
| 4cbc57f0 JS |
11 | These objects receive notifications whenever the docking |
| 12 | state of the bar is changed, thus they provide the possibility | |
| 13 | to adjust the values in cbDimInfo::mSizes accordingly. | |
| 14 | Specific handlers can be hooked up to specific types of bar. | |
| 15 | ||
| 499b2ed8 JS |
16 | \wxheading{Derived from} |
| 17 | ||
| 18 | \helpref{wxObject}{wxobject} | |
| 19 | ||
| 4cbc57f0 JS |
20 | \wxheading{Include files} |
| 21 | ||
| 6e8515a3 | 22 | <wx/fl/controlbar.h> |
| 4cbc57f0 | 23 | |
| 499b2ed8 JS |
24 | \wxheading{Data structures} |
| 25 | ||
| 26 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 27 | ||
| 28 | ||
| 29 | \membersection{cbBarDimHandlerBase::cbBarDimHandlerBase}\label{cbbardimhandlerbasecbbardimhandlerbase} | |
| 30 | ||
| 31 | \func{}{cbBarDimHandlerBase}{\void} | |
| 32 | ||
| 33 | to multiple bars, it's instance is | |
| 34 | reference-counted | |
| 4cbc57f0 JS |
35 | Default constructor. The initial reference count is 0, since |
| 36 | the handler is not used until the first invocation of AddRef(). | |
| 499b2ed8 JS |
37 | |
| 38 | ||
| 39 | \membersection{cbBarDimHandlerBase::AddRef}\label{cbbardimhandlerbaseaddref} | |
| 40 | ||
| 41 | \func{void}{AddRef}{\void} | |
| 42 | ||
| 4cbc57f0 JS |
43 | Increments the reference count. |
| 44 | ||
| 499b2ed8 JS |
45 | |
| 46 | \membersection{cbBarDimHandlerBase::OnChangeBarState}\label{cbbardimhandlerbaseonchangebarstate} | |
| 47 | ||
| 48 | \func{void}{OnChangeBarState}{\param{cbBarInfo* }{pBar}, \param{int }{newState}} | |
| 49 | ||
| 4cbc57f0 | 50 | Responds to "bar-state-changes" notifications. |
| 499b2ed8 JS |
51 | |
| 52 | ||
| 53 | \membersection{cbBarDimHandlerBase::OnResizeBar}\label{cbbardimhandlerbaseonresizebar} | |
| 54 | ||
| 55 | \func{void}{OnResizeBar}{\param{cbBarInfo* }{pBar}, \param{const wxSize\& }{given}, \param{wxSize\& }{preferred}} | |
| 56 | ||
| 4cbc57f0 JS |
57 | Responds to bar resize notifications. |
| 58 | ||
| 499b2ed8 JS |
59 | |
| 60 | \membersection{cbBarDimHandlerBase::RemoveRef}\label{cbbardimhandlerbaseremoveref} | |
| 61 | ||
| 62 | \func{void}{RemoveRef}{\void} | |
| 63 | ||
| 4cbc57f0 JS |
64 | Decrements the reference count, and if the count is at zero, |
| 65 | delete 'this'. | |
| 66 |