Control Methods

Detailed Description

Functions
virtual String	GetDrawingFile ()
	Returns the value of the DrawingFile property. More...
virtual GlgObject	GetDrawingObject ()
	Queries the value of the DrawingObject property. More...
virtual String	GetDrawingURL ()
	Returns the value of the DrawingURL property. More...
virtual Encoding	GetEncoding ()
	Returns the default encoding. More...
virtual GlgObject	GetViewport ()
	Returns the control's viewport object. More...
virtual bool	IsReady ()
	Queries the ready state of the control. More...
virtual bool	SetAutoUpdateOnInput (bool update)
	Enabled or disables automatic updates on input events. More...
virtual void	SetDrawingFile (String drawing_file)
	Sets the DrawingFile property. More...
virtual bool	SetDrawingObject (GlgObject drawing_object)
	Sets the DrawingObject property to a GLG object to be used as the control's viewport. More...
virtual void	SetDrawingURL (String drawing_url)
	Sets the DrawingURL property. More...
virtual void	SetEncoding (Encoding encoding)
	Sets the default encoding. More...

Function Documentation

GetDrawingFile()

virtual String GetDrawingFile ( )

virtual

Returns the value of the DrawingFile property.

Returns

The file used to load the drawing from.

GetDrawingObject()

virtual GlgObject GetDrawingObject ( )

virtual

Queries the value of the DrawingObject property.

Returns

The current value of the DrawingObject property.

GetDrawingURL()

virtual String GetDrawingURL ( )

virtual

Returns the value of the DrawingURL property.

Returns

The URL used to load the drawing from.

GetEncoding()

virtual Encoding GetEncoding ( )

virtual

Returns the default encoding.

Returns

encoding Encoding used for decoding strings in the loaded drawing.

GetViewport()

virtual GlgObject GetViewport ( )

virtual

Returns the control's viewport object.

Returns

The control's viewport object or null if the drawing hasn't been loaded.

IsReady()

virtual bool IsReady ( )

virtual

Queries the ready state of the control.

Returns

true if the control has finished loading its drawing.

SetAutoUpdateOnInput()

virtual bool SetAutoUpdateOnInput ( bool  update )

virtual

Enabled or disables automatic updates on input events.

Returns the previous setting of automatic updates.

Parameters

update

true to enable automatic updates on input events, false to disable.

Returns

The previous setting of automatic updates.

Automatic updates on input events are enabled by default, but may be disabled to prevent slowing down scrolling and other operations of the real-time charts.

If automatic updates are turned off, input objects redraw themselves on user input event, but an explicit UpdateGlg call has to be used to redraw any objects constrained to input objects and located outside them. When automatic updates are turned off, the application code also has to explicitly invoke UpdateGlg for timer events (Format="Timer") to update objects in the drawing with the timer transformations attached.

SetDrawingFile()

virtual void SetDrawingFile ( String  drawing_file )

virtual

Sets the DrawingFile property.

Parameters

drawing_file

The file to load the drawing from.

The drawing must contain a viewport named $Widget, which will be used as the top-level viewport of the control.

SetDrawingObject()

virtual bool SetDrawingObject ( GlgObject  drawing_object )

virtual

Sets the DrawingObject property to a GLG object to be used as the control's viewport.

The method may be used to replace a drawing displayed in the control.

Parameters

drawing_object

The drawing object containing a viewport named $Widget, which will be used as the top-level viewport of the control.

Returns

Success or failure status.

SetDrawingURL()

virtual void SetDrawingURL ( String  drawing_url )

virtual

Sets the DrawingURL property.

Parameters

drawing_url

The URL to load the drawing from.

The drawing must contain a viewport named $Widget, which will be used as the top-level viewport of the control.

SetEncoding()

virtual void SetEncoding ( Encoding  encoding )

virtual

Sets the default encoding.

Parameters

encoding

Encoding used for decoding strings in the loaded drawing.