L_TBCreate

Summary

Creates a toolbar.

Syntax

L_LTTLB_API L_INT L_TBCreate(pToolbar, hwndParent, szTitle, dwFlags )

Parameters

pTOOLBARHANDLE pToolbar

Pointer to a toolbar handle. This toolbar handle should be initialized before calling this function.

L_HWND hwndParent

Window handle to the toolbar's parent window.

L_TCHAR * szTitle

Character string that contains the title for the toolbar window. This is a NULL terminated string.

L_UINT32 dwFlags

Flags that will indicate the type of the toolbar to be created. Possible values are:

Returns

Comments

L_TBInit must be called before calling this function.

The toolbar is created as a child window to the window specified in hwndParent.

Note: Vector and Paint toolbars are Automation toolbars. When using the Automation C API in addition to the Toolbar C API, these toolbars automatically handle the buttons and the necessary function calls. If automation is not used, then it is the user's responsibility to create buttons, assign ID numbers, process the events and handle all necessary function calls.

Paint Toolbar Buttons

The paint toolbar contains the following buttons:

Image	Description	Button ID
	Paintbrush tool	ID_TOOL_PAINT_BRUSH
	Line shape tool	ID_TOOL_PAINT_SHAPE_LINE
	Rectangle shape tool	ID_TOOL_PAINT_SHAPE_RECT
	Rounded rectangle shape tool	ID_TOOL_PAINT_SHAPE_ROUNDRECT
	Ellipse shape tool	ID_TOOL_PAINT_SHAPE_ELLIPSE
	Polygon shape tool	ID_TOOL_PAINT_SHAPE_POLYGON
	Bezier shape tool	ID_TOOL_PAINT_SHAPE_BEZIER
	Region rectangle tool	ID_TOOL_PAINT_REGION_RECT
	Rounded rectangle region tool	D_TOOL_PAINT_REGION_ROUNDRECT
	Ellipse region tool	ID_TOOL_PAINT_REGION_ELLIPSE
	Polygon region tool	ID_TOOL_PAINT_REGION_POLYGON
	Surface region tool	ID_TOOL_PAINT_REGION_SURFACE
	Border region tool	ID_TOOL_PAINT_REGION_BORDER
	Color region tool	ID_TOOL_PAINT_REGION_COLOR
	Surface fill tool	ID_TOOL_PAINT_FILL_SURFACE
	Border fill tool	ID_TOOL_PAINT_FILL_BORDER
	Color replace tool	ID_TOOL_PAINT_FILL_COLORREPLACE
	Text tool	ID_TOOL_PAINT_TEXT
	Zoom tool	ID_TOOL_PAINT_ZOOM
	Border color picker tool	ID_TOOL_PAINT_BORDERCOLORPICKER
	Mover tool	ID_TOOL_PAINT_MOVER

Vector Toolbar Buttons

The vector toolbar contains the following buttons:

Image	Description	Button ID
	Neutral (No tool selected)	ID_TOOL_VECTOR_NONE
	Select object(s)	ID_TOOL_VECTOR_SELECT
	Vertex	ID_TOOL_VECTOR_VERTEX
	Line	ID_TOOL_VECTOR_LINE
	Rectangle	ID_TOOL_VECTOR_RECTANGLE
	Polyline	ID_TOOL_VECTOR_POLYLINE
	Polybezier	ID_TOOL_VECTOR_POLYBEZIER
	Polygon	ID_TOOL_VECTOR_POLYGON
	Ellipse	ID_TOOL_VECTOR_ELLIPSE
	Circle	ID_TOOL_VECTOR_CIRCLE
	Arc	ID_TOOL_VECTOR_ARC
	Text	ID_TOOL_VECTOR_TEXT
	Pie	ID_TOOL_VECTOR_PIE
	Chord	ID_TOOL_VECTOR_CHORD<
	Raster	ID_TOOL_VECTOR_RASTER
	Rotate	ID_TOOL_VECTOR_ROTATE
	Pan	ID_TOOL_VECTOR_PAN

Required DLLs and Libraries

• LTTLB

• For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions

• L_TBInit
• L_TBFree
• L_TBIsValid

Topics

• Creating a Toolbar

Example

This example will initiate, create a toolbar, set its position and make it visible

L_INT TBCreateExample( HWND hWnd, pTOOLBARHANDLE* ppLeadToolbar) 
{ 
   L_INT nRet; 
   /* Initiate the toolbar handle */ 
    nRet = L_TBInit ( ppLeadToolbar );  
    if(nRet != SUCCESS) 
       return nRet; 
    nRet = L_TBIsValid( *ppLeadToolbar ); 
    /* Check the validity of the handle */ 
    if (SUCCESS == nRet ) 
    { 
       POINT pt = { 0, 0 }; 
 
      /* Initiate the point will be used to align the toolbar at the top-left of its owner client area */ 
      ClientToScreen ( hWnd, &pt ); 
 
      /* Create the toolbar  */ 
      nRet = L_TBCreate ( *ppLeadToolbar, hWnd, TEXT("Tools Window"), TOOLBAR_PAINT ); 
      if(nRet != SUCCESS) 
         return nRet; 
 
      /* Set the toolbar position */ 
      nRet = L_TBSetPosition ( *ppLeadToolbar, &pt, TOOLBAR_POSITION_TOP | TOOLBAR_POSITION_LEFT ); 
      if(nRet != SUCCESS) 
         return nRet; 
 
      /* Show the toolbar */ 
      nRet = L_TBSetVisible ( *ppLeadToolbar, TRUE ); 
      if(nRet != SUCCESS) 
         return nRet; 
   } 
    else 
       return nRet; 
 
   return SUCCESS; 
}