r3root

Class

oops/r3root.h

Library

r3oops

Description:

The base class for realsoft objects.

See Also

Super Class

-

JavaScript

r3Root

Class Identifier

R3CLID_ROOT - 0

Methods

CREATE, DELETE, SETCLATTR, GETCLATTR, SET, GET, READ, WRITE, UPDATE, REF, UNREF, ADDHEAD, ADDTAIL, REMOVE, OOENUM, MAKETAGLIST, FREETAGLIST, NAMEFORTAG, TRANSFORM, COPY, ASSIGN, LOADOBJECT, GETSTR, ENUMSUBCLASSES, FREECACHE, SETINDEXED, GETINDEXED, ISOFKIND, ISYOURTAG, INSERT, FINDTAGDESCR, FINDTAGDESCRBYNAME, GETPUBATTR, SETPUBATTR, FINDINDEXEDTAGDESCR, NAMEFORINDEXEDTAG,

Attributes

Hook, Error, Name, ClassID, InstanceSize, SysObject, Next, Previous, HookData, List, Self, StaticName, Version, RefCount, Dispatcher, Icon,

Registration

int R3RegisterRootClass(R3APP *app);

R3RM_CREATE

Method

CREATE

Identifier

R3RM_CREATE

Return

R3OBJ*, address of the created object

Param 3:

R3TAG*, default attributes for the instance to be created

JavaScript

rc = obj.CREATE(p3);

Description

Creates a new instance.

R3RM_DELETE

Method

DELETE

Identifier

R3RM_DELETE

JavaScript

obj.DELETE();

Description

Deletes an object (destructor). See R3ObjectDelete() shield.

R3RM_SETCLATTR

Method

SETCLATTR

Identifier

R3RM_SETCLATTR

Param 3:

R3TAG*, tag list specifying attributes and values to be set.

JavaScript

obj.SETCLATTR(p3);

Description

Set one or more class attributes. See R3SetClassAttrs()

R3RM_GETCLATTR

Method

GETCLATTR

Identifier

R3RM_GETCLATTR

Param 3:

R3TAG*, tags list specifying attributes to be fecthed

JavaScript

obj.GETCLATTR(p3);

Description

Fetch class attributes

R3RM_SET

Method

SET

Identifier

R3RM_SET

Param 3:

R3TAG*, tag list specifying attributes and values to be set

JavaScript

obj.SET(p3);

Description

Set object attributes

R3RM_GET

Method

GET

Identifier

R3RM_GET

Return

R3TAG*, NULL if all tags were recognized, otherwise address of the unrecognized tag.

Param 3:

R3TAG*, tag list specifying attributes/storages.

JavaScript

rc = obj.GET(p3);

Description

Fetch one or more object attributes

R3RM_READ

Method

READ

Identifier

R3RM_READ

Return

R3BOOL, FALSE if failed, R3RA_Error, can be used for fetching the error code

Param 3:

R3TAG*, tag list specifying the file object and address for the error code:

JavaScript

rc = obj.READ(p3);

Description

Tells object to read its attributes from a file. If the class of the file is R3CLID_IFF, automatic crossplatform conversion is applied.

R3RM_WRITE

Method

WRITE

Identifier

R3RM_WRITE

Return

R3BOOL, NULL if write failed

Param 3:

R3TAG*, tag list (R3RA_FileObject, R3RA_Error).

JavaScript

rc = obj.WRITE(p3);

Description

Tells an object to write its attributes to a file

R3RM_UPDATE

Method

UPDATE

Identifier

R3RM_UPDATE

Param 1:

void*, new value, the type of the value depends on the attribute in question

Param 3:

R3INT, model's attribute that has changed

JavaScript

obj.UPDATE(p1, p3);

Description

This method is defined by the root class althought its up to the sub classes to implement it. For more information, see model-view concept.

R3RM_REF

Method

REF

Identifier

R3RM_REF

JavaScript

obj.REF();

Description

Increments objects reference count. By default, the reference count is zero.

R3RM_UNREF

Method

UNREF

Identifier

R3RM_UNREF

Return

R3OBJ*, NULL if object was deleted

JavaScript

rc = obj.UNREF();

Description

Decrements objects reference count. When reference count drops to zero, the object is deleted.

R3RM_ADDHEAD

Method

ADDHEAD

Identifier

R3RM_ADDHEAD

Param 3:

