]>
Commit | Line | Data |
---|---|---|
1 | % | |
2 | % automatically generated by HelpGen $Revision$ from | |
3 | % toolwnd.h at 21/Jan/02 21:14:17 | |
4 | % | |
5 | ||
6 | ||
7 | \section{\class{cbMiniButton}}\label{cbminibutton} | |
8 | ||
9 | ||
10 | cbMiniButton is the base class for a small button that can be placed in a wxToolWindow | |
11 | titlebar. | |
12 | ||
13 | \wxheading{Derived from} | |
14 | ||
15 | \helpref{wxObject}{wxobject} | |
16 | ||
17 | \wxheading{Include files} | |
18 | ||
19 | <toolwnd.h> | |
20 | ||
21 | \wxheading{Data structures} | |
22 | ||
23 | \latexignore{\rtfignore{\wxheading{Members}}} | |
24 | ||
25 | ||
26 | \membersection{cbMiniButton::cbMiniButton}\label{cbminibuttoncbminibutton} | |
27 | ||
28 | \func{}{cbMiniButton}{\void} | |
29 | ||
30 | Default constructor. | |
31 | ||
32 | ||
33 | \membersection{cbMiniButton::Draw}\label{cbminibuttondraw} | |
34 | ||
35 | \func{void}{Draw}{\param{wxDC\& }{dc}} | |
36 | ||
37 | Draws the button. Override this to implement | |
38 | the desired appearance. | |
39 | ||
40 | ||
41 | \membersection{cbMiniButton::Enable}\label{cbminibuttonenable} | |
42 | ||
43 | \func{void}{Enable}{\param{bool }{enable}} | |
44 | ||
45 | Enable or disable the button. | |
46 | ||
47 | ||
48 | \membersection{cbMiniButton::HitTest}\label{cbminibuttonhittest} | |
49 | ||
50 | \func{bool}{HitTest}{\param{const wxPoint\& }{pos}} | |
51 | ||
52 | Returns TRUE if the given position was over the button. | |
53 | ||
54 | ||
55 | \membersection{cbMiniButton::IsPressed}\label{cbminibuttonispressed} | |
56 | ||
57 | \func{bool}{IsPressed}{\void} | |
58 | ||
59 | Returns TRUE if this button is pressed. | |
60 | ||
61 | ||
62 | \membersection{cbMiniButton::OnLeftDown}\label{cbminibuttononleftdown} | |
63 | ||
64 | \func{void}{OnLeftDown}{\param{const wxPoint\& }{pos}} | |
65 | ||
66 | Responds to a left down event. | |
67 | ||
68 | ||
69 | \membersection{cbMiniButton::OnLeftUp}\label{cbminibuttononleftup} | |
70 | ||
71 | \func{void}{OnLeftUp}{\param{const wxPoint\& }{pos}} | |
72 | ||
73 | Responds to a left up event. | |
74 | ||
75 | ||
76 | \membersection{cbMiniButton::OnMotion}\label{cbminibuttononmotion} | |
77 | ||
78 | \func{void}{OnMotion}{\param{const wxPoint\& }{pos}} | |
79 | ||
80 | Responds to a mouse move event. | |
81 | ||
82 | ||
83 | \membersection{cbMiniButton::Refresh}\label{cbminibuttonrefresh} | |
84 | ||
85 | \func{void}{Refresh}{\void} | |
86 | ||
87 | Refreshes the button. | |
88 | ||
89 | ||
90 | \membersection{cbMiniButton::Reset}\label{cbminibuttonreset} | |
91 | ||
92 | \func{void}{Reset}{\void} | |
93 | ||
94 | Reset the button. | |
95 | ||
96 | ||
97 | \membersection{cbMiniButton::SetPos}\label{cbminibuttonsetpos} | |
98 | ||
99 | \func{void}{SetPos}{\param{const wxPoint\& }{pos}} | |
100 | ||
101 | Set the position of the button. | |
102 | ||
103 | ||
104 | \membersection{cbMiniButton::WasClicked}\label{cbminibuttonwasclicked} | |
105 | ||
106 | \func{bool}{WasClicked}{\void} | |
107 | ||
108 | Returns TRUE if the button was clicked. | |
109 |