]> git.saurik.com Git - wxWidgets.git/blame_incremental - contrib/docs/latex/fl/dynamictoolbar.tex
removed enum that was causing more problems than it was worth
[wxWidgets.git] / contrib / docs / latex / fl / dynamictoolbar.tex
... / ...
CommitLineData
1%
2% automatically generated by HelpGen $Revision$ from
3% dyntbar.h at 21/Jan/02 21:14:18
4%
5
6
7\section{\class{wxDynamicToolBar}}\label{wxdynamictoolbar}
8
9
10wxDynamicToolBar manages containment and layout of tool windows.
11
12\wxheading{Derived from}
13
14\helpref{wxToolBarBase}{wxtoolbarbase}
15
16\wxheading{Include files}
17
18<wx/fl/dyntbar.h>
19
20\wxheading{Data structures}
21
22\latexignore{\rtfignore{\wxheading{Members}}}
23
24
25\membersection{wxDynamicToolBar::wxDynamicToolBar}\label{wxdynamictoolbarwxdynamictoolbar}
26
27\func{}{wxDynamicToolBar}{\void}
28
29Default constructor.
30
31
32\func{}{wxDynamicToolBar}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{const long }{style = wxNO\_BORDER}, \param{const int }{orientation = wxVERTICAL}, \param{const int }{RowsOrColumns = 1}, \param{const wxString\& }{name = wxToolBarNameStr}}
33
34Constructor: see the documentation for wxToolBar for details.
35
36
37\membersection{wxDynamicToolBar::\destruct{wxDynamicToolBar}}\label{wxdynamictoolbardtor}
38
39\func{}{\destruct{wxDynamicToolBar}}{\void}
40
41Destructor.
42
43
44\membersection{wxDynamicToolBar::AddSeparator}\label{wxdynamictoolbaraddseparator}
45
46\func{void}{AddSeparator}{\param{wxWindow* }{pSepartorWnd = NULL}}
47
48Adds a separator. See the documentation for wxToolBar for details.
49
50
51\membersection{wxDynamicToolBar::AddTool}\label{wxdynamictoolbaraddtool}
52
53\func{void}{AddTool}{\param{int }{toolIndex}, \param{wxWindow* }{pToolWindow}, \param{const wxSize\& }{size = wxDefaultSize}}
54
55Adds a tool. See the documentation for wxToolBar for details.
56
57
58\func{void}{AddTool}{\param{int }{toolIndex}, \param{const wxString\& }{imageFileName}, \param{wxBitmapType }{imageFileType = wxBITMAP\_TYPE\_BMP}, \param{const wxString\& }{labelText = ""}, \param{bool }{alignTextRight = FALSE}, \param{bool }{isFlat = TRUE}}
59
60Adds a tool. See the documentation for wxToolBar for details.
61
62
63\func{void}{AddTool}{\param{int }{toolIndex}, \param{wxBitmap }{labelBmp}, \param{const wxString\& }{labelText = ""}, \param{bool }{alignTextRight = FALSE}, \param{bool }{isFlat = TRUE}}
64
65Adds a tool. See the documentation for wxToolBar for details.
66
67
68\func{wxToolBarToolBase*}{AddTool}{\param{const int }{toolIndex}, \param{const wxBitmap\& }{bitmap}, \param{const wxBitmap\& }{pushedBitmap = wxNullBitmap}, \param{const bool }{toggle = FALSE}, \param{const long }{xPos = -1}, \param{const long }{yPos = -1}, \param{wxObject* }{clientData = NULL}, \param{const wxString\& }{helpString1 = ""}, \param{const wxString\& }{helpString2 = ""}}
69
70Method from wxToolBarBase (for compatibility), only
71the first two arguments are valid.
72See the documentation for wxToolBar for details.
73
74
75\membersection{wxDynamicToolBar::Create}\label{wxdynamictoolbarcreate}
76
77\func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{const long }{style = wxNO\_BORDER}, \param{const int }{orientation = wxVERTICAL}, \param{const int }{RowsOrColumns = 1}, \param{const wxString\& }{name = wxToolBarNameStr}}
78
79Creation function: see the documentation for wxToolBar for details.
80
81
82\membersection{wxDynamicToolBar::CreateDefaultLayout}\label{wxdynamictoolbarcreatedefaultlayout}
83
84\func{LayoutManagerBase*}{CreateDefaultLayout}{\void}
85
86Creates the default layout (BagLayout).
87
88
89\membersection{wxDynamicToolBar::CreateTool}\label{wxdynamictoolbarcreatetool}
90
91\func{wxToolBarToolBase*}{CreateTool}{\param{wxControl* }{control}}
92
93Creates a toolbar tool.
94
95
96\func{wxToolBarToolBase*}{CreateTool}{\param{int }{id}, \param{const wxBitmap\& }{bitmap1}, \param{const wxBitmap\& }{bitmap2}, \param{bool }{toggle}, \param{wxObject* }{clientData}, \param{const wxString\& }{shortHelpString}, \param{const wxString\& }{longHelpString}}
97
98Creates a toolbar tool.
99
100
101\membersection{wxDynamicToolBar::DoDeleteTool}\label{wxdynamictoolbardodeletetool}
102
103\func{bool}{DoDeleteTool}{\param{size\_t }{pos}, \param{wxToolBarToolBase* }{tool}}
104
105Deletes a tool. The tool is still in m\_tools list when this function is called, and it will
106only be deleted from it if it succeeds.
107
108
109\membersection{wxDynamicToolBar::DoEnableTool}\label{wxdynamictoolbardoenabletool}
110
111\func{void}{DoEnableTool}{\param{wxToolBarToolBase* }{tool}, \param{bool }{enable}}
112
113Called when the tools enabled flag changes.
114
115
116\membersection{wxDynamicToolBar::DoInsertTool}\label{wxdynamictoolbardoinserttool}
117
118\func{bool}{DoInsertTool}{\param{size\_t }{pos}, \param{wxToolBarToolBase* }{tool}}
119
120Inserts a tool at the given position.
121
122
123\membersection{wxDynamicToolBar::DoSetToggle}\label{wxdynamictoolbardosettoggle}
124
125\func{void}{DoSetToggle}{\param{wxToolBarToolBase* }{tool}, \param{bool }{toggle}}
126
127Called when the tools 'can be toggled' flag changes.
128
129
130\membersection{wxDynamicToolBar::DoToggleTool}\label{wxdynamictoolbardotoggletool}
131
132\func{void}{DoToggleTool}{\param{wxToolBarToolBase* }{tool}, \param{bool }{toggle}}
133
134Called when the tool is toggled.
135
136
137\membersection{wxDynamicToolBar::DrawSeparator}\label{wxdynamictoolbardrawseparator}
138
139\func{void}{DrawSeparator}{\param{wxDynToolInfo\& }{info}, \param{wxDC\& }{dc}}
140
141Draws a separator. The default implementation draws a shaded line.
142
143
144\membersection{wxDynamicToolBar::EnableTool}\label{wxdynamictoolbarenabletool}
145
146\func{void}{EnableTool}{\param{const int }{toolIndex}, \param{const bool }{enable = TRUE}}
147
148Enables or disables the given tool.
149
150
151\membersection{wxDynamicToolBar::FindToolForPosition}\label{wxdynamictoolbarfindtoolforposition}
152
153\constfunc{wxToolBarToolBase*}{FindToolForPosition}{\param{wxCoord }{x}, \param{wxCoord }{y}}
154
155Finds a tool for the given position.
156
157
158\membersection{wxDynamicToolBar::GetPreferredDim}\label{wxdynamictoolbargetpreferreddim}
159
160\func{void}{GetPreferredDim}{\param{const wxSize\& }{givenDim}, \param{wxSize\& }{prefDim}}
161
162Returns the preferred dimension, taking the given dimension and a reference to the result.
163
164
165\membersection{wxDynamicToolBar::GetToolInfo}\label{wxdynamictoolbargettoolinfo}
166
167\func{wxDynToolInfo*}{GetToolInfo}{\param{int }{toolIndex}}
168
169Returns tool information for the given tool index.
170
171
172\membersection{wxDynamicToolBar::Layout}\label{wxdynamictoolbarlayout}
173
174\func{bool}{Layout}{\void}
175
176Performs layout. See definitions of orientation types.
177
178
179\membersection{wxDynamicToolBar::OnEraseBackground}\label{wxdynamictoolbaronerasebackground}
180
181\func{void}{OnEraseBackground}{\param{wxEraseEvent\& }{event}}
182
183Responds to background erase events. Currently does nothing.
184
185
186\membersection{wxDynamicToolBar::OnPaint}\label{wxdynamictoolbaronpaint}
187
188\func{void}{OnPaint}{\param{wxPaintEvent\& }{event}}
189
190Responds to paint events, drawing separators.
191
192
193\membersection{wxDynamicToolBar::OnSize}\label{wxdynamictoolbaronsize}
194
195\func{void}{OnSize}{\param{wxSizeEvent\& }{event}}
196
197Responds to size events, calling Layout.
198
199
200\membersection{wxDynamicToolBar::Realize}\label{wxdynamictoolbarrealize}
201
202\func{bool}{Realize}{\void}
203
204Overriden from wxToolBarBase; does nothing.
205
206
207\membersection{wxDynamicToolBar::RemveTool}\label{wxdynamictoolbarremvetool}
208
209\func{void}{RemveTool}{\param{int }{toolIndex}}
210
211Removes the given tool. Misspelt in order not to clash with a similar function
212in the base class.
213
214
215\membersection{wxDynamicToolBar::SetLayout}\label{wxdynamictoolbarsetlayout}
216
217\func{void}{SetLayout}{\param{LayoutManagerBase* }{pLayout}}
218
219Sets the layout for this toolbar.
220
221
222\membersection{wxDynamicToolBar::SizeToolWindows}\label{wxdynamictoolbarsizetoolwindows}
223
224\func{void}{SizeToolWindows}{\void}
225
226Internal function for sizing tool windows.
227