R3LIST, list

JavaScript

obj.ADDHEAD(p3);

Description

Tells an object to link itself at the head of a list.

R3RM_ADDTAIL

Method

ADDTAIL

Identifier

R3RM_ADDTAIL

Param 3:

R3LIST, list

JavaScript

obj.ADDTAIL(p3);

Description

Tells an object ot link itself to the end of a list

R3RM_REMOVE

Method

REMOVE

Identifier

R3RM_REMOVE

Param 3:

R3LIST, list

JavaScript

obj.REMOVE(p3);

Description

Removes an object from a list

R3RM_OOENUM

Method

OOENUM

Identifier

R3RM_OOENUM

Return

void*, return value from the called object.

Param 3:

R3TAG*, R3RA_TargetObject, R3RA_TargetMethod

JavaScript

rc = obj.OOENUM(p3);

Description

Enumerate object.

R3RM_MAKETAGLIST

Method

MAKETAGLIST

Identifier

R3RM_MAKETAGLIST

Param 3:

R3LIST, list containing R3TAGLISTNODE structures

JavaScript

obj.MAKETAGLIST(p3);

Description

Fetch the public attribute list.

R3RM_FREETAGLIST

Method

FREETAGLIST

Identifier

R3RM_FREETAGLIST

Param 3:

R3LIST, list containing R3TAGLISTNODE structures by R3RM_MAKETAGLIST.

JavaScript

obj.FREETAGLIST(p3);

Description

Free the public attribute list

R3RM_NAMEFORTAG

Method

NAMEFORTAG

Identifier

R3RM_NAMEFORTAG

Return

R3BOOL, true if found.

Param 1:

R3INT, attribute identifier

Param 3:

char*, buffer for the name

JavaScript

rc = obj.NAMEFORTAG(p1, p3);

Description

Fetch the name for the given attribute.

R3RM_TRANSFORM

Method

TRANSFORM

Identifier

R3RM_TRANSFORM

JavaScript

obj.TRANSFORM();

Description

This method is defined by the root class but implemented by the sub classes.

R3RM_COPY

Method

COPY

Identifier

R3RM_COPY

Return

R3OBJ*, an address of the duplicate

JavaScript

rc = obj.COPY();

Description

Makes a copy of an object

R3RM_ASSIGN

Method

ASSIGN

Identifier

R3RM_ASSIGN

Param 3:

R3OBJ*, address of the object from which the attributes should be read

JavaScript

obj.ASSIGN(p3);

Description

Tells an object to read all its attributes from the given object. Note: only those attributes are assigned which are common to the both objects.

R3RCM_LOADOBJECT

Method

LOADOBJECT

Identifier

R3RCM_LOADOBJECT

Return

R3OBJ*, address of the loaded object or NULL if failed

Param 3:

R3TAG*, attributes for the object to be loaded.

JavaScript

rc = obj.LOADOBJECT(p3);

Description

Reads on object from the given file. FIrst, root attributes (such as the class id) are read. The root class then creates an instance of that class and sends R3RM_READ method to the instance.

R3RCM_GETSTR

Method

GETSTR

Identifier

R3RCM_GETSTR

Param 3:

R3INT, string identifier. See localization examples

JavaScript

obj.GETSTR(p3);

Description

Fetches a localized string corresponding the given string id.

R3RCM_ENUMSUBCLASSES

Method

ENUMSUBCLASSES

Identifier

R3RCM_ENUMSUBCLASSES

Param 1:

R3OBJ*, object to be called as R3SendMsgA3((R3OBJ *)p1, (R3INT)p2, (R3CLASS *)super, (R3CLAS *)class, (void *)p3);

Param 2:

R3INT, method for the callback object

Param 3:

void*, whatever user data for the callback object.

JavaScript

obj.ENUMSUBCLASSES(p1, p2, p3);

Description

Enumerates sub class of the given class (non-recursive)

R3RCM_FREECACHE

Method

FREECACHE

Identifier

R3RCM_FREECACHE

JavaScript

obj.FREECACHE();

Description

Sent to each class at close down. The class should free all objects allocated, * e.g. window cache.

R3RM_SETINDEXED

Method

SETINDEXED

Identifier

R3RM_SETINDEXED

JavaScript

obj.SETINDEXED();

Description

Set an indexed object attribute

R3RM_GETINDEXED

Method

GETINDEXED

Identifier

R3RM_GETINDEXED

JavaScript

obj.GETINDEXED();

Description

Get an indexed object attribute

R3RM_ISOFKIND

Method

ISOFKIND

Identifier

R3RM_ISOFKIND

Return

R3INT, 0 if the given class id doesn't match any of the classes of the given object. Otherwise positive integer is returned indicating the 'level' at which the match was found. Return value of 1 means that the given class is the 'true class' of the object. The return value of 2 indicates that the given class id is the super class of the object etc.

Param 3:

R3CLID, class id to be checked

JavaScript

rc = obj.ISOFKIND(p3);

Description

Compares the given class id agains the class ids of the object.

R3RM_ISYOURTAG

Method

ISYOURTAG

Identifier

R3RM_ISYOURTAG

Return

R3BOOL, true if object recognizes the tag

Param 3:

R3INT, tag identifier

JavaScript

rc = obj.ISYOURTAG(p3);

Description

Asks if the given method or attribute is defined by the object.

R3RM_INSERT

Method

INSERT

Identifier

R3RM_INSERT

Return

R3BOOL, true if 'prev' node was found

Param 1:

R3BOOL, don't send R3MM_CHANGED

Param 2:

R3OBJ*, previous object in the list

Param 3:

R3LIST, list

JavaScript

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

Description

Insert the object to a given list after the given 'prev' node

R3RM_FINDTAGDESCR

Method

FINDTAGDESCR

Identifier

R3RM_FINDTAGDESCR

Return

R3BOOL, true if tag was found.

Param 1:

R3INT, tag to be fetched

Param 2:

R3LIST, tags fetched by calling R3RM_MAKETAGLIST. If null, maketaglist and freetaglits methods are called internally.

JavaScript

rc = obj.FINDTAGDESCR(p1, p2, 0);

Description

Fetch tag descriptor (R3TAGNAME) data for the given tag id.

R3RM_FINDTAGDESCRBYNAME

Method

FINDTAGDESCRBYNAME

Identifier

R3RM_FINDTAGDESCRBYNAME

Return

R3BOOL, true if found

Param 1:

char*, name of the attribute to be found

JavaScript

rc = obj.FINDTAGDESCRBYNAME(p1, 0);

Description

Find tag descriptor by name

R3RM_GETPUBATTR

Method

GETPUBATTR

Identifier

R3RM_GETPUBATTR

Return

R3OBJ*, object whose attribute was referred

Param 1:

char*, hierarhcial name identifying the attribute

Param 3:

void*, buffer for the value

JavaScript

rc = obj.GETPUBATTR(p1, p3);

Description

Fetch public attribute by hierarhical name. The method returns the value and specification by using the FINDTAGDESCRBYNAME method.

R3RM_SETPUBATTR

Method

SETPUBATTR

Identifier

R3RM_SETPUBATTR

Return

R3OBJ*, object whose attribute was referred

Param 1:

char*, hierarhcial name identifying the attribute

Param 3:

void*, buffer for the value

JavaScript

rc = obj.SETPUBATTR(p1, p3);

Description

Set public attribute. This uses FINDTAGDESCRBYNAME method.

R3RM_FINDINDEXEDTAGDESCR

Method

FINDINDEXEDTAGDESCR

Identifier

R3RM_FINDINDEXEDTAGDESCR

Return

R3BOOL, true if found

Param 1:

R3INT, tag

Param 2:

R3INT, index,

JavaScript

rc = obj.FINDINDEXEDTAGDESCR(p1, p2, 0);

Description

Find tag description for indexed tag.

R3RM_NAMEFORINDEXEDTAG

Method

NAMEFORINDEXEDTAG

Identifier

R3RM_NAMEFORINDEXEDTAG

Return

R3BOOL, true if found

Param 1:

R3INT, tag

Param 2:

R3INT, index,

Param 3:

char*, buffer for tag name

JavaScript

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

Description

Find name for indexed tag.

Hook

Attribute

Hook

Identifier

R3RA_Hook

JavaScript type

String

C type

void*

Description

callback or hook for whatever usage

Syntax

jsobj.SetHook(value);
value = jsobj.GetHook();

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

Error

Attribute

Error

Identifier

R3RA_Error

JavaScript type

Integer

C type

R3INT

Description

for passing error codes to caller

Syntax

jsobj.SetError(value);
value = jsobj.GetError();

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

Name

Attribute

Name

Identifier

R3RA_Name

JavaScript type

String

C type

char*

Description

object's name

Syntax

jsobj.SetName(value);
value = jsobj.GetName();

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

ClassID

Attribute

ClassID

Identifier

R3RA_ClassID

JavaScript type

Integer

C type

R3INT

Description

objects classid

Syntax

jsobj.SetClassID(value);
value = jsobj.GetClassID();

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

InstanceSize

Attribute

InstanceSize

Identifier

R3RA_InstanceSize

JavaScript type

Integer

C type

R3INT

Description

instance size

Syntax

value = jsobj.GetInstanceSize();

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

SysObject

Attribute

SysObject

Identifier

R3RA_SysObject

JavaScript type

String

C type

void*

Description

OS specific object associated with V4 object

Syntax

jsobj.SetSysObject(value);
value = jsobj.GetSysObject();

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

Next

Attribute

Next

Identifier

R3RA_Next

JavaScript type

Object

C type

R3OBJ*

Description

next object in a list

Syntax

jsobj.SetNext(value);
value = jsobj.GetNext();

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

Previous

Attribute

Previous

Identifier

R3RA_Previous

JavaScript type

Object

C type

R3OBJ*

Description

Syntax

jsobj.SetPrevious(value);
value = jsobj.GetPrevious();

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

HookData

Attribute

HookData

Identifier

R3RA_HookData

JavaScript type

String

C type

void*

Description

for callbacks

Syntax

jsobj.SetHookData(value);
value = jsobj.GetHookData();

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

List

Attribute

List

Identifier

R3RA_List

JavaScript type

r3List

C type

R3LIST*

Description

for R3RM_ADDHEAD/TAIL methods

Syntax

jsobj.SetList(value);

R3LIST* value = ...;
R3SetAttrs(r3obj, R3RA_List, value, R3TAG_END);

Self

Attribute

Self

Identifier

R3RA_Self

JavaScript type

Object

C type

R3OBJ*

Description

whenever objects needs to pass its address to someone

Syntax

value = jsobj.GetSelf();

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

StaticName

Attribute

StaticName

Identifier

R3RA_StaticName

JavaScript type

String

C type

char*

Description

'R3RA_StaticName' not documented

Syntax

jsobj.SetStaticName(value);
value = jsobj.GetStaticName();

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

Version

Attribute

Version

Identifier

R3RA_Version

JavaScript type

Integer

C type

R3INT

Description

version number of the object's class

Syntax

value = jsobj.GetVersion();

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

RefCount

Attribute

RefCount

Identifier

R3RA_RefCount

JavaScript type

Integer

C type

R3INT

Description

read only, use REF and UNREF methods for changing refcount

Syntax

jsobj.SetRefCount(value);
value = jsobj.GetRefCount();

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

Dispatcher

Attribute

Dispatcher

Identifier

R3RA_Dispatcher

JavaScript type

String

C type

void*

Description

void *(*)(R3CLASS *, R3OBJ *, R3INT, void *, void *, void*) , same as R3RCA_Dispatcher, but can be asked from object as well

Syntax

jsobj.SetDispatcher(value);
value = jsobj.GetDispatcher();

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

Icon

Attribute

Icon

Identifier

R3RA_Icon

JavaScript type

Object

C type

R3OBJ*

Description

class specific icon object. May be NULL

Syntax

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

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

R3LEN_INSTANCENAME

R3TNF_USERDEFINED

R3TNF_ANIMATEABLE

R3TNF_COPYSTRING

R3TNF_INDEXED

R3TNF_ARRAY

R3TNF_LIST

R3TNF_READONLY

R3TNF_PERPOINT

R3TNF_HPT

R3TNF_BYVALUE

R3TN_USERDEFINED

R3TN_ANIMATEABLE

R3TN_COPYSTRING

Tags

R3RA_FileObject

R3RA_TargetObject

R3RA_BusyHook

R3RA_SenderObject

R3RA_TargetMethod

R3RA_LoadCreateTags

R3RA_P0

R3RA_P1

R3RA_P2

R3RA_P3

R3RA_P4

R3RA_P5

R3RA_P6

R3RA_P7

R3RA_P8

R3RA_P9

R3RA_TargetClass

R3RA_FileVersion

R3RA_FileRevision

R3RA_LoadReplace