Description


Include file: xuserbtn.h

Parent class: XSettingButton

Overview

Functions

XUserButton

Parameters

XWindow * owner the owner
XRect * rect the rectangle
USHORT id id of the window
ULONG style style, valid values are:
BU_HELP
BU_DEFAULT
BU_NOPOINTERFOCUS
BU_NOCURSORSELECT
BU_NOBORDER
BU_TWOSTATE

(can be or-ed).
const char * string text to display (default is NULL)
SHORT yOffset an y-offset for the bitmap (useful if you use bimaps and text, default is NULL)

Remarks

Constructs a userbuttom

IsSelected

Return-Value

BOOL selection

Remarks

Query if the button is selected or not

Select

Parameters

BOOL selection TRUE=select, FALSE=unselect

Remarks

Select te button

Toggle

Remarks

Toggles the button

GetBitmapPointer

Parameters

UCHAR index index of the bitmap:
0 = the bitmap to display if the button is not pressed
1 = the bitmap to display if the button is pressed

Return-Value

XBitmap * bmp the requested bitmap

Remarks

Returns a pointer to one of two used bitmaps.

GetGraphPointer

Return-Value

XGraphicDevice * dev the graphic device

Remarks

Returns a pointer to the graphic-device of the button.

GetTextPointer

Return-Value

XText * text the text object

Remarks

Returns a pointer to used text-object of the button.

SetBitmap

Parameters

XBitmap * bmp the bitmap
UCHAR index index of the bitmap:
0 = the bitmap to display if the button is not pressed
1 = the bitmap to display if the button is pressed /t>

Remarks

Set a bitmap to the button. The bitmap is copied so the destructor of the bitmap given in the argument can be called when this functions returns.


This document was generated by Jens von Pilgrim's Autodoc