r3gadget

Class

oops/r3gadget.h

Library

r3oops

Description:

Gadget base class

See Also

oops/r3widget.h

Super Class

r3Widget

R3CLID_WIDGET

JavaScript

r3Gadget

Class Identifier

R3CLID_GADGET - 21

Methods

WINDOWEVENT, EVENTSRECEIVED,

Attributes

Text, PopupMenu, Disabled, DefaultButton, Conflict, Icon, Toggle, Selected, PreventToggle, Bitmap, ToolTip, ReportGadgetDown, ReportActive, ReportAccept,

Registration

int R3RegisterGadgetClass(R3APP *app);

R3GM_WINDOWEVENT

Method

WINDOWEVENT

Identifier

R3GM_WINDOWEVENT

Return

R3BOOL, must be TRUE

JavaScript

rc = obj.WINDOWEVENT();

Description

Gadget gets all its events using this method. The base class maps this method to one or more gadget specific methods.

R3GM_EVENTSRECEIVED

Method

EVENTSRECEIVED

Identifier

R3GM_EVENTSRECEIVED

Return

R3INT, number of events

JavaScript

rc = obj.EVENTSRECEIVED();

Description

Events received but not processed. Can be used to check if a button has been pressed during a loop to cancel operations.

Text

Attribute

Text

Identifier

R3GA_Text

JavaScript type

String

C type

char*

Description

header text for the gadget

Syntax

jsobj.SetText(value);
value = jsobj.GetText();

char* value = ...;
R3SetAttrs(r3obj, R3GA_Text, value, R3TAG_END);
char* value;
R3GetAttrs(r3obj, R3GA_Text, &value, R3TAG_END);

PopupMenu

Attribute

PopupMenu

Identifier

R3GA_PopupMenu

JavaScript type

Object

C type

R3OBJ*

Description

pop-up menu object for the gadget

Syntax

jsobj.SetPopupMenu(value);
value = jsobj.GetPopupMenu();

R3OBJ* value = ...;
R3SetAttrs(r3obj, R3GA_PopupMenu, value, R3TAG_END);
R3OBJ* value;
R3GetAttrs(r3obj, R3GA_PopupMenu, &value, R3TAG_END);

Disabled

Attribute

Disabled

Identifier

R3GA_Disabled

JavaScript type

Boolean

C type

R3BOOL

Description

TRUE disables, FALSE enables

Syntax

jsobj.SetDisabled(value);
value = jsobj.GetDisabled();

R3BOOL value = ...;
R3SetAttrs(r3obj, R3GA_Disabled, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3GA_Disabled, &value, R3TAG_END);

DefaultButton

Attribute

DefaultButton

Identifier

R3GA_DefaultButton

JavaScript type

Boolean

C type

R3BOOL

Description

if TRUE, this gadget is the default, note not all gadgets support this

Syntax

jsobj.SetDefaultButton(value);
value = jsobj.GetDefaultButton();

R3BOOL value = ...;
R3SetAttrs(r3obj, R3GA_DefaultButton, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3GA_DefaultButton, &value, R3TAG_END);

Conflict

Attribute

Conflict

Identifier

R3GA_Conflict

JavaScript type

Boolean

C type

R3BOOL

Description

set/reset gadgets conflict state

Syntax

jsobj.SetConflict(value);
value = jsobj.GetConflict();

R3BOOL value = ...;
R3SetAttrs(r3obj, R3GA_Conflict, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3GA_Conflict, &value, R3TAG_END);

Icon

Attribute

Icon

Identifier

R3GA_Icon

JavaScript type

Object

C type

R3OBJ*

Description

icon object for the gadget

Syntax

jsobj.SetIcon(value);
value = jsobj.GetIcon();

R3OBJ* value = ...;
R3SetAttrs(r3obj, R3GA_Icon, value, R3TAG_END);
R3OBJ* value;
R3GetAttrs(r3obj, R3GA_Icon, &value, R3TAG_END);

Toggle

Attribute

Toggle

Identifier

R3GA_Toggle

JavaScript type

Boolean

C type

R3BOOL

Description

if true, gadget is toggable, note not all gadgets support this

Syntax

jsobj.SetToggle(value);
value = jsobj.GetToggle();

R3BOOL value = ...;
R3SetAttrs(r3obj, R3GA_Toggle, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3GA_Toggle, &value, R3TAG_END);

Selected

Attribute

Selected

Identifier

R3GA_Selected

JavaScript type

Boolean

C type

R3BOOL

Description

select state

Syntax

jsobj.SetSelected(value);
value = jsobj.GetSelected();

R3BOOL value = ...;
R3SetAttrs(r3obj, R3GA_Selected, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3GA_Selected, &value, R3TAG_END);

PreventToggle

Attribute

PreventToggle

Identifier

R3GA_PreventToggle

JavaScript type

Boolean

C type

R3BOOL

Description

disable toggle

Syntax

jsobj.SetPreventToggle(value);
value = jsobj.GetPreventToggle();

R3BOOL value = ...;
R3SetAttrs(r3obj, R3GA_PreventToggle, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3GA_PreventToggle, &value, R3TAG_END);

Bitmap

Attribute

Bitmap

Identifier

R3GA_Bitmap

JavaScript type

String

C type

void*

Description

bit map

Syntax

jsobj.SetBitmap(value);

void* value = ...;
R3SetAttrs(r3obj, R3GA_Bitmap, value, R3TAG_END);

ToolTip

Attribute

ToolTip

Identifier

R3GA_ToolTip

JavaScript type

String

C type

char*

Description

tool tip for the gadget

Syntax

jsobj.SetToolTip(value);
value = jsobj.GetToolTip();

char* value = ...;
R3SetAttrs(r3obj, R3GA_ToolTip, value, R3TAG_END);
char* value;
R3GetAttrs(r3obj, R3GA_ToolTip, &value, R3TAG_END);

ReportGadgetDown

Attribute

ReportGadgetDown

Identifier

R3GA_ReportGadgetDown

JavaScript type

Boolean

C type

R3BOOL

Description

if FALSE filters R3OGM_GADGETDOWN messages out

Syntax

jsobj.SetReportGadgetDown(value);
value = jsobj.GetReportGadgetDown();

R3BOOL value = ...;
R3SetAttrs(r3obj, R3GA_ReportGadgetDown, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3GA_ReportGadgetDown, &value, R3TAG_END);

ReportActive

Attribute

ReportActive

Identifier

R3GA_ReportActive

JavaScript type

Boolean

C type

R3BOOL

Description

if TRUE, gadget send R3OGM_ACTIVE and R3OGM_INACTIVE messages

Syntax

jsobj.SetReportActive(value);
value = jsobj.GetReportActive();

R3BOOL value = ...;
R3SetAttrs(r3obj, R3GA_ReportActive, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3GA_ReportActive, &value, R3TAG_END);

ReportAccept

Attribute

ReportAccept

Identifier

R3GA_ReportAccept

JavaScript type

Boolean

C type

R3BOOL

Description

if TRUE, gadget send R3OGM_ACCEPT message if Enter is pressed

Syntax

jsobj.SetReportAccept(value);
value = jsobj.GetReportAccept();

R3BOOL value = ...;
R3SetAttrs(r3obj, R3GA_ReportAccept, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3GA_ReportAccept, &value, R3TAG_END);