IN_GetButtonBarDefinition

All Editions $image\bltlrgsq_shg.gif$ Related Functions $image\bltlrgsq_shg.gif$ Example

The IN_GetButtonBarDefinition function returns a list of the command buttons and button separators in the specified toolbar.

Syntax

int IN_GetButtonBarDefinition ( buttonBar, maxSize, pCmdList, pNumCmds )

Parameters	Values	Meaning
SHORT buttonBar	IN_BUTTONBAR_RIBBON (1) Obsolete. Do not use this value in new integrations. View Ribbon IN_BUTTONBAR_TOOL (2) Tool Bar IN_BUTTONBAR_3D (3) 3D toolbar IN_BUTTONBAR_PAGE_NAVIGATION (4) Page Navigation toolbar IN_BUTTONBAR_VIEW (5) View toolbar IN_BUTTONBAR_WINDOWS (6) Windows toolbar IN_BUTTONBAR_BATCH (7) Batch toolbar IN_BUTTONBAR_STANDARD (8) Standard toolbar
SHORT maxSize	number of short values in the pCmdList
Output Parameters	Values	Meaning
SHORTPTR pCmdList	pointer. See Command IDs.	list of buttons and separators. For example, 101, 102, 1, 103, 104
SHORTPTR pNumCmds	pointer to the number of items in the button bar

Remarks

A separator, which places a space between the buttons, is indicated by IN_BUTTONBAR_SEPARATOR or 1.

Release information

Added to Imagenation for Windows in Release 4.50.

Modified in Release 8.0 to support dockable toolbars.

As of Release 5.1, also available in Imagenation for UNIX.

See also

Adding and removing buttons