r3progm

Class

real/code/r3progm.h

Library

r3code

Description:

Progress indicator model class

See Also

oops/r3model.h

See Also

oops/r3progre.h

Super Class

r3Model

R3CLID_MODEL

JavaScript

r3Progressmodel

Class Identifier

R3CLID_PROGRESSMODEL - 248

Methods

Attributes

StartTime, InProgress, Cancelled, InfoStringShort, ForceRefresh, EventHook,

StartTime

Attribute

StartTime

Identifier

R3PROGMODA_StartTime

JavaScript type

Integer

C type

R3INT

Description

time of first BEGIN progress level, read only

Syntax

value = jsobj.GetStartTime();

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

InProgress

Attribute

InProgress

Identifier

R3PROGMODA_InProgress

JavaScript type

Boolean

C type

R3BOOL

Description

true if in progress (read only)

Syntax

value = jsobj.GetInProgress();

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

Cancelled

Attribute

Cancelled

Identifier

R3PROGMODA_Cancelled

JavaScript type

Boolean

C type

R3BOOL

Description

TRUE if cancelled

Syntax

jsobj.SetCancelled(value);
value = jsobj.GetCancelled();

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

InfoStringShort

Attribute

InfoStringShort

Identifier

R3PROGMODA_InfoStringShort

JavaScript type

String

C type

char*

Description

info string without pergentage (read only)

Syntax

value = jsobj.GetInfoStringShort();

char* value;
R3GetAttrs(r3obj, R3PROGMODA_InfoStringShort, &value, R3TAG_END);

ForceRefresh

Attribute

ForceRefresh

Identifier

R3PROGMODA_ForceRefresh

JavaScript type

Boolean

C type

R3BOOL

Description

force refresh even if time has not changed much. Clears on read.

Syntax

value = jsobj.GetForceRefresh();

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

EventHook

Attribute

EventHook

Identifier

R3PROGMODA_EventHook

JavaScript type

String

C type

void*

Description

void (*)(void);

Syntax

jsobj.SetEventHook(value);

void* value = ...;
R3SetAttrs(r3obj, R3PROGMODA_EventHook, value, R3TAG_END);

R3MAX_INFOSTRLEN