r3widget

Class

oops/r3widget.h

Library

r3oops

Description:

Widget base class. Widget is a two dimensional surface which has position and size.

See Also

oops/r3root.h

Super Class

r3Root

R3CLID_ROOT

JavaScript

r3Widget

Class Identifier

R3CLID_WIDGET - 41

Methods

REFRESH, MAPCHANGES, UNMAPCHANGES, DOMAP, ADDCHILDREN, REMCHILDREN, REALIZE, SETCURSOR, WINDOWTOSCREEN, SCREENTOWINDOW, FIT, SETFOCUS, RESTOREFOCUS, PASSEVENTUP, DRAGSTART, DRAGDROP, CANDROP, DRAGEND, DRAGCANCEL, DETACH, MOVETOFRONT, MOVETOBACK, MAKENAME, FINDBYNAME, DRAGDROPBYSIBLING, GETEXPANDFLAGS, FINDBYNAMEANYWHERE, RMBBEGINSCROLL, RMBSCROLL, RMBENDSCROLL, ISVISIBLE, REGISTERCANDROPTOHAND, PALETTECHANGED, CONTEXTSENSITIVEHELP,

Attributes

Parent, Left, Top, Width, Height, MinWidth, MinHeight, RecommendedMinWidth, RecommendedMinHeight, AlignX, AlignY, Visible, UserData, Font, ModelTag, ModelMethod, FrameWidth, FrameWidthLeft, FrameWidthTop, FrameWidthRight, FrameWidthBottom, SetOnChildren, Cursor, MsgPort, Menu, AllParentsVisible, DragSourceObj, DragSourceMth, DragSourceData, DropTargetObj, CanDropMth, DropMth, DropTargetData, Children, Extension, DragSourceCancelMth, DragSourceEndMth, Manager, Realized, DropBySiblingMth, Orientation, ExpandX, ExpandY, AutoOrientate, OffsetX, OffsetY, ModelIndex, FitCode, DynamicExpandX, DynamicExpandY, HelpURL, AlignXOffset, AlignYOffset,

Registration

int R3RegisterWidgetClass(R3APP *app);

R3WGM_REFRESH

Method

REFRESH

Identifier

R3WGM_REFRESH

JavaScript

obj.REFRESH();

Description

Refresh widget

R3WGM_MAPCHANGES

Method

MAPCHANGES

Identifier

R3WGM_MAPCHANGES

Return

R3BOOL, TRUE if succeeded

Param 3:

R3TAG*, see tags for mapchanges below

JavaScript

rc = obj.MAPCHANGES(p3);

Description

Ask widget to map all of its events to another object.

R3WGM_UNMAPCHANGES

Method

UNMAPCHANGES

Identifier

R3WGM_UNMAPCHANGES

Return

R3BOOL, TRUE if succeeded

Param 3:

R3TAG*, same tags as in the corresponding MAPCHANGES call

JavaScript

rc = obj.UNMAPCHANGES(p3);

Description

Don't map changes after this

R3WGM_DOMAP

Method

DOMAP

Identifier

R3WGM_DOMAP

Param 1:

R3INT, code which will be passed to mapping targets in p1

Param 2:

R3INT, map type, either R3WGMAPTYPE_VALUE or R3WGMAPTYPE_EVENT

Param 3:

void*, data passed to mapping targets in p3.

JavaScript

obj.DOMAP(p1, p2, p3);

Description

This method asks widget to map a specific method to other objects registered for the widget using MAPCHANGES method.

R3WGM_ADDCHILDREN

Method

ADDCHILDREN

Identifier

R3WGM_ADDCHILDREN

Return

R3BOOL, true if succeeded

Param 3:

R3OBJ*, sub widget to be added.

JavaScript

rc = obj.ADDCHILDREN(p3);

Description

Add sub widget. This method is defined by the widget base class but it is actually up to sub classes to implement it. Not all widgets accept sub widgets.

R3WGM_REMCHILDREN

Method

REMCHILDREN

Identifier

R3WGM_REMCHILDREN

Return

R3BOOL, true

Param 3:

R3OBJ*, sub widget to be removed.

JavaScript

rc = obj.REMCHILDREN(p3);

Description

Remove sub widget. These are defined by the widget base class but it is actually up to sub classes to implement these methods. Not all widgets accept sub widgets.

R3WGM_REALIZE

Method

REALIZE

Identifier

R3WGM_REALIZE

JavaScript

obj.REALIZE();

Description

Realize all widgets.

R3WGM_SETCURSOR

Method

SETCURSOR

Identifier

R3WGM_SETCURSOR

Param 3:

R3TAG*, R3WGA_Cursor, R3WGA_SetOnChildren,

JavaScript

obj.SETCURSOR(p3);

Description

Set cursor for the window

R3WGM_WINDOWTOSCREEN

Method

WINDOWTOSCREEN

Identifier

R3WGM_WINDOWTOSCREEN

JavaScript

obj.WINDOWTOSCREEN();

Description

Converts window coordinates to screen coordinates

R3WGM_SCREENTOWINDOW

Method

SCREENTOWINDOW

Identifier

R3WGM_SCREENTOWINDOW

JavaScript

obj.SCREENTOWINDOW();

Description

Converts screen coordinates to window coordinates

R3WGM_FIT

Method

FIT

Identifier

R3WGM_FIT

Param 3:

R3INT, see parameter codes below

JavaScript

obj.FIT(p3);

Description

Compute new size for the widget. This method should be called whenever size of one of the childrens has changed.

R3WGM_SETFOCUS

Method

SETFOCUS

Identifier

R3WGM_SETFOCUS

JavaScript

obj.SETFOCUS();

Description

sets the keyboard focus to the widget

R3WGM_RESTOREFOCUS

Method

RESTOREFOCUS

Identifier

R3WGM_RESTOREFOCUS

JavaScript

obj.RESTOREFOCUS();

Description

sets the keyboard focus to the widget that had it before previous R3WGM_SETFOCUS

R3WGM_PASSEVENTUP

Method

PASSEVENTUP

Identifier

R3WGM_PASSEVENTUP

JavaScript

obj.PASSEVENTUP();

Description

R3WGM_DRAGSTART

Method

DRAGSTART

Identifier

R3WGM_DRAGSTART

Return

void*, whatever drag source specific data. This data should be passed to DRAGDROP and CANDROP methods in 'p1' field.

JavaScript

rc = obj.DRAGSTART();

Description

Sent to drag source widget when dragging is started.

R3WGM_DRAGDROP

Method

DRAGDROP

Identifier

R3WGM_DRAGDROP

Return

R3BOOL, if true, the dropped data was succesfully handled. If FALSE, the widget class deletes the object from the 'drag&drop' buffer.

Param 1:

R3OBJ*, object to be dropped

JavaScript

rc = obj.DRAGDROP(p1, 0);

Description

Sent to 'drop target' widget when the user 'drops' the object. * Widget class sends the actual drop method registered by the R3WGA_DropMth attribute * to the object registered by the R3WGA_DropTargetObj attribute.

R3WGM_CANDROP

Method

CANDROP

Identifier

R3WGM_CANDROP

Return

R3BOOL, TRUE if drop target can handle the given object

Param 1:

R3OBJ*, object to be dropped

JavaScript

rc = obj.CANDROP(p1, 0);

Description

Sent to drop target to query if it recognizes the object to be dropped. * Widget class sends the actual candrop method registered by the R3WGA_CanDropMth attribute * to the object registered by the R3WGA_DropTargetObj attribute.

R3WGM_DRAGEND

Method

DRAGEND

Identifier

R3WGM_DRAGEND

JavaScript

obj.DRAGEND();

Description

Send to 'drag source' when drag&drop finished

R3WGM_DRAGCANCEL

Method

DRAGCANCEL

Identifier

R3WGM_DRAGCANCEL

JavaScript

obj.DRAGCANCEL();

Description

Send to 'drag source' when drag&drop cancelled.

R3WGM_DETACH

Method

DETACH

Identifier

R3WGM_DETACH

JavaScript

obj.DETACH();

Description

Detach widget from parent. Sent when a widget wants to delete itself.

R3WGM_MOVETOFRONT

Method

MOVETOFRONT

Identifier

R3WGM_MOVETOFRONT

JavaScript

obj.MOVETOFRONT();

Description

Moves the widget on top of its siblings.

R3WGM_MOVETOBACK

Method

MOVETOBACK

Identifier

R3WGM_MOVETOBACK

JavaScript

obj.MOVETOBACK();

Description

Moves the widget below its siblings.

R3WGM_MAKENAME

Method

MAKENAME

Identifier

R3WGM_MAKENAME

Return

R3BOOL, true if succeeded, false for buffer overflow

Param 1:

R3INT, size of the buffer

Param 3:

char*, buffer to the name to be constructed.

JavaScript

rc = obj.MAKENAME(p1, p3);

Description

Construct a name which identifies the widget. The constructed string is of form /root window/child window/.../control.

R3WGM_FINDBYNAME

Method

FINDBYNAME

Identifier

R3WGM_FINDBYNAME

Return

R3OBJ*, address of the widget if found, otherwise NULL.

Param 3:

char*, pointer to name string

JavaScript

rc = obj.FINDBYNAME(p3);

Description

find a widget by name. Name string is of form /root window/child window/....

R3WGM_DRAGDROPBYSIBLING

Method

DRAGDROPBYSIBLING

Identifier

R3WGM_DRAGDROPBYSIBLING

Return

R3BOOL, if true, the dropped data was succesfully handled.

Param 1:

R3OBJ*, object to be dropped. The drop target uses R3ObjectIsOfKind() to check whether it can receive the object to be dropped.

Param 3:

R3OBJ*, sibling widget

JavaScript

rc = obj.DRAGDROPBYSIBLING(p1, p3);

Description

Sent to 'drop target' widget when the user 'drops' the object.

R3WGM_GETEXPANDFLAGS

Method

GETEXPANDFLAGS

Identifier

R3WGM_GETEXPANDFLAGS

Return

R3BOOL, combination of expand flags (see below)

Param 3:

R3INT, orientation the flags are requested for (R3WGORIENTATION_VERTICAL or R3WGORIENTATION_HORIZONTAL)

JavaScript

rc = obj.GETEXPANDFLAGS(p3);

Description

Gets expand flags

R3WGM_FINDBYNAMEANYWHERE

Method

FINDBYNAMEANYWHERE

Identifier

R3WGM_FINDBYNAMEANYWHERE

Return

R3OBJ*, address of the widget if found, otherwise NULL.

Param 3:

char*, pointer to name string

JavaScript

rc = obj.FINDBYNAMEANYWHERE(p3);

Description

find a widget by name. Name string is of form /root window/child window/.../widget. Only the last component of the name is checked for match. Therefore the widget may be anywhere in the gui hierarchy.

R3WGM_RMBBEGINSCROLL

Method

RMBBEGINSCROLL

Identifier

R3WGM_RMBBEGINSCROLL

Param 1:

R3INT, x screen coordinate

Param 3:

R3INT, y screen coordinate

JavaScript

obj.RMBBEGINSCROLL(p1, p3);

Description

Begin subwindow scrolling

R3WGM_RMBSCROLL

Method

RMBSCROLL

Identifier

R3WGM_RMBSCROLL

Param 1:

R3INT, x screen coordinate

Param 3:

R3INT, y screen coordinate

JavaScript

obj.RMBSCROLL(p1, p3);

Description

Scroll subwindow

R3WGM_RMBENDSCROLL

Method

RMBENDSCROLL

Identifier

R3WGM_RMBENDSCROLL

Param 1:

R3INT, x screen coordinate

Param 3:

R3INT, y screen coordinate

JavaScript

obj.RMBENDSCROLL(p1, p3);

Description

End subwindow scrolling

R3WGM_ISVISIBLE

Method

ISVISIBLE

Identifier

R3WGM_ISVISIBLE

Return

R3BOOL, true if visible, FALSE if invisible

JavaScript

rc = obj.ISVISIBLE();

Description

Find out whether the widget is truely visible i.e. all the parents of the widget are visible.

R3WGCM_REGISTERCANDROPTOHAND

Method

REGISTERCANDROPTOHAND

Identifier

R3WGCM_REGISTERCANDROPTOHAND

Return

R3BOOL, true if successful

Param 1:

R3CLID, clid of the widget to be dropped

Param 2:

R3OBJ*, handler

Param 3:

R3INT, handler method

JavaScript

rc = obj.REGISTERCANDROPTOHAND(p1, p2, p3);

Description

Register a handler to determine where a widget can be dropped.

R3WGM_PALETTECHANGED

Method

PALETTECHANGED

Identifier

R3WGM_PALETTECHANGED

Return

void*, TRUE

JavaScript

rc = obj.PALETTECHANGED();

Description

The palette used has changed. The widget should recalculate any indices to the palette.

R3WGM_CONTEXTSENSITIVEHELP

Method

CONTEXTSENSITIVEHELP

Identifier

R3WGM_CONTEXTSENSITIVEHELP

Return

void*, TRUE

Param 3:

R3OBJ*, gadget to open the context sensitive help for.

JavaScript

rc = obj.CONTEXTSENSITIVEHELP(p3);

Description

Open context sensitive help for the gadget passed as msg.

Parent

Attribute

Parent

Identifier

R3WGA_Parent

JavaScript type

Object

C type

R3OBJ*

Description

parent widget

Syntax

jsobj.SetParent(value);
value = jsobj.GetParent();

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

Left

Attribute

Left

Identifier

R3WGA_Left

JavaScript type

Integer

C type

R3INT

Description

left edge

Syntax

jsobj.SetLeft(value);
value = jsobj.GetLeft();

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

Top

Attribute

Top

Identifier

R3WGA_Top

JavaScript type

Integer

C type

R3INT

Description

top edge

Syntax

jsobj.SetTop(value);
value = jsobj.GetTop();

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

Width

Attribute

Width

Identifier

R3WGA_Width

JavaScript type

Integer

C type

R3INT

Description

width of the widget

Syntax

jsobj.SetWidth(value);
value = jsobj.GetWidth();

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

Height

Attribute

Height

Identifier

R3WGA_Height

JavaScript type

Integer

C type

R3INT

Description

height of the widget

Syntax

jsobj.SetHeight(value);
value = jsobj.GetHeight();

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

MinWidth

Attribute

MinWidth

Identifier

R3WGA_MinWidth

JavaScript type

Integer

C type

R3INT

Description

minimum width

Syntax

jsobj.SetMinWidth(value);
value = jsobj.GetMinWidth();

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

MinHeight

Attribute

MinHeight

Identifier

R3WGA_MinHeight

JavaScript type

Integer

C type

R3INT

Description

min height

Syntax

jsobj.SetMinHeight(value);
value = jsobj.GetMinHeight();

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

RecommendedMinWidth

Attribute

RecommendedMinWidth

Identifier

R3WGA_RecommendedMinWidth

JavaScript type

Integer

C type

R3INT

Description

recommended width

Syntax

jsobj.SetRecommendedMinWidth(value);
value = jsobj.GetRecommendedMinWidth();

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

RecommendedMinHeight

Attribute

RecommendedMinHeight

Identifier

R3WGA_RecommendedMinHeight

JavaScript type

Integer

C type

R3INT

Description

recommended height

Syntax

jsobj.SetRecommendedMinHeight(value);
value = jsobj.GetRecommendedMinHeight();

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

AlignX

Attribute

AlignX

Identifier

R3WGA_AlignX

JavaScript type

Integer

C type

R3INT

Description

align position

Syntax

jsobj.SetAlignX(value);
value = jsobj.GetAlignX();

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

AlignY

Attribute

AlignY

Identifier

R3WGA_AlignY

JavaScript type

Integer

C type

R3INT

Description

align position

Syntax

jsobj.SetAlignY(value);
value = jsobj.GetAlignY();

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

Visible

Attribute

Visible

Identifier

R3WGA_Visible

JavaScript type

Boolean

C type

R3BOOL

Description

visible/invisible

Syntax

jsobj.SetVisible(value);
value = jsobj.GetVisible();

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

UserData

Attribute

UserData

Identifier

R3WGA_UserData

JavaScript type

String

C type

void*

Description

whaver user specific data

Syntax

jsobj.SetUserData(value);
value = jsobj.GetUserData();

void* value = ...;
R3SetAttrs(r3obj, R3WGA_UserData, value, R3TAG_END);
void* value;
R3GetAttrs(r3obj, R3WGA_UserData, &value, R3TAG_END);

Font

Attribute

Font

Identifier

R3WGA_Font

JavaScript type

Object

C type

R3OBJ*

Description

font for the widget

Syntax

jsobj.SetFont(value);
value = jsobj.GetFont();

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

ModelTag

Attribute

ModelTag

Identifier

R3WGA_ModelTag

JavaScript type

Integer

C type

R3INT

Description

tag of the model associated with this widget

Syntax

jsobj.SetModelTag(value);

R3INT value = ...;
R3SetAttrs(r3obj, R3WGA_ModelTag, value, R3TAG_END);

ModelMethod

Attribute

ModelMethod

Identifier

R3WGA_ModelMethod

JavaScript type

Integer

C type

R3INT

Description

method id of the model to be called by the widget

Syntax

jsobj.SetModelMethod(value);

R3INT value = ...;
R3SetAttrs(r3obj, R3WGA_ModelMethod, value, R3TAG_END);

FrameWidth

Attribute

FrameWidth

Identifier

R3WGA_FrameWidth

JavaScript type

Integer

C type

R3INT

Description

for uniform frame width

Syntax

jsobj.SetFrameWidth(value);
value = jsobj.GetFrameWidth();

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

FrameWidthLeft

Attribute

FrameWidthLeft

Identifier

R3WGA_FrameWidthLeft

JavaScript type

Integer

C type

R3INT

Description

frame width on the left side of the widget

Syntax

jsobj.SetFrameWidthLeft(value);
value = jsobj.GetFrameWidthLeft();

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

FrameWidthTop

Attribute

FrameWidthTop

Identifier

R3WGA_FrameWidthTop

JavaScript type

Integer

C type

R3INT

Description

frame width on the top edge

Syntax

jsobj.SetFrameWidthTop(value);
value = jsobj.GetFrameWidthTop();

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

FrameWidthRight

Attribute

FrameWidthRight

Identifier

R3WGA_FrameWidthRight

JavaScript type

Integer

C type

R3INT

Description

frame width on the right edge

Syntax

jsobj.SetFrameWidthRight(value);
value = jsobj.GetFrameWidthRight();

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

FrameWidthBottom

Attribute

FrameWidthBottom

Identifier

R3WGA_FrameWidthBottom

JavaScript type

Integer

C type

R3INT

Description

frame width on bottom

Syntax

jsobj.SetFrameWidthBottom(value);
value = jsobj.GetFrameWidthBottom();

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

SetOnChildren

Attribute

SetOnChildren

Identifier

R3WGA_SetOnChildren

JavaScript type

Boolean

C type

R3BOOL

Description

if TRUE propagate to children

Syntax

value = jsobj.GetSetOnChildren();

R3BOOL value;
R3GetAttrs(r3obj, R3WGA_SetOnChildren, &value, R3TAG_END);

Cursor

Attribute

Cursor

Identifier

R3WGA_Cursor

JavaScript type

Object

C type

R3OBJ*

Description

cursor object

Syntax

value = jsobj.GetCursor();

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

MsgPort

Attribute

MsgPort

Identifier

R3WGA_MsgPort

JavaScript type

Object

C type

R3OBJ*

Description

message port for the widget

Syntax

jsobj.SetMsgPort(value);
value = jsobj.GetMsgPort();

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

Menu

Attribute

Menu

Identifier

R3WGA_Menu

JavaScript type

Object

C type

R3OBJ*

Description

menu object for the widget

Syntax

jsobj.SetMenu(value);
value = jsobj.GetMenu();

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

AllParentsVisible

Attribute

AllParentsVisible

Identifier

R3WGA_AllParentsVisible

JavaScript type

Boolean

C type

R3BOOL

Description

win32 only

Syntax

value = jsobj.GetAllParentsVisible();

R3BOOL value;
R3GetAttrs(r3obj, R3WGA_AllParentsVisible, &value, R3TAG_END);

DragSourceObj

Attribute

DragSourceObj

Identifier

R3WGA_DragSourceObj

JavaScript type

Object

C type

R3OBJ*

Description

object for handling dragging

Syntax

jsobj.SetDragSourceObj(value);
value = jsobj.GetDragSourceObj();

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

DragSourceMth

Attribute

DragSourceMth

Identifier

R3WGA_DragSourceMth

JavaScript type

Integer

C type

R3INT

Description

method for handling dragging

Syntax

jsobj.SetDragSourceMth(value);
value = jsobj.GetDragSourceMth();

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

DragSourceData

Attribute

DragSourceData

Identifier

R3WGA_DragSourceData

JavaScript type

String

C type

void*

Description

whatever caller specific data, passed to 'sourceobj' in p3

Syntax

jsobj.SetDragSourceData(value);
value = jsobj.GetDragSourceData();

void* value = ...;
R3SetAttrs(r3obj, R3WGA_DragSourceData, value, R3TAG_END);
void* value;
R3GetAttrs(r3obj, R3WGA_DragSourceData, &value, R3TAG_END);

DropTargetObj

Attribute

DropTargetObj

Identifier

R3WGA_DropTargetObj

JavaScript type

Object

C type

R3OBJ*

Description

object for handling 'dropping'

Syntax

jsobj.SetDropTargetObj(value);
value = jsobj.GetDropTargetObj();

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

CanDropMth

Attribute

CanDropMth

Identifier

R3WGA_CanDropMth

JavaScript type

Integer

C type

R3INT

Description

query method

Syntax

jsobj.SetCanDropMth(value);
value = jsobj.GetCanDropMth();

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

DropMth

Attribute

DropMth

Identifier

R3WGA_DropMth

JavaScript type

Integer

C type

R3INT

Description

actual drop method

Syntax

jsobj.SetDropMth(value);
value = jsobj.GetDropMth();

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

DropTargetData

Attribute

DropTargetData

Identifier

R3WGA_DropTargetData

JavaScript type

String

C type

void*

Description

caller specific data

Syntax

jsobj.SetDropTargetData(value);
value = jsobj.GetDropTargetData();

void* value = ...;
R3SetAttrs(r3obj, R3WGA_DropTargetData, value, R3TAG_END);
void* value;
R3GetAttrs(r3obj, R3WGA_DropTargetData, &value, R3TAG_END);

Children

Attribute

Children

Identifier

R3WGA_Children

JavaScript type

r3List

C type

R3LIST*

Description

list of sub widgets

Syntax

value = jsobj.GetChildren();

R3LIST* value;
R3GetAttrs(r3obj, R3WGA_Children, &value, R3TAG_END);

Extension

Attribute

Extension

Identifier

R3WGA_Extension

JavaScript type

String

C type

void*

Description

whatever data, used for GUI editing

Syntax

jsobj.SetExtension(value);
value = jsobj.GetExtension();

void* value = ...;
R3SetAttrs(r3obj, R3WGA_Extension, value, R3TAG_END);
void* value;
R3GetAttrs(r3obj, R3WGA_Extension, &value, R3TAG_END);

DragSourceCancelMth

Attribute

DragSourceCancelMth

Identifier

R3WGA_DragSourceCancelMth

JavaScript type

Integer

C type

R3INT

Description

method that notifies the drag source object that dragging is cancelled

Syntax

jsobj.SetDragSourceCancelMth(value);
value = jsobj.GetDragSourceCancelMth();

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

DragSourceEndMth

Attribute

DragSourceEndMth

Identifier

R3WGA_DragSourceEndMth

JavaScript type

Integer

C type

R3INT

Description

method that notifies the drag source object that dragging has ended

Syntax

jsobj.SetDragSourceEndMth(value);
value = jsobj.GetDragSourceEndMth();

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

Manager

Attribute

Manager

Identifier

R3WGA_Manager

JavaScript type

Object

C type

R3OBJ*

Description

a widget managing this one

Syntax

jsobj.SetManager(value);
value = jsobj.GetManager();

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

Realized

Attribute

Realized

Identifier

R3WGA_Realized

JavaScript type

Boolean

C type

R3BOOL

Description

true if realized

Syntax

value = jsobj.GetRealized();

R3BOOL value;
R3GetAttrs(r3obj, R3WGA_Realized, &value, R3TAG_END);

DropBySiblingMth

Attribute

DropBySiblingMth

Identifier

R3WGA_DropBySiblingMth

JavaScript type

Integer

C type

R3INT

Description

actual drop by sibling method

Syntax

jsobj.SetDropBySiblingMth(value);
value = jsobj.GetDropBySiblingMth();

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

Orientation

Attribute

Orientation

Identifier

R3WGA_Orientation

JavaScript type

Integer

C type

R3INT

Description

see orientation codes below

Syntax

jsobj.SetOrientation(value);
value = jsobj.GetOrientation();

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

ExpandX

Attribute

ExpandX

Identifier

R3WGA_ExpandX

JavaScript type

Boolean

C type

R3BOOL

Description

true if the gadget expands in the x-direction (width)

Syntax

jsobj.SetExpandX(value);
value = jsobj.GetExpandX();

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

ExpandY

Attribute

ExpandY

Identifier

R3WGA_ExpandY

JavaScript type

Boolean

C type

R3BOOL

Description

true if the gadget expands in the y-direction (height)

Syntax

jsobj.SetExpandY(value);
value = jsobj.GetExpandY();

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

AutoOrientate

Attribute

AutoOrientate

Identifier

R3WGA_AutoOrientate

JavaScript type

Boolean

C type

R3BOOL

Description

if TRUE orientates children according to its own orientation

Syntax

jsobj.SetAutoOrientate(value);
value = jsobj.GetAutoOrientate();

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

OffsetX

Attribute

OffsetX

Identifier

R3WGA_OffsetX

JavaScript type

Integer

C type

R3INT

Description

offset in x

Syntax

jsobj.SetOffsetX(value);
value = jsobj.GetOffsetX();

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

OffsetY

Attribute

OffsetY

Identifier

R3WGA_OffsetY

JavaScript type

Integer

C type

R3INT

Description

offset in y

Syntax

jsobj.SetOffsetY(value);
value = jsobj.GetOffsetY();

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

ModelIndex

Attribute

ModelIndex

Identifier

R3WGA_ModelIndex

JavaScript type

Integer

C type

R3INT

Description

index of the indexed tag of the model associated with this widget

Syntax

jsobj.SetModelIndex(value);

R3INT value = ...;
R3SetAttrs(r3obj, R3WGA_ModelIndex, value, R3TAG_END);

FitCode

Attribute

FitCode

Identifier

R3WGA_FitCode

JavaScript type

Integer

C type

R3INT

Description

see R3WGM_ fit codes

Syntax

jsobj.SetFitCode(value);
value = jsobj.GetFitCode();

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

DynamicExpandX

Attribute

DynamicExpandX

Identifier

R3WGA_DynamicExpandX

JavaScript type

Boolean

C type

R3BOOL

Description

true if gadget can be expanded in x, class implementors only

Syntax

jsobj.SetDynamicExpandX(value);
value = jsobj.GetDynamicExpandX();

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

DynamicExpandY

Attribute

DynamicExpandY

Identifier

R3WGA_DynamicExpandY

JavaScript type

Boolean

C type

R3BOOL

Description

true if gadget can be expanded in y

Syntax

jsobj.SetDynamicExpandY(value);
value = jsobj.GetDynamicExpandY();

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

HelpURL

Attribute

HelpURL

Identifier

R3WGA_HelpURL

JavaScript type

String

C type

char*

Description

help topic in reference manual

Syntax

jsobj.SetHelpURL(value);
value = jsobj.GetHelpURL();

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

AlignXOffset

Attribute

AlignXOffset

Identifier

R3WGA_AlignXOffset

JavaScript type

Integer

C type

R3INT

Description

align point in x, for class implementors

Syntax

jsobj.SetAlignXOffset(value);

R3INT value = ...;
R3SetAttrs(r3obj, R3WGA_AlignXOffset, value, R3TAG_END);

AlignYOffset

Attribute

AlignYOffset

Identifier

R3WGA_AlignYOffset

JavaScript type

Integer

C type

R3INT

Description

align point in y, for class implementors

Syntax

jsobj.SetAlignYOffset(value);

R3INT value = ...;
R3SetAttrs(r3obj, R3WGA_AlignYOffset, value, R3TAG_END);

R3WGEXPAND_WIDTH

R3WGEXPAND_HEIGHT

Tags

R3WGA_MapToObj

R3WGA_MapFromTag

R3WGA_MapToTag

R3WGA_MapToMethod