LBUTTONINFO

Summary

Contains information about a button associated with a tool in a toolbar.

Syntax

typedef struct _LBUTTONINFO 
{ 
   L_UINT uStructSize; 
   L_UINT uID; 
   L_UCHAR fsState; 
   HBITMAP hBitmap; 
   L_TCHAR szToolTipText [ TOOLBAR_TOOLTIP_MAX_TEXT ]; 
   L_UINT32 dwTag; 
} LBUTTONINFO, *pLBUTTONINFO; 

Members

uStructSize

Size of this structure.

uID

Command identifier associated with the button. This identifier will be used in the user specified callback to identify the button that initiated the call. Possible values for enum TOOLBARBUTTONID are:

Value Meaning
ID_TOOL_PAINT_BRUSH Digital Paint Brush tool
ID_TOOL_PAINT_SHAPE_LINE Digital Paint Shape Line tool
ID_TOOL_PAINT_SHAPE_RECT Digital Paint Shape Rectangle tool
ID_TOOL_PAINT_SHAPE_ROUNDRECT Digital Paint Shape Rounded Rectangle tool
ID_TOOL_PAINT_SHAPE_ELLIPSE Digital Paint Shape Ellipse tool
ID_TOOL_PAINT_SHAPE_POLYGON Digital Paint Shape Polygon tool
ID_TOOL_PAINT_SHAPE_BEZIER Digital Paint Shape Bezier Curve tool
ID_TOOL_PAINT_REGION_RECT Digital Paint Region Rectangle tool
ID_TOOL_PAINT_REGION_ROUNDRECT Digital Paint Region Rounded Rectangle tool
ID_TOOL_PAINT_REGION_ELLIPSE Digital Paint Region Ellipse tool
ID_TOOL_PAINT_REGION_POLYGON Digital Paint Region Polygon tool
ID_TOOL_PAINT_REGION_SURFACE Digital Paint Region Surface tool
ID_TOOL_PAINT_REGION_BORDER Digital Paint Region Border tool
ID_TOOL_PAINT_REGION_COLOR Digital Paint Region Color tool
ID_TOOL_PAINT_FILL_SURFACE Digital Paint Fill Surface tool
ID_TOOL_PAINT_FILL_BORDER Digital Paint Fill Border tool
ID_TOOL_PAINT_FILL_COLORREPLACE Digital Paint Fill Color Replace tool
ID_TOOL_PAINT_TEXT Digital Paint Text tool
ID_TOOL_PAINT_ZOOM Digital Paint Zoom tool
ID_TOOL_PAINT_BORDERCOLORPICKER Digital Paint Border Color Picker tool
ID_TOOL_PAINT_MOVER Digital Paint Pan/Mover tool
ID_TOOL_PAINT_COUNT Number of Digital Paint tools
ID_TOOL_VECTOR_NONE Vector No tool
ID_TOOL_VECTOR_SELECT Vector Select tool
ID_TOOL_VECTOR_VERTEX Vector Vertex tool
ID_TOOL_VECTOR_LINE Vector Line tool"
ID_TOOL_VECTOR_RECTANGLE Vector Rectangle tool
ID_TOOL_VECTOR_POLYLINE Vector PolyLine tool
ID_TOOL_VECTOR_POLYBEZIER Vector PolyBezier tool
ID_TOOL_VECTOR_POLYGON Vector Polygon tool
ID_TOOL_VECTOR_ELLIPSE Vector Ellipse tool
ID_TOOL_VECTOR_CIRCLE Vector Circle tool
ID_TOOL_VECTOR_ARC Vector Arc tool
ID_TOOL_VECTOR_TEXT Vector Text tool
ID_TOOL_VECTOR_PIE Vector Pie tool
ID_TOOL_VECTOR_CHORD Vector Chord tool
ID_TOOL_VECTOR_RASTER Vector Raster Image tool
ID_TOOL_VECTOR_ROTATE Vector Rotate tool
ID_TOOL_VECTOR_PAN Vector Pan tool
ID_TOOL_VECTOR_COUNT Number of Vector tools

fsState

Button state flags. This member can be a combination of the values listed below:

Value Meaning
TBSTATE_ENABLED The button accepts user input
TBSTATE_HIDDEN The button is not visible and cannot receive user input.
TBSTATE_PRESSED The button is being clicked.

hBitmap

A DDB (device dependent bitmap) that will represent the Cold (enabled) bitmap of the button. The toolbar will automatically create the hot and the disabled bitmaps.

szToolTipText

A null-terminated array of characters that will become the button tool tip. The maximum length of this string is TOOLBAR_TOOLTIP_MAX_TEXT.

dwTag

User-defined data associated with the button information.

Comments

A toolbar is made up of one or more tools. The LTOOLBARINFO structure contains information about the toolbar in general. Information about each tool that makes up the toolbar is contained in an LTOOLBARINFO structure. Each tool in a toolbar may have one or more buttons associated with it. A tool with more than one button associated with it is said to be a sub-toolbar. Information about the button(s) associated with a tool in the toolbar is contained in one or more LBUTTONINFO structures.

Buttons on a toolbar may have the same ID number. If a function is called that uses a button ID, such as L_TBAddButton, then the toolkit function will act on the first button found with the specified ID.

Usage

Data Types

Functions

Help Version 22.0.2022.12.7
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Toolbar C API Help

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.