Description


Include file: xtoolbar.h

Parent class: XWindow

Overview

XToolBar represents a toolbar for framewindows. You can attach every type of control to it.

Functions

AddWindow

Parameters

XWindow * theWindow window to add
BOOL newGroup with this window a new group starts
BOOL adjustSize recalculate the hight of the toolbar depending on the dimensions of theWindow
XWindow * insertBehind insert theWindow behind this window
LONG xOffset x-offset of the window
LONG yOffset y-offset of the window (usefull for XComboBox)

Return-Value

BOOL success

Remarks

Attach a window to the toolbar.

RemoveWindow

Parameters

XWindow * theWindow window to remove
BOOL redraw recalculate the position of other attached windows

Return-Value

BOOL success

Remarks

Removes a window attached to the toolbar

XToolBar

Parameters

XFrameWindow * parent framewindow wich gets the toolbar
ULONG style the style of the toolbar, possible values are:
TB_TOP toolbar is on the top of the framwindow
TB_BOTTOM toolbar is on the bottom of the framwindow
TB_LEFT toolbar is on the left side of the framwindow
TB_RIGHT toolbar is on the right side of the framwindow
TB_RIPABLE the user can rip the toolbar

default is TB_TOP
ULONG id window-ID, default is 0
USHORT ySize hight of the toolbar in pixels, default is 20
USHORT groupSpace size between window-groups in pixels, default is 15

Remarks

Creates a toolbar

~XToolBar

Remarks

Destructor, every attached window is destroyed and the destructors of the windows are called.

Draw

Remarks

Redraw the toolbar.

GetBackgroundColor

Parameters

XColor * colorBuffer buffer which will get the color

Remarks

Returns the background color

SetBackgroundColor

Parameters

XColor * colorBuffer the new color

Remarks

Set the background color

Show

Parameters

BOOL show TRUE=show, FALSE=hide

Remarks

Show/hide the toolbar

ReSize

Remarks

The positions of the attached windows are recalculated.

SetBorderSize

Parameters

USHORT borderSize size of border in pixels

Remarks

Set the size between the border of the toolbar and the attached windows

SetHeight

Parameters

USHORT ySize the new hight in pixels

Remarks

Set the hight of the toolbar


This document was generated by Jens von Pilgrim's Autodoc