r3maccl

Class

real/code/r3maccl.h

Library

r3code

Description:

Macro model class.

See Also

oops/r3model.h

See Also

oops/r3vect.h oops/r3vect.h oops/r3color.h oops/r3coords.h

Super Class

r3Model

R3CLID_MODEL

JavaScript

r3Maccl

Class Identifier

R3CLID_MACCL - 101

Methods

PLAY, EXECSNDMSG, REGISTERTARGET, UNREGISTERTARGET, BIND, BINDDELETE, MACRODELETE, PLAYKEY, IMPORTMACROS, ENUMMACROS, ENUMBINDINGS, ENUMMACEVENTS, ADDMACEVENT, ADDBINDING, PLAYNAMED, SETMACROTARGETSTATE, GETMACROTARGETSTATE, ENUMTARGETS, FINDNAMEDMACRO, FINDTARGET,

Attributes

Pause, RecordMode, MacroName, KeyName, MacroList, MacroListSelection, BindingsList, BindingsListSelection, CurrentList,

R3MCM_PLAY

Method

PLAY

Identifier

R3MCM_PLAY

Return

R3BOOL, true of current macro was defined

Param 3:

R3INT, repeat count

JavaScript

rc = obj.PLAY(p3);

Description

Execute the current macro.

R3MCM_EXECSNDMSG

Method

EXECSNDMSG

Identifier

R3MCM_EXECSNDMSG

Return

R3BOOL, true if succeeded

JavaScript

rc = obj.EXECSNDMSG();

Description

Add macro description to the current macro and execute it.

R3MCM_REGISTERTARGET

Method

REGISTERTARGET

Identifier

R3MCM_REGISTERTARGET

Return

R3BOOL, true if succeeded

JavaScript

rc = obj.REGISTERTARGET();

Description

Register new macro target.

R3MCM_UNREGISTERTARGET

Method

UNREGISTERTARGET

Identifier

R3MCM_UNREGISTERTARGET

Return

R3BOOL, true if found

Param 3:

R3TAG*, R3MCT_TargetName, R3MCT_TargetGetFrom, R3MCT_TargetGetMethod

JavaScript

rc = obj.UNREGISTERTARGET(p3);

Description

Unregister macro target.

R3MCM_BIND

Method

BIND

Identifier

R3MCM_BIND

Return

R3BOOL, true if succeeded

JavaScript

rc = obj.BIND();

Description

Bind currently selected named macro to current key.

R3MCM_BINDDELETE

Method

BINDDELETE

Identifier

R3MCM_BINDDELETE

Return

R3BOOL, true if succeeded

JavaScript

rc = obj.BINDDELETE();

Description

Delete currently selected macro binding

R3MCM_MACRODELETE

Method

MACRODELETE

Identifier

R3MCM_MACRODELETE

JavaScript

obj.MACRODELETE();

Description

Delete the currently selected macro. All key bindings associated * with the macro are deleted as well.

R3MCM_PLAYKEY

Method

PLAYKEY

Identifier

R3MCM_PLAYKEY

Return

R3BOOL, TRUE if macro was found

Param 1:

R3INT, how many times

Param 3:

char*, string defining key

JavaScript

rc = obj.PLAYKEY(p1, p3);

Description

Execute macro bound to a given key

R3MCM_IMPORTMACROS

Method

IMPORTMACROS

Identifier

R3MCM_IMPORTMACROS

JavaScript

obj.IMPORTMACROS();

Description

R3MCM_ENUMMACROS

Method

ENUMMACROS

Identifier

R3MCM_ENUMMACROS

Param 1:

R3OBJ*, object to be called

Param 3:

R3INT, method identifier for the object to be called

JavaScript

obj.ENUMMACROS(p1, p3);

Description

Enumerate named macros.

R3MCM_ENUMBINDINGS

Method

ENUMBINDINGS

Identifier

R3MCM_ENUMBINDINGS

Param 1:

R3OBJ*, object to be called

Param 3:

R3INT, method for the object to be called

JavaScript

obj.ENUMBINDINGS(p1, p3);

Description

Enumerate macro - key bindings. The given object * will be called as R3DoA(p1, p2, (R3BINDING *)p3);

R3MCM_ENUMMACEVENTS

Method

ENUMMACEVENTS

Identifier

R3MCM_ENUMMACEVENTS

Param 1:

R3OBJ*, object to be called

Param 2:

R3INT, callback method

JavaScript

obj.ENUMMACEVENTS(p1, p2, 0);

Description

Enumerate macro events associated with the given named macro.

R3MCM_ADDMACEVENT

Method

ADDMACEVENT

Identifier

R3MCM_ADDMACEVENT

JavaScript

obj.ADDMACEVENT();

Description

Add macro description to the current macro. Same as R3MCM_EXECSNDMSG, * except that the method call is not executed.

R3MCM_ADDBINDING

Method

ADDBINDING

Identifier

R3MCM_ADDBINDING

Return

R3BOOL, true if succeeded

Param 3:

R3TAG*, R3MCT_MacroName, R3MCT_KeyName

JavaScript

rc = obj.ADDBINDING(p3);

Description

Bind named macro to a key.

R3MCM_PLAYNAMED

Method

PLAYNAMED

Identifier

R3MCM_PLAYNAMED

Param 1:

R3INT, number of times

Param 3:

char*, name of the macro to be played

JavaScript

obj.PLAYNAMED(p1, p3);

Description

Plays a given named macro.

R3MCM_SETMACROTARGETSTATE

Method

SETMACROTARGETSTATE

Identifier

R3MCM_SETMACROTARGETSTATE

Return

R3BOOL, true if succeeded

Param 1:

char*, name of the macro target

Param 3:

R3BOOL, true activates, false deactivates macro recording

JavaScript

rc = obj.SETMACROTARGETSTATE(p1, p3);

Description

Activate recording for given macro target

R3MCM_GETMACROTARGETSTATE

Method

GETMACROTARGETSTATE

Identifier

R3MCM_GETMACROTARGETSTATE

Return

R3BOOL, TRUE/FALSE, -1 indicates the given target was not found

Param 3:

char*, name of the target

JavaScript

rc = obj.GETMACROTARGETSTATE(p3);

Description

Fetch record state of the given macro target

R3MCM_ENUMTARGETS

Method

ENUMTARGETS

Identifier

R3MCM_ENUMTARGETS

Param 1:

R3INT, mth for callback object

Param 3:

R3OBJ*, object to be called

JavaScript

obj.ENUMTARGETS(p1, p3);

Description

Enumerate registered macro targets

R3MCM_FINDNAMEDMACRO

Method

FINDNAMEDMACRO

Identifier

R3MCM_FINDNAMEDMACRO

Param 3:

char*, name of the macro

JavaScript

obj.FINDNAMEDMACRO(p3);

Description

Find named macro by name

R3MCM_FINDTARGET

Method

FINDTARGET

Identifier

R3MCM_FINDTARGET

Return

R3OBJ*, target object

Param 3:

char*, name of the target

JavaScript

rc = obj.FINDTARGET(p3);

Description

Find target by name

Pause

Attribute

Pause

Identifier

R3MCT_Pause

JavaScript type

Boolean

C type

R3BOOL

Description

set to true to 'pause' macro recording

Syntax

jsobj.SetPause(value);
value = jsobj.GetPause();

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

RecordMode

Attribute

RecordMode

Identifier

R3MCT_RecordMode

JavaScript type

Boolean

C type

R3BOOL

Description

true clears the current macro and activates recording, false resets

Syntax

jsobj.SetRecordMode(value);
value = jsobj.GetRecordMode();

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

MacroName

Attribute

MacroName

Identifier

R3MCT_MacroName

JavaScript type

String

C type

char*

Description

name of the named macro

Syntax

jsobj.SetMacroName(value);
value = jsobj.GetMacroName();

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

KeyName

Attribute

KeyName

Identifier

R3MCT_KeyName

JavaScript type

String

C type

char*

Description

name of the key

Syntax

jsobj.SetKeyName(value);
value = jsobj.GetKeyName();

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

MacroList

Attribute

MacroList

Identifier

R3MCT_MacroList

JavaScript type

r3List

C type

R3LIST*

Description

recorded macros

Syntax

value = jsobj.GetMacroList();

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

MacroListSelection

Attribute

MacroListSelection

Identifier

R3MCT_MacroListSelection

JavaScript type

Integer

C type

int

Description

'R3MCT_MacroListSelection' not documented

Syntax

jsobj.SetMacroListSelection(value);
value = jsobj.GetMacroListSelection();

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

BindingsList

Attribute

BindingsList

Identifier

R3MCT_BindingsList

JavaScript type

r3List

C type

R3LIST*

Description

key bindings

Syntax

value = jsobj.GetBindingsList();

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

BindingsListSelection

Attribute

BindingsListSelection

Identifier

R3MCT_BindingsListSelection

JavaScript type

Integer

C type

int

Description

'R3MCT_BindingsListSelection' not documented

Syntax

jsobj.SetBindingsListSelection(value);
value = jsobj.GetBindingsListSelection();

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

CurrentList

Attribute

CurrentList

Identifier

R3MCT_CurrentList

JavaScript type

r3List

C type

R3LIST*

Description

macros under recording

Syntax

value = jsobj.GetCurrentList();

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

R3MACB_MAXKEYNAME

Tags

R3MCT_TargetHelp

R3MCT_ExecOn

R3MCT_ExecMth

R3MCT_ExecEMth

R3MCT_ExecTag

R3MCT_ExecParam

R3MCT_ExecType

R3MCT_TargetName

R3MCT_TargetGetFrom

R3MCT_TargetGetMethod

R3MCT_Filer

R3MCT_TargetDescription