WinXToolbar_AddToggleButton (hToolbar, commandId, iImage, STRING tooltipText, mutex, optional, moveable)
Adds a toggle button to a toolbar
Parameter | Description |
---|---|
hToolbar | The handle to the toolbar to add the toggle button to |
commandId | The unique identifier to associate with this toggle button. When the button is clicked, the onCommand callback is invoked (assuming it has been registered) with the id parameter set to this value. |
iImage | The 0 based index of the image to use for this toggle button |
STRING tooltipText | The text for the tooltip |
mutex | $$TRUE if this is part of a group of mutually exclusive toggle buttons. If a group of toggle buttons is mutually exclusive, only one can be selected at any time. Use seperators to seperate groups of mutually exclusive toggle buttons |
optional | NOT IMPLEMENTED, SET TO $$FALSE |
moveable | NOT IMPLEMENTED, SET TO $$FALSE |
$$TRUE on success or $$FALSE on fail
The toolbar displays buttons in the order they are added.
The iImage parameter is a 0 based index to the button image. If you created the toolbar with WinXNewToolbarUsingIls, this is the index into the image list. If you created the toolbar with WinXNewToolbar this is the index of the image in the bitmap specified in the hBmpButtons parameter. The button images are arranged in a row in that bitmap, the first is button 0, the next button 1 etc.
Tooltips are strictly one line only, don't make them too long.
'define constants 'add a toggle button |
WinXNewToolbar
WinXNewToolbarUsingIls
WinXToolbar_AddButton
WinXToolbar_AddSeperator
WinXToolbar_AddControl