1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
|
///////////////////////////////////////////////////////////////////////////////
// Name: ribbon/toolbar.h
// Purpose: interface of wxRibbonToolBar
// Author: Peter Cawley
// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
/**
@class wxRibbonToolBar
A ribbon tool bar is similar to a traditional toolbar which has no labels.
It contains one or more tool groups, each of which contains one or more
tools. Each tool is represented by a (generally small, i.e. 16x15) bitmap.
@beginEventEmissionTable{wxRibbonToolBarEvent}
@event{EVT_RIBBONTOOLBAR_CLICKED(id, func)}
Triggered when the normal (non-dropdown) region of a tool on the tool
bar is clicked.
@event{EVT_RIBBONTOOLBAR_DROPDOWN_CLICKED(id, func)}
Triggered when the dropdown region of a tool on the tool bar is
clicked. wxRibbonToolBarEvent::PopupMenu() should be called by the
event handler if it wants to display a popup menu (which is what most
dropdown tools should be doing).
@endEventTable
@library{wxribbon}
@category{ribbon}
*/
class wxRibbonToolBar : public wxRibbonControl
{
public:
/**
Default constructor.
With this constructor, Create() should be called in order to create
the tool bar.
*/
wxRibbonToolBar();
/**
Construct a ribbon tool bar with the given parameters.
@param parent
Parent window for the tool bar (typically a wxRibbonPanel).
@param id
An identifier for the toolbar. @c wxID_ANY is taken to mean a default.
@param pos
Initial position of the tool bar.
@param size
Initial size of the tool bar.
@param style
Tool bar style, currently unused.
*/
wxRibbonToolBar(wxWindow* parent,
wxWindowID id = wxID_ANY,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0);
/**
Destructor.
*/
virtual ~wxRibbonToolBar();
/**
Create a tool bar in two-step tool bar construction.
Should only be called when the default constructor is used, and
arguments have the same meaning as in the full constructor.
*/
bool Create(wxWindow* parent,
wxWindowID id = wxID_ANY,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0);
/**
Add a tool to the tool bar (simple version).
*/
virtual wxRibbonToolBarToolBase* AddTool(
int tool_id,
const wxBitmap& bitmap,
const wxString& help_string,
wxRibbonButtonKind kind = wxRIBBON_BUTTON_NORMAL);
/**
Add a dropdown tool to the tool bar (simple version).
@see AddTool()
*/
virtual wxRibbonToolBarToolBase* AddDropdownTool(
int tool_id,
const wxBitmap& bitmap,
const wxString& help_string = wxEmptyString);
/**
Add a hybrid tool to the tool bar (simple version).
@see AddTool()
*/
virtual wxRibbonToolBarToolBase* AddHybridTool(
int tool_id,
const wxBitmap& bitmap,
const wxString& help_string = wxEmptyString);
/**
Add a toggle tool to the tool bar (simple version).
@since 2.9.4
@see AddTool()
*/
virtual wxRibbonToolBarToolBase* AddToggleTool(
int tool_id,
const wxBitmap& bitmap,
const wxString& help_string);
/**
Add a tool to the tool bar.
@param tool_id
ID of the new tool (used for event callbacks).
@param bitmap
Bitmap to use as the foreground for the new tool. Does not have
to be the same size as other tool bitmaps, but should be similar
as otherwise it will look visually odd.
@param bitmap_disabled
Bitmap to use when the tool is disabled. If left as wxNullBitmap,
then a bitmap will be automatically generated from @a bitmap.
@param help_string
The UI help string to associate with the new tool.
@param kind
The kind of tool to add.
@param client_data
Client data to associate with the new tool.
@return An opaque pointer which can be used only with other tool bar
methods.
@see AddDropdownTool(), AddHybridTool(), AddSeparator(), InsertTool()
*/
virtual wxRibbonToolBarToolBase* AddTool(
int tool_id,
const wxBitmap& bitmap,
const wxBitmap& bitmap_disabled = wxNullBitmap,
const wxString& help_string = wxEmptyString,
wxRibbonButtonKind kind = wxRIBBON_BUTTON_NORMAL,
wxObject* client_data = NULL);
/**
Add a separator to the tool bar.
Separators are used to separate tools into groups. As such, a separator
is not explicitly drawn, but is visually seen as the gap between tool
groups.
*/
virtual wxRibbonToolBarToolBase* AddSeparator();
/**
Insert a tool to the tool bar (simple version) as the specified
position.
@since 2.9.4
@see InsertTool()
*/
virtual wxRibbonToolBarToolBase* InsertTool(
size_t pos,
int tool_id,
const wxBitmap& bitmap,
const wxString& help_string,
wxRibbonButtonKind kind = wxRIBBON_BUTTON_NORMAL);
/**
Insert a dropdown tool to the tool bar (simple version) as the specified
position.
@since 2.9.4
@see AddDropdownTool(), InsertTool()
*/
virtual wxRibbonToolBarToolBase* InsertDropdownTool(
size_t pos,
int tool_id,
const wxBitmap& bitmap,
const wxString& help_string = wxEmptyString);
/**
Insert a hybrid tool to the tool bar (simple version) as the specified
position.
@since 2.9.4
@see AddHybridTool(), InsertTool()
*/
virtual wxRibbonToolBarToolBase* InsertHybridTool(
size_t pos,
int tool_id,
const wxBitmap& bitmap,
const wxString& help_string = wxEmptyString);
/**
Insert a toggle tool to the tool bar (simple version) as the specified
position.
@since 2.9.4
@see AddToggleTool(), InsertTool()
*/
virtual wxRibbonToolBarToolBase* InsertToggleTool(
size_t pos,
int tool_id,
const wxBitmap& bitmap,
const wxString& help_string = wxEmptyString);
/**
Insert a tool to the tool bar at the specified position.
@param pos
Position of the new tool (number of tools and separators from the
beginning of the toolbar).
@param tool_id
ID of the new tool (used for event callbacks).
@param bitmap
Bitmap to use as the foreground for the new tool. Does not have
to be the same size as other tool bitmaps, but should be similar
as otherwise it will look visually odd.
@param bitmap_disabled
Bitmap to use when the tool is disabled. If left as wxNullBitmap,
then a bitmap will be automatically generated from @a bitmap.
@param help_string
The UI help string to associate with the new tool.
@param kind
The kind of tool to add.
@param client_data
Client data to associate with the new tool.
@return An opaque pointer which can be used only with other tool bar
methods.
@since 2.9.4
@see InsertDropdownTool(), InsertHybridTool(), InsertSeparator()
*/
virtual wxRibbonToolBarToolBase* InsertTool(
size_t pos,
int tool_id,
const wxBitmap& bitmap,
const wxBitmap& bitmap_disabled = wxNullBitmap,
const wxString& help_string = wxEmptyString,
wxRibbonButtonKind kind = wxRIBBON_BUTTON_NORMAL,
wxObject* client_data = NULL);
/**
Insert a separator to the tool bar at the specified position.
@since 2.9.4
@see AddSeparator(), InsertTool()
*/
virtual wxRibbonToolBarToolBase* InsertSeparator(size_t pos);
/**
Deletes all the tools in the toolbar.
@since 2.9.4
*/
virtual void ClearTools();
/**
Removes the specified tool from the toolbar and deletes it.
@param tool_id
ID of the tool to delete.
@returns @true if the tool was deleted, @false otherwise.
@since 2.9.4
@see DeleteToolByPos()
*/
virtual bool DeleteTool(int tool_id);
/**
This function behaves like DeleteTool() but it deletes the tool at the
specified position and not the one with the given id.
Useful to delete separators.
@since 2.9.4
*/
virtual bool DeleteToolByPos(size_t pos);
/**
Returns a pointer to the tool opaque structure by @a id or @NULL if no
corresponding tool is found.
@since 2.9.4
*/
virtual wxRibbonToolBarToolBase* FindById(int tool_id)const;
/**
Return the opaque pointer corresponding to the given tool.
@return an opaque pointer, NULL if is a separator or not found.
@since 2.9.4
*/
wxRibbonToolBarToolBase* GetToolByPos(size_t pos)const
/**
Returns the number of tools in the toolbar.
@since 2.9.4
*/
virtual size_t GetToolCount() const;
/**
Return the id assciated to the tool opaque structure.
The structure pointer must not be @NULL.
@since 2.9.4
*/
virtual int GetToolId(const wxRibbonToolBarToolBase* tool)const;
/**
Get any client data associated with the tool.
@param tool_id
ID of the tool in question, as passed to AddTool().
@return Client data, or @NULL if there is none.
@since 2.9.4
*/
virtual wxObject* GetToolClientData(int tool_id)const;
/**
Called to determine whether a tool is enabled (responds to user input).
@param tool_id
ID of the tool in question, as passed to AddTool().
@return @true if the tool is enabled, @false otherwise.
@since 2.9.4
@see EnableTool()
*/
virtual bool GetToolEnabled(int tool_id)const;
/**
Returns the help string for the given tool.
@param tool_id
ID of the tool in question, as passed to AddTool().
@since 2.9.4
*/
virtual wxString GetToolHelpString(int tool_id)const;
/**
Return the kind of the given tool.
@param tool_id
ID of the tool in question, as passed to AddTool().
@since 2.9.4
*/
virtual wxRibbonButtonKind GetToolKind(int tool_id)const;
/**
Returns the tool position in the toolbar, or @c wxNOT_FOUND if the tool
is not found.
@param tool_id
ID of the tool in question, as passed to AddTool().
@since 2.9.4
*/
virtual int GetToolPos(int tool_id)const;
/**
Gets the on/off state of a toggle tool.
@param tool_id
ID of the tool in question, as passed to AddTool().
@return @true if the tool is toggled on, @false otherwise.
@see ToggleTool()
@since 2.9.4
*/
virtual bool GetToolState(int tool_id)const;
/**
Calculate tool layouts and positions.
Must be called after tools are added to the tool bar, as otherwise
the newly added tools will not be displayed.
*/
virtual bool Realize();
/**
Set the number of rows to distribute tool groups over.
Tool groups can be distributed over a variable number of rows. The way
in which groups are assigned to rows is not specified, and the order
of groups may change, but they will be distributed in such a way as to
minimise the overall size of the tool bar.
@param nMin
The minimum number of rows to use.
@param nMax
The maximum number of rows to use (defaults to nMin).
*/
virtual void SetRows(int nMin, int nMax = -1);
/**
Sets the client data associated with the tool.
@param tool_id
ID of the tool in question, as passed to AddTool().
@param clientData
The client data to use.
@since 2.9.4
*/
virtual void SetToolClientData(int tool_id, wxObject* clientData);
/**
Sets the bitmap to be used by the tool with the given ID when the tool
is in a disabled state.
@param tool_id
ID of the tool in question, as passed to AddTool().
@param bitmap
Bitmap to use for disabled tools.
@since 2.9.4
*/
virtual void SetToolDisabledBitmap(int tool_id, const wxBitmap &bitmap);
/**
Sets the help string shown in tooltip for the given tool.
@param tool_id
ID of the tool in question, as passed to AddTool().
@param helpString
A string for the help.
@see GetToolHelpString()
@since 2.9.4
*/
virtual void SetToolHelpString(int tool_id, const wxString& helpString);
/**
Sets the bitmap to be used by the tool with the given ID.
@param tool_id
ID of the tool in question, as passed to AddTool().
@param bitmap
Bitmap to use for normals tools.
@since 2.9.4
*/
virtual void SetToolNormalBitmap(int tool_id, const wxBitmap &bitmap);
/**
Enable or disable a single tool on the bar.
@param tool_id
ID of the tool to enable or disable.
@param enable
@true to enable the tool, @false to disable it.
@since 2.9.4
*/
virtual void EnableTool(int tool_id, bool enable = true);
/**
Set a toggle tool to the checked or unchecked state.
@param tool_id
ID of the toggle tool to manipulate.
@param checked
@true to set the tool to the toggled/pressed/checked state,
@false to set it to the untoggled/unpressed/unchecked state.
@since 2.9.4
*/
virtual void ToggleTool(int tool_id, bool checked);
};
|
