CUE Design Director Script Language - Manual (Page 85)

Reference Manual Design Director Script Language
www.cuesystem.com
Page 85 of 94
3.2.20. TimerObject
The object inherits from IdentificationObjectA object. It contains:
Property Type Description
Enable uint If its value is zero then the OnTimer event is not called. If its value is
none zero then the OnTimer event will not occur, if the Interval is
none zero.
Father IdentificationObjectA The father of the object. For the button itself, for instance it is the
board that it is lying on. For the window and the page (as well as for
the ”free” objects – i.e. a picture, font or a color) the value is
NoObject. The property is for reading only.
Interval uint The interval is in milliseconds after which the OnTimer event occurs..
Sometimes when the hardware is busy the event can get lost. Likely
the real interval after which the event occurs depends on the
hardware abilities. If the vlue of properties is set to zero then the
event will not occur.
Name string * 50 The name of the object. The property is read only. This is default
value.
Tag uint Free space where anyone, while the program is running, can note
something. For the virtual world itself it has no importance. For the
design environment it is forbidden. At the beginning the value is zero
here.
Top IdentificationObjectA Top object for an object. This means an object that has no father –
that is a page or a window. For the ”free” objects – i.e. a picture, font,
color – the value is NoObject.
Event Parameters Description
OnTimer It always occurs after the elapsed interval. It does not matter whether
a window resp. page to which to the object is attached, is displayed
or not, whether has been ever displayed or not (whether its Show
method has been called, resp. it does not depend whether the Hide
method is called.
Method Parameters Description
PosMe2Parent Param x uint
Param y uint
Converts the entered coordinates x, y relative to the object to
coordinate relative to the parent object. If the father of the object is
not defined (the value of the property Father is NoObject) then the
coordinates remain the same
PosParent2Me Param x uint
Param y uint
Converts the entered coordinates x, y relative to the object to
coordinate relative to the parent object.
PosParent2Top Param x uint
Param y uint Converts the entered coordinates x, y relative to the parent object to
relative coordinate to the top object (i.e. relative to the window or the
page) If the father of the object is not defined (the value of the
property Father is NoObject) then the coordinates relative to the top
object remain the same as the coordinates relative to father of the
object.
PosScreen2Top Param x uint
Param y uint Converts the entered coordinates x, y relative to the entire screen to
coordinate relative to the top object (i.e. relative to the window or the
page)
PosTop2Parent Param x uint
Param y uint
Converts the entered coordinates x, y relative to the top object (i.e.
relative to the window or the page) to coordinates relative to the
parent of the object. If the father of the object is not defined (the
value of the property Father is NoObject) then the coordinates
relative to object remain the same as the coordinate relative to the
father of the object.
PosTop2Screen Param x uint
Param y uint
Converts the entered coordinates x, y relative to the top object (i.e.
relative to a window or page) to coordinates relative to the entire
screen.