r3dropto

Class

real/widget/r3dropto.h

Library

r3wid

Description:

Drop Tool Class

See Also

oops/r3root.h

Super Class

r3Root

R3CLID_ROOT

JavaScript

r3Droptool

Class Identifier

R3CLID_DROPTOOL - 869

Methods

CREATEDROPOBJECT, INSTALLTOOLCLAS, INSTALLTOOLGROU, INACTIVATE, INSTALLIO, WRITECREATEONLY, WRITEATTRIBUTES, READCREATEONLYA, FREECREATEONLYA, READATTRIBUTES, CREATEREADOBJEC, LOAD, SAVE, FINDIOHANDLER, RELEASE, SETEDITMODE, EDIT, EXTENSIONEVENT, EXTENSIONDRAGEV, GETFREEDOM, REGISTERGADGETC, GETGADGETCLID, DELETE, CREATEUNIQUENAM, SKIP,

Attributes

Button, Controls, StatusControls, Active, RootWindow, LayerList, Group,

Registration

int R3RegisterDropToolClass(R3APP *app);

R3DROPTOOLM_CREATEDROPOBJECT

Method

CREATEDROPOBJECT

Identifier

R3DROPTOOLM_CREATEDROPOBJECT

Return

R3BOOL, must be true.

Param 1:

R3CLID, class id of the drop object to be created.

Param 2:

R3OBJ*, window where the drop object will be inserted.

Param 3:

R3TAG*, tags (R3DRPTGTWA_DropType, R3DRPTGTWA_DropData)

JavaScript

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

Description

Creates a drop object.

R3DROPTOOLCM_INSTALLTOOLCLAS

Method

INSTALLTOOLCLAS

Identifier

R3DROPTOOLCM_INSTALLTOOLCLAS

Return

R3BOOL, true if succeeded

Param 1:

R3CLID, class id of the tool group

Param 3:

R3CLID, class id of the tool

JavaScript

rc = obj.INSTALLTOOLCLAS(p1, p3);

Description

Class message. Install new drop tool.

R3DROPTOOLCM_INSTALLTOOLGROU

Method

INSTALLTOOLGROU

Identifier

R3DROPTOOLCM_INSTALLTOOLGROU

Return

R3BOOL, true if succeeded.

Param 1:

R3CLID, class id of the group

Param 3:

char*, symbolic name for the group.

JavaScript

rc = obj.INSTALLTOOLGROU(p1, p3);

Description

Class method. Install new tool group.

R3DROPTOOLM_INACTIVATE

Method

INACTIVATE

Identifier

R3DROPTOOLM_INACTIVATE

JavaScript

obj.INACTIVATE();

Description

Send to a droptool when it is activated/inactivated.

R3DROPTOOLCM_INSTALLIO

Method

INSTALLIO

Identifier

R3DROPTOOLCM_INSTALLIO

JavaScript

obj.INSTALLIO();

Description

Install IO methods for a certain

R3DROPTOOLCM_WRITECREATEONLY

Method

WRITECREATEONLY

Identifier

R3DROPTOOLCM_WRITECREATEONLY

JavaScript

obj.WRITECREATEONLY();

Description

Writes the create-only attributes

R3DROPTOOLCM_WRITEATTRIBUTES

Method

WRITEATTRIBUTES

Identifier

R3DROPTOOLCM_WRITEATTRIBUTES

JavaScript

obj.WRITEATTRIBUTES();

Description

Writes the attributes

R3DROPTOOLCM_READCREATEONLYA

Method

READCREATEONLYA

Identifier

R3DROPTOOLCM_READCREATEONLYA

JavaScript

obj.READCREATEONLYA();

Description

Read the create-only attributes for a gui object. * Adds a R3CREATEATTRIBUTENODE node to the create attribute list.

R3DROPTOOLCM_FREECREATEONLYA

Method

FREECREATEONLYA

Identifier

