r3osgdgt

Class

oops/r3osgdgt.h

Library

r3oops

Description:

Base class for all platform specific gadgets, such as sliders, buttons, etc.

See Also

oops/r3gadget.h

Super Class

r3Gadget

R3CLID_GADGET

JavaScript

r3Osgadget

Class Identifier

R3CLID_OSGADGET - 42

Methods

GADGETUP, GADGETDOWN, GADGETSCROLL, GADGETDOUBLECLICK, ACCEPT, PARENTEVENT, REPOSITION, ENABLEGADGET, SHOWGADGET, REPAINTGADGET, ADDTOOLTIP, ACTIVE, INACTIVE, GADGETEVENT, BEGINDRAG, ACTIVATEAPP, NOTIFYPOPUPMENU, EXTGADGETEVENT, CANCEL,

Attributes

PlaceText, NgOffsetX, NgOffsetY, NgPadX, NgPadY, Image, ConflictState, LeftPopupMenu, LeftPopupMargin, AlignPopupMenu,

Registration

int R3RegisterOSGadgetClass(R3APP *app);

R3OGM_GADGETUP

Method

GADGETUP

Identifier

R3OGM_GADGETUP

Return

R3BOOL, FALSE terminates event processing

Param 3:

R3WINDOWEVENT*, 'gadget' field contains event specific data.

JavaScript

rc = obj.GADGETUP(p3);

Description

The user has released gadget, such as button, slider etc.

R3OGM_GADGETDOWN

Method

GADGETDOWN

Identifier

R3OGM_GADGETDOWN

Return

R3BOOL, return TRUE to continue event processing

Param 3:

R3WINDOWEVENT*, gadget field contains gadget specific information

JavaScript

rc = obj.GADGETDOWN(p3);

Description

Gadget pressed

R3OGM_GADGETSCROLL

Method

GADGETSCROLL

Identifier

R3OGM_GADGETSCROLL

Return

R3BOOL, TRUE continues event processing

Param 3:

R3WINDOWEVENT*, gadget field filled with event gadget specific data, such as current value of the gadget.

JavaScript

rc = obj.GADGETSCROLL(p3);

Description

Sent whenever the gadgets state is changed between GADGETDOWN and GADGETUP methods.

R3OGM_GADGETDOUBLECLICK

Method

GADGETDOUBLECLICK

Identifier

R3OGM_GADGETDOUBLECLICK

Param 3:

R3WINDOWEVENT*

JavaScript

obj.GADGETDOUBLECLICK(p3);

Description

The user has double clicked the gadget

R3OGM_ACCEPT

Method

ACCEPT

Identifier

R3OGM_ACCEPT

JavaScript

obj.ACCEPT();

Description

control is accepted (double-clicked or when Enter is hit)

R3OGM_PARENTEVENT

Method

PARENTEVENT

Identifier

R3OGM_PARENTEVENT

JavaScript

obj.PARENTEVENT();

Description

R3OGM_REPOSITION

Method

REPOSITION

Identifier

R3OGM_REPOSITION

JavaScript

obj.REPOSITION();

Description

R3OGM_ENABLEGADGET

Method

ENABLEGADGET

Identifier

R3OGM_ENABLEGADGET

JavaScript

obj.ENABLEGADGET();

Description

R3OGM_SHOWGADGET

Method

SHOWGADGET

Identifier

R3OGM_SHOWGADGET

JavaScript

obj.SHOWGADGET();

Description

R3OGM_REPAINTGADGET

Method

REPAINTGADGET

Identifier

R3OGM_REPAINTGADGET

JavaScript

obj.REPAINTGADGET();

Description

R3OGM_ADDTOOLTIP

Method

ADDTOOLTIP

Identifier

R3OGM_ADDTOOLTIP

JavaScript

obj.ADDTOOLTIP();

Description

R3OGM_ACTIVE

Method

ACTIVE

Identifier

R3OGM_ACTIVE

Return

R3BOOL, TRUE continues event processing

Param 3:

R3WINDOWEVENT*, gadget field filled with event gadget specific data, such as current value of the gadget.

JavaScript

rc = obj.ACTIVE(p3);

Description

Sent whenever the gadgets is activated either by mouse or keyboard

R3OGM_INACTIVE

Method

INACTIVE

Identifier

R3OGM_INACTIVE

Return

R3BOOL, TRUE continues event processing

Param 3:

R3WINDOWEVENT*, gadget field filled with event gadget specific data, such as current value of the gadget.

JavaScript

rc = obj.INACTIVE(p3);

Description

Sent whenever the gadgets is deactivated

R3OGM_GADGETEVENT

Method

GADGETEVENT

Identifier

R3OGM_GADGETEVENT

JavaScript

obj.GADGETEVENT();

Description

R3OGM_BEGINDRAG

Method

BEGINDRAG

Identifier

R3OGM_BEGINDRAG

JavaScript

obj.BEGINDRAG();

Description

R3OGCM_ACTIVATEAPP

Method

ACTIVATEAPP

Identifier

R3OGCM_ACTIVATEAPP

JavaScript

obj.ACTIVATEAPP();

Description

R3OGM_NOTIFYPOPUPMENU

Method

NOTIFYPOPUPMENU

Identifier

R3OGM_NOTIFYPOPUPMENU

JavaScript

obj.NOTIFYPOPUPMENU();

Description

R3OGM_EXTGADGETEVENT

Method

EXTGADGETEVENT

Identifier

R3OGM_EXTGADGETEVENT

JavaScript

obj.EXTGADGETEVENT();

Description

R3OGM_CANCEL

Method

CANCEL

Identifier

R3OGM_CANCEL

Return

R3BOOL, FALSE terminates event processing

Param 3:

R3WINDOWEVENT*, 'gadget' field contains event specific data.

JavaScript

rc = obj.CANCEL(p3);

Description

The user has canceled entry e.g. by pressing ESC.

PlaceText

Attribute

PlaceText

Identifier

R3OGA_PlaceText

JavaScript type

Integer

C type

R3INT

Description

see placetext codes

Syntax

value = jsobj.GetPlaceText();

R3INT value;
R3GetAttrs(r3obj, R3OGA_PlaceText, &value, R3TAG_END);

NgOffsetX

Attribute

NgOffsetX

Identifier

R3OGA_NgOffsetX

JavaScript type

Integer

C type

int

Description

private, for class implementors only

Syntax

jsobj.SetNgOffsetX(value);
value = jsobj.GetNgOffsetX();

int value = ...;
R3SetAttrs(r3obj, R3OGA_NgOffsetX, value, R3TAG_END);
int value;
R3GetAttrs(r3obj, R3OGA_NgOffsetX, &value, R3TAG_END);

NgOffsetY

Attribute

NgOffsetY

Identifier

R3OGA_NgOffsetY

JavaScript type

Integer

C type

int

Description

private, for class implementors only

Syntax

jsobj.SetNgOffsetY(value);
value = jsobj.GetNgOffsetY();

int value = ...;
R3SetAttrs(r3obj, R3OGA_NgOffsetY, value, R3TAG_END);
int value;
R3GetAttrs(r3obj, R3OGA_NgOffsetY, &value, R3TAG_END);

NgPadX

Attribute

NgPadX

Identifier

R3OGA_NgPadX

JavaScript type

Integer

C type

int

Description

private, for class implementors only

Syntax

jsobj.SetNgPadX(value);
value = jsobj.GetNgPadX();

int value = ...;
R3SetAttrs(r3obj, R3OGA_NgPadX, value, R3TAG_END);
int value;
R3GetAttrs(r3obj, R3OGA_NgPadX, &value, R3TAG_END);

NgPadY

Attribute

NgPadY

Identifier

R3OGA_NgPadY

JavaScript type

Integer

C type

int

Description

private, for class implementors only

Syntax

value = jsobj.GetNgPadY();

int value;
R3GetAttrs(r3obj, R3OGA_NgPadY, &value, R3TAG_END);

Image

Attribute

Image

Identifier

R3OGA_Image

JavaScript type

Object

C type

R3OBJ*

Description

private, for class implementors only

Syntax

value = jsobj.GetImage();

R3OBJ* value;
R3GetAttrs(r3obj, R3OGA_Image, &value, R3TAG_END);

ConflictState

Attribute

ConflictState

Identifier

R3OGA_ConflictState

JavaScript type

Integer

C type

int

Description

private, for class implementors only

Syntax

value = jsobj.GetConflictState();

int value;
R3GetAttrs(r3obj, R3OGA_ConflictState, &value, R3TAG_END);

LeftPopupMenu

Attribute

LeftPopupMenu

Identifier

R3OGA_LeftPopupMenu

JavaScript type

Object

C type

R3OBJ*

Description

menu that is activated with the left mouse button

Syntax

jsobj.SetLeftPopupMenu(value);
value = jsobj.GetLeftPopupMenu();

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

LeftPopupMargin

Attribute

LeftPopupMargin

Identifier

R3OGA_LeftPopupMargin

JavaScript type

Integer

C type

R3INT

Description

menu opened only if x coord is higher than this value

Syntax

jsobj.SetLeftPopupMargin(value);
value = jsobj.GetLeftPopupMargin();

R3INT value = ...;
R3SetAttrs(r3obj, R3OGA_LeftPopupMargin, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3OGA_LeftPopupMargin, &value, R3TAG_END);

AlignPopupMenu

Attribute

AlignPopupMenu

Identifier

R3OGA_AlignPopupMenu

JavaScript type

Integer

C type

R3INT

Description

if TRUE, popup menu will be aligned with the lower left corner of the gadget

Syntax

value = jsobj.GetAlignPopupMenu();

R3INT value;
R3GetAttrs(r3obj, R3OGA_AlignPopupMenu, &value, R3TAG_END);

R3PLACETEXT_LEFT

R3PLACETEXT_RIGHT

R3PLACETEXT_ABOVE

R3PLACETEXT_BELOW

R3PLACETEXT_IN

R3GAD_TEXTLEN