R3DROPTOOLCM_FREECREATEONLYA

JavaScript

obj.FREECREATEONLYA();

Description

Free the create only attributes allocated in the * R3DROPTOOLCM_READCREATEONLYATTRIBUTES method.

R3DROPTOOLCM_READATTRIBUTES

Method

READATTRIBUTES

Identifier

R3DROPTOOLCM_READATTRIBUTES

JavaScript

obj.READATTRIBUTES();

Description

Read attributes for the gui object given as parameter

R3DROPTOOLCM_CREATEREADOBJEC

Method

CREATEREADOBJEC

Identifier

R3DROPTOOLCM_CREATEREADOBJEC

JavaScript

obj.CREATEREADOBJEC();

Description

Create a gui object, whose create-only attributes have been read using the R3DROPTOOLCM_READCREATEONLYATTRIBUTES method.

R3DROPTOOLCM_LOAD

Method

LOAD

Identifier

R3DROPTOOLCM_LOAD

JavaScript

obj.LOAD();

Description

Load a gui object, whose clid is given as parameter

R3DROPTOOLCM_SAVE

Method

SAVE

Identifier

R3DROPTOOLCM_SAVE

JavaScript

obj.SAVE();

Description

Save gui object

R3DROPTOOLCM_FINDIOHANDLER

Method

FINDIOHANDLER

Identifier

R3DROPTOOLCM_FINDIOHANDLER

JavaScript

obj.FINDIOHANDLER();

Description

Find the io handler class for an object class

R3DROPTOOLCM_RELEASE

Method

RELEASE

Identifier

R3DROPTOOLCM_RELEASE

JavaScript

obj.RELEASE();

Description

Do anything necessary to remove an object from a gui hierarchy

R3DROPTOOLCM_SETEDITMODE

Method

SETEDITMODE

Identifier

R3DROPTOOLCM_SETEDITMODE

Param 1:

R3OBJ*, object

Param 2:

R3INT, true if set false is reset.

Param 3:

R3TAG*, tag list

JavaScript

obj.SETEDITMODE(p1, p2, p3);

Description

Set/reset GUI editing mode

R3DROPTOOLCM_EDIT

Method

EDIT

Identifier

R3DROPTOOLCM_EDIT

JavaScript

obj.EDIT();

Description

Open a window for editing an earlier dropped widget

R3DROPTOOLCM_EXTENSIONEVENT

Method

EXTENSIONEVENT

Identifier

R3DROPTOOLCM_EXTENSIONEVENT

JavaScript

obj.EXTENSIONEVENT();

Description

Event from the extension window

R3DROPTOOLCM_EXTENSIONDRAGEV

Method

EXTENSIONDRAGEV

Identifier

R3DROPTOOLCM_EXTENSIONDRAGEV

JavaScript

obj.EXTENSIONDRAGEV();

Description

Event from the extension window when dragging

R3DROPTOOLCM_GETFREEDOM

Method

GETFREEDOM

Identifier

R3DROPTOOLCM_GETFREEDOM

JavaScript

obj.GETFREEDOM();

Description

Gets freedom flags for a widget.

R3DROPTOOLCM_REGISTERGADGETC

Method

REGISTERGADGETC

Identifier

R3DROPTOOLCM_REGISTERGADGETC

Return

R3BOOL, true if succeeded.

Param 1:

R3CLID, class id of the droppable object

Param 3:

R3CLID, class id of the gadget

JavaScript

rc = obj.REGISTERGADGETC(p1, p3);

Description

Class method. Registers a gadget class for a droppable object.

R3DROPTOOLCM_GETGADGETCLID

Method

GETGADGETCLID

Identifier

R3DROPTOOLCM_GETGADGETCLID

Return

R3CLID, class id of the gadget class

Param 3:

R3CLID, class id of the droppable object

JavaScript

rc = obj.GETGADGETCLID(p3);

Description

Class method. Returns gadget clid for a droppable object clid.

R3DROPTOOLCM_DELETE

Method

DELETE

Identifier

R3DROPTOOLCM_DELETE

JavaScript

obj.DELETE();

Description

Delete the given object.

R3DROPTOOLCM_CREATEUNIQUENAM

Method

CREATEUNIQUENAM

Identifier

R3DROPTOOLCM_CREATEUNIQUENAM

JavaScript

obj.CREATEUNIQUENAM();

Description

creates a unique name for a gui object to be created

R3DROPTOOLCM_SKIP

Method

SKIP

Identifier

R3DROPTOOLCM_SKIP

JavaScript

obj.SKIP();

Description

Skip a gui object that can not be read.

Button

Attribute

Button

Identifier

R3DROPTOOLA_Button

JavaScript type

String

C type

void*

Description

button for the toolbar, must be given by the subclass

Syntax

value = jsobj.GetButton();

void* value;
R3GetAttrs(r3obj, R3DROPTOOLA_Button, &value, R3TAG_END);

Controls

Attribute

Controls

Identifier

R3DROPTOOLA_Controls

JavaScript type

String

C type

void*

Description

geom. manager containing controls for the second line of the toolbar

Syntax

value = jsobj.GetControls();

void* value;
R3GetAttrs(r3obj, R3DROPTOOLA_Controls, &value, R3TAG_END);

StatusControls

Attribute

StatusControls

Identifier

R3DROPTOOLA_StatusControls

JavaScript type

String

C type

void*

Description

geom. manager containing controls for the status bar

Syntax

value = jsobj.GetStatusControls();

void* value;
R3GetAttrs(r3obj, R3DROPTOOLA_StatusControls, &value, R3TAG_END);

Active

Attribute

Active

Identifier

R3DROPTOOLA_Active

JavaScript type

Integer

C type

int

Description

'R3DROPTOOLA_Active' not documented

Syntax

jsobj.SetActive(value);
value = jsobj.GetActive();

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

RootWindow

Attribute

RootWindow

Identifier

R3DROPTOOLA_RootWindow

JavaScript type

Object

C type

R3OBJ*

Description

main window

Syntax

jsobj.SetRootWindow(value);
value = jsobj.GetRootWindow();

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

LayerList

Attribute

LayerList

Identifier

R3DROPTOOLA_LayerList

JavaScript type

Object

C type

R3OBJ*

Description

layer list

Syntax

jsobj.SetLayerList(value);
value = jsobj.GetLayerList();

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

Group

Attribute

Group

Identifier

R3DROPTOOLA_Group

JavaScript type

Integer

C type

R3INT

Description

unique group identifier registered with r3dsrwin/R3DSRWCM_REGISTERGROUP

Syntax

value = jsobj.GetGroup();

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

R3DROPTOOL_MAXTOOLCOUNT

R3DROPTOOL_MAXGROUPCOUNT

R3DROPTOOLACTIVE_EDIT

R3DROPTOOLACTIVE_DELETE

R3DROPTOOLACTIVE_DRAG

R3DROPTOOLACTIVE_DROP

R3DROPTOOLACTIVE_SAVE

R3DROPTOOLACTIVE_REPLACE

R3DROPTOOLACTIVE_SPLITVERTICAL

R3DROPTOOLACTIVE_SPLITHORIZONTAL

R3DT_TEMPORARYFILENAME

Tags

R3DROPTOOLA_Window

R3DROPTOOLA_CtrlWindow

R3DROPTOOLA_StatusWindow

R3DROPTOOLA_Parent

R3DROPTOOLA_Manager

R3DROPTOOLA_EventObject

R3DROPTOOLA_ActiveFlags

R3DROPTOOLA_ClidVersions

R3DROPTOOLA_CreateAttributeList

R3DROPTOOLA_NoName

R3DROPTOOLA_SeparateWindow