GlgTag Class Reference

Tag object. More...

Detailed Description

Tag object.

Inherits GlgObject.

Public Member Functions
	GlgTag (String tag_name_p, String tag_source_p, String tag_comment_p)
	Constructor, creates a data tag. More...
	GlgTag (String tag_name_p, String tag_source_p, String tag_comment_p, GlgTagType tag_type_p)
	Constructor to create a tag of the requested tag type. More...
Public Member Functions inherited from GlgObject
void	AbortGISRequest (String resource_name)
	Aborts a GIS object's asynchronous map loading request in progress, if any. More...
GlgObject	AddAnnotation (String resource_name, GlgObject annotation, double position_x, double position_y, bool add_box)
	Adds an annotation to the chart object. More...
GlgObject	AddAttachmentPoint (double dx, double dy, double dz)
	Adds an attachment point to the reference object and returns the added point. More...
bool	AddDataSampleNode (GlgDataSampleNode node, bool quick_mode)
	Adds a data sample node directly to the plot's data buffer. More...
void	AddListener (GlgCallbackType type, Object listener)
	Adds a GLG event listener to a viewport. More...
bool	AddObject (Object object, GlgAccessType access_type, GlgPositionModifier pos_modifier)
	A generic method for adding an object to the container. More...
bool	AddObjectAt (Object object, int index)
	Adds an object at the specified position inside the container. More...
bool	AddObjectToBottom (Object object)
	Adds an object at the end of the container. More...
bool	AddObjectToTop (Object object)
	Adds an object at the beginning of the container. More...
GlgObject	AddPlot (String resource_name, GlgObject plot)
	Adds a plot line to the chart object. More...
GlgObject	AddTimeLine (String resource_name, GlgObject time_line, double time_stamp)
	Adds a vertical time line to the chart object. More...
void	ChangeObject (String resource_path)
	Sends a change message the object without actually changing the object's properties. More...
bool	ClearDataBuffer (String resource_name)
	Clears accumulated data samples of a real-time chart or one of its plots. More...
GlgObject	CloneObject (GlgCloneType clone_type)
	Creates a specialized copy (clone) of an object. More...
bool	ConfigureWindow (int x, int y, int width, int height, GlgConfigureMask mask, GlgObject parent)
	Sets the size and/or position of a viewport's window. More...
bool	ConstrainObject (GlgObject to_attribute)
	Constrains an attribute or a point of the object to an attribute or a point of another object. More...
bool	ContainsObject (Object object)
	Checks if object belongs to the container. More...
GlgObject	CopyObject ()
	Creates a copy of the object. More...
GlgObject	CreateAlarmList ()
	Creates and returns a list of alarms defined in the object. More...
GlgObject	CreateChartSelection (GlgObject plot, double x, double y, double dx, double dy, bool screen_coord, bool include_invalid, bool x_priority)
	Selects the chart's data sample closest to the specified position. More...
Bitmap	CreateImage (String resource_name)
	Creates and returns an image of the current state of the viewport's graphics. More...
Bitmap	CreateImageCustom (String resource_name, System.Drawing.Rectangle image_area, int gap)
	Creates an image of the specified rectangular region of the viewport's graphics. More...
GlgObject	CreateInversedMatrix ()
	ADVANCED: Inverts the matrix object. More...
GlgObject	CreatePointArray (GlgControlPointType type)
	ADVANCED: Creates and returns an array containing all control points of the object. More...
GlgObject	CreateResourceList (bool list_named_res, bool list_def_attr, bool list_aliases)
	Returns a list of the object's resources. More...
GlgObject	CreateTagList (bool unique_tag_sources)
	Creates and returns a list of data tags defined in the object. More...
String	CreateTooltipString (double x, double y, double dx, double dy, String format)
	Creates and returns a chart or axis tooltip string corresponding to the specified position in screen coordinates. More...
bool	DeleteAnnotation (String resource_name, GlgObject annotation, double position_x, double position_y)
	Deletes an annotation from the chart. More...
bool	DeleteBottomObject ()
	Deletes an object from the bottom of the container. More...
bool	DeleteObject (GlgAccessType access_type, GlgPositionModifier pos_modifier, bool replace_element, Object replace_obj)
	A generic method for deleting an object from the container. More...
bool	DeleteObject (Object object)
	Finds and deletes an object from the container. More...
bool	DeleteObjectAt (int index)
	Deletes an object from the specified position in the container. More...
bool	DeletePlot (String resource_name, GlgObject plot)
	Deletes a plot line from the chart. More...
bool	DeleteTags (GlgTagType tag_type_mask)
	Deletes all data tags or all public properties inside the object the method is invoked on. More...
bool	DeleteTimeLine (String resource_name, GlgObject time_line, double time_stamp)
	Deletes a time line from the chart. More...
bool	DeleteTopObject ()
	Deletes an object from the beginning of the container. More...
void	DialogInitialDraw (GlgObject parent)
	Displays a GLG drawing of the viewport as a floating dialog for the first time after it has been created or loaded. More...
void	DialogSetupHierarchy (GlgObject parent)
	Provides an explicit request to set up the object hierarchy of a drawing displayed in a dialog window. More...
bool	ExportPostScript (String file, double x, double y, double width, double height, bool portrait, bool stretch, bool center)
	Generates a PostScript output of the current state of the viewport's graphics. More...
int	ExportStrings (String filename, GlgMediumType medium_type, char separator1, char separator2, Encoding encoding)
	Writes all text strings defined in the viewport's drawing into a string translation file. More...
int	ExportTags (String filename, GlgMediumType medium_type, char separator1, char separator2, Encoding encoding)
	Writes tag names and tag sources of all data tags defined in the viewport's drawing to a tag remapping file. More...
bool	FindObjects (GlgFindObjectsData data)
	Finds either one or all parents or children of the object that match the supplied search criteria. More...
bool	FitObject (GlgCoordType coord_type, GlgCube box, bool keep_ratio)
	Fits the object to the specified rectangular area. More...
void	Flush (int size)
	Set the size of the container object. More...
GlgObject	GetAction (GlgActionType action_type, GlgTriggerType trigger_type, int button, GlgArmedStateType armed_state, GlgDoubleClickStateType double_click_state, String action, String subaction, bool enabled_only)
	Returns the first found action with the matching parameters attached to the object. More...
GlgObject	GetAlarmObject (String alarm_label, bool single_alarm)
	Retrieves an alarm object with a specified alarm label inside the object the method is invoked on. More...
GlgCube	GetBox ()
	Returns the object's bounding box extent in screen coordinates. More...
GlgMinMax	GetChartDataExtent (String resource_name, bool x_extent, bool visible_only)
	Queries the minimum and maximum extent of the data accumulated in the chart or in one of its plots in the specified X or Y direction. More...
GlgDataType	GetDataType ()
	Returns The data object's data type. More...
GlgObject	GetDrawingMatrix ()
	ADVANCED: Returns transformation matrix used to draw the object. More...
GlgDouble	GetDResource (String resource_name)
	Returns the current value of the object's D (double) resource. More...
GlgDouble	GetDTag (String tag_source)
	Returns the current value of the object's D (double) tag. More...
Object	GetElement (int index)
	Returns element at the specified position in the container. More...
GlgGISRequestObserver	GetGISRequestInfo (String resource_name)
	Obtains information about an asynchronous map loading request in progress for the GIS object the method is invoked on. More...
GlgPoint	GetGResource (String resource_name)
	Returns the current value of the object's G (geometrical or color) resource. More...
GlgPoint	GetGTag (String tag_source)
	Returns the current value of the object's G (geometrical or color) tag. More...
int	GetImageHeight ()
	Returns the height of the last image generated by the GLG Graphics Server for the top viewport. More...
int	GetImageWidth ()
	Returns the width of the last image generated by the GLG Graphics Server for the top viewport. More...
int	GetIndex (Object object)
	Returns index of the first occurrence of an object in the container. More...
GlgObject	GetLegendSelection (double x, double y)
	Returns the plot object corresponding to the legend item at the specified position in the legend object the method is invoked on, if any. More...
GlgMatrixData	GetMatrixData (GlgMatrixData matrix_data)
	ADVANCED: Queries matrix coefficients of the matrix. More...
GlgObject	GetNamedObject (String name)
	Finds an object with the specified name inside the container of GLG objects and returns it. More...
GlgObject	GetNamedPlot (String resource_name, String plot_name)
	Given a name of the chart's plot, returns the plot's object ID. More...
Object	GetNativeComponent (String resource_name, GlgComponentQueryType type)
	ADVANCED: Returns a native component used to render the viewport. More...
int	GetNumParents ()
	ADVANCED: Returns number of the object's parents. More...
Object	GetObjectData ()
	Retrieves application data attached to the object via SetObjectData. More...
String	GetObjectName ()
	Returns the object's name. More...
GlgObjectType	GetObjectType ()
	Returns the object's type. More...
GlgObject	GetObjectViewport (bool heavy_weight, bool self)
	Returns parent viewport of the drawable object. More...
GlgObject	GetParent ()
	ADVANCED: Returns the object's parent object, if one exists, or an array of all parents for constrained data objects. More...
GlgObject	GetParentViewport (bool heavy_weight)
	Returns parent viewport of the drawable object. More...
Object	GetResource (String resource_name)
	Deprecated, use GetNativeComponent: Returns an ID of a native resource. More...
GlgObject	GetResourceObject (String resource_name)
	Finds and returns a named resource or an attribute of the object. More...
int	GetSize ()
	Returns size of the container object. More...
String	GetSResource (String resource_name)
	Returns the current value of the object's S (string) resource. More...
String	GetSTag (String tag_source)
	Returns the current value of the object's S (string) tag. More...
int	GetStringIndex (String search_string)
	Returns index of the first occurrence of a string in the container of the STRING type. More...
GlgObject	GetTagObject (String search_string, bool by_name, bool unique_tags, bool single_tag, GlgTagType tag_type_mask)
	Retrieves a tag object with a specified tag name, data tag source, or export tag category inside the object the method is invoked on. More...
bool	GISConvert (String resource_name, GlgCoordType coord_type, bool coord_to_lat_lon, GlgPoint in_point, GlgPoint out_point)
	Performs coordinate conversion from the GIS coordinates of the GIS Object to the GLG coordinates of the drawing and visa versa. More...
GlgObject	GISCreateSelection (String resource_name, String layers, double x, double y, GlmLabelSelectionMode select_labels)
	Returns a message object containing information about GIS features located at a specified position on the map. More...
GlgDouble	GISGetElevation (String resource_name, String layer_name, double lon, double lat)
	Returns an elevation of a lat/lon point on a map. More...
bool	HasResourceObject (String resource_name)
	Checks if the object's named resource exists. More...
bool	HasTag (String tag_name, GlgTagType tag_type_mask)
	Checks if a data or export tag with a specified tag name exists inside the object the method is invoked on. More...
bool	HasTagName (String tag_name)
	Checks if the object's data tag with a specified tag name exists. More...
bool	HasTagSource (String tag_source)
	Checks if the object's data tag with a specified tag source exists. More...
int	ImportStrings (String filename, GlgMediumType medium_type, bool verbose, Encoding encoding)
	Replaces text strings in the viewport's drawing with the strings loaded from a string translation file. More...
int	ImportTags (String filename, GlgMediumType medium_type, bool verbose, Encoding encoding)
	Replaces the TagName and TagSource attributes of data tags in the viewport's drawing with information loaded from a tag remapping file. More...
void	InitialDraw ()
	Draws a GLG viewport object for the first time after it has been created or loaded. More...
bool	InstallGISRequest (String resource_name)
	Installs a new map received by the GIS request in the GIS object. More...
void	Inverse ()
	Inverses the order of elements inside the container object. More...
bool	IsAt (GlgPositionType position)
	Checks the position of the iteration pointer (the current element of the container). More...
bool	IsDrawable ()
	Checks if the object is drawable. More...
Object	Iterate ()
	Traverses the container object's elements in the forward direction. More...
Object	IterateBack ()
	Traverses the container object's elements in the backward direction. More...
bool	LayoutObjects (GlgObject anchor, GlgLayoutType type, double distance, bool use_box, bool process_subobjects)
	Performs operations ranging from setting an object's width and height to aligning and layout of groups of objects. More...
bool	MoveObject (GlgCoordType coord_type, GlgPoint start_point, GlgPoint end_point)
	Moves an object by a move vector. More...
bool	MoveObjectBy (GlgCoordType coord_type, double x, double y, double z)
	Moves the object by the specified distances. More...
bool	MoveObjectBy (GlgCoordType coord_type, GlgPoint point)
	Moves the object by distances specified by the GlgPoint object. More...
bool	NativePrint (Graphics graphics)
	Generates printing output of the current state of the viewport's graphics. More...
bool	PositionObject (GlgCoordType coord_type, GlgAnchoringType anchoring, double x, double y, double z)
	Positions the object at the specified location. More...
bool	PositionObject (GlgCoordType coord_type, GlgAnchoringType anchoring, GlgPoint position)
	Positions the object at the location specified by the GlgPoint object. More...
GlgDouble	PositionToValue (String resource_name, double x, double y, bool outside_x, bool outside_y)
	Returns a value corresponding to the specified position on top of the Chart or an Axis object. More...
GlgObject	QueryTags (GlgTagType tag_type_mask)
	Returns a group of all tags of the requested tag type defined in the object. More...
void	ReleaseObject (GlgObject suspend_info)
	Releases the object that was suspended for editing. More...
bool	ReorderElement (int current_index, int new_index)
	Changes an element's position inside the container. More...
bool	RequestGISMap (String resource_name, double extent_x, double extent_y, double center_x, double center_y, double angle, GlgProjectionType projection, String layers, GlgGISRequestFlags flags, GlgGISRequestObserver request_observer)
	Initiates an asynchronous GIS map loading request. More...
bool	RequestGISZoom (String resource_name, char type, double value, GlgGISRequestObserver request_observer)
	Initiates an asynchronous GIS zooming or panning request compatible with the SetZoom method interface. More...
bool	Reset ()
	Reinitializes the viewport's drawing by resetting its drawing hierarchy, then setting it up again and rendering the drawing. More...
void	ResetHierarchy ()
	Resets the object hierarchy of the object. More...
bool	RotateObject (GlgCoordType coord_type, GlgPoint center, double x_angle, double y_angle, double z_angle)
	Rotates the object. More...
bool	SaveObject (Object medium, GlgMediumType medium_type)
	Saves the object into a stream using a default encoding. More...
bool	SaveObject (Object medium, GlgMediumType medium_type, Encoding encoding)
	Saves the object into a stream using the specified charset. More...
bool	SaveObject (String filename)
	Saves the object to a file using a default encoding. More...
bool	SaveObject (String filename, Encoding encoding)
	Saves the object to a file using the specified encoding. More...
bool	ScaleObject (GlgCoordType coord_type, GlgPoint center, double x_scale, double y_scale, double z_scale)
	Scales the object. More...
bool	ScreenToWorld (bool inside_vp, GlgPoint in_point, GlgPoint out_point)
	Converts a point's screen coordinates to the GLG world coordinate system. More...
Object	SendMessage (String resource_name, String message, Object param1, Object param2, Object param3, Object param4)
	Sends a message to the object to request some action to be performed. More...
bool	SetBrowserSelection (String resource_name, String selection, String filter)
	Sets a new value of a browser's Selection and Filter text boxes of the Resource, Tag, Alarm and Data browser widgets after the browser object has already been set up. More...
bool	SetChartFilter (String resource_name, GlgChartFilter filter, Object client_data)
	Attaches a custom data filter to the chart's plot. More...
bool	SetCursorType (String resource_name, GlgCursorType cursor_type)
	Sets cursor for the viewport's drawing or one of its child viewports. More...
bool	SetDResource (String resource_name, double value)
	Sets a new value of the object's D (double) resource. More...
bool	SetDResource (String resource_name, double value, bool if_changed)
	Sets a new value of the object's D (double) resource. More...
bool	SetDResource (String resource_name, GlgDouble value)
	Sets a new value of the object's D (double) resource. More...
bool	SetDResource (String resource_name, GlgDouble value, bool if_changed)
	Sets a new value of the object's D (double) resource. More...
bool	SetDTag (String tag_source, double value, bool if_changed)
	Sets a new value of the object's D (double) tag. More...
bool	SetDTag (String tag_source, GlgDouble value, bool if_changed)
	Sets a new value of the object's D (double) tag. More...
bool	SetElement (int index, Object new_object)
	Replaces the object at the specified position in the container. More...
void	SetEnd ()
	Initializes the container object for the backward traversing. More...
void	SetFocus (String resource_name)
	Sets the keyboard focus to the object's viewport. More...
bool	SetGResource (String resource_name, double x_value, double y_value, double z_value)
	Sets new values of the object's G (geometrical or color) resource. More...
bool	SetGResource (String resource_name, double x_value, double y_value, double z_value, bool if_changed)
	Sets new values of the object's G (geometrical or color) resource. More...
bool	SetGResource (String resource_name, GlgPoint g_value)
	Sets new values of the object's G (geometrical or color) resource. More...
bool	SetGResource (String resource_name, GlgPoint g_value, bool if_changed)
	Sets new values of the object's G (geometrical or color) resource. More...
bool	SetGTag (String tag_source, double x_value, double y_value, double z_value, bool if_changed)
	Sets new values of the object's G (geometrical or color) tag. More...
bool	SetGTag (String tag_source, GlgPoint value, bool if_changed)
	Sets new values of the object's G (geometrical or color) tag. More...
void	SetImageSize (int width, int height)
	Sets the size of the image to be generated by the Graphics Server for this top viewport. More...
bool	SetLabelFormatter (String resource_name, GlgLabelFormatter formatter)
	Attaches a custom label formatter to the chart axis or the stand-alone axis object. More...
bool	SetLinkedAxis (String resource_name, GlgObject axis_object, String axis_resource_name)
	Associates the chart's plot, level line or annotation object with an Y axis for automatic rescaling. More...
void	SetMatrixData (GlgMatrixData matrix_data)
	ADVANCED: Sets matrix's coefficients to the supplied values. More...
void	SetObjectData (Object data)
	Attaches arbitrary application data to the graphical object the method is invoked on. More...
bool	SetResourceFromObject (String resource_name, GlgObject value)
	Sets a new value of the object's resource to the value of contained in the provided data object of the same data type. More...
bool	SetResourceFromObject (String resource_name, GlgObject value, bool if_changed)
	Sets the value of the object's data object to the value of another data object of the same data type. More...
bool	SetResourceObject (String resource_name, GlgObject value)
	Replaces a resource object inside the object the method is invoked on. More...
GlgGISRequestObserver	SetScrollbarObserver (String resource_name, GlgGISRequestObserver request_observer)
	Controls the the way integrated scrollbars work for the GIS object. More...
bool	SetSResource (String resource_name, String value)
	Replaces the string of the object's S (string) resource. More...
bool	SetSResource (String resource_name, String value, bool if_changed)
	Replaces the string of the object's S (string) resource. More...
bool	SetSResourceFromD (String resource_name, String format, double value)
	Sets the value of the object's S (string) resource from a double value, converting the value into a string using a C-style printf format string. More...
bool	SetSResourceFromD (String resource_name, String format, double value, bool if_changed)
	Sets the value of the object's S (string) resource from a double value, converting the value into a string using a C-style printf format string. More...
bool	SetSResourceFromD (String resource_name, String format, GlgDouble value)
	Sets the value of the object's S (string) resource from a double value, converting the value into a string using a C-style printf format string. More...
bool	SetSResourceFromD (String resource_name, String format, GlgDouble value, bool if_changed)
	Sets the value of the object's S (string) resource from a double value, converting the value into a string using a C-style printf format string. More...
bool	SetSTag (String tag_source, String value, bool if_changed)
	Replaces the string of the object's S (string) tag. More...
bool	SetSTagFromD (String tag_source, String format, double value, bool if_changed)
	Sets the value of the object's S (string) tag from a double value, converting the value into a string using a C-style printf format string. More...
bool	SetSTagFromDObj (String tag_source, String format, GlgDouble value, bool if_changed)
	Sets the value of the object's S (string) tag from a double value, converting the value into a string using a C-style printf format string. More...
void	SetStart ()
	Initializes the container object for the forward traversing. More...
void	SetupHierarchy ()
	Provides an explicit request to set up the object hierarchy of the object without rendering it. More...
bool	SetXform (GlgObject xform)
	Adds or deletes transformations attached to the object. More...
bool	SetZoom (String resource_name, char type, double value)
	Provides a programmatic interface to integrated zooming and panning. More...
bool	SetZoomMode (String resource_name, GlgObject zoom_object, String zoom_object_resource_name, GlgZoomMode zoom_mode)
	Sets or resets the viewport's zoom mode by supplying a GIS or Chart object to be zoomed. More...
GlgObject	SuspendObject ()
	Suspends the object for editing after it has been drawn. More...
bool	TransformObject (GlgObject xform, GlgCoordType coord_type, GlgObject parent)
	ADVANCED: Transforms all control points of the object with an arbitrary transformation. More...
void	TransformPoint (GlgPoint in_point, GlgPoint out_point)
	Transforms a single point using the matrix object the method is invoked on. More...
void	TraverseObjects (GlgObjectActionInterface action)
	Traverses the object hierarchy of the object and and performs the specified actions on the object itself and all its subobjects, including object attributes. More...
bool	UnconstrainObject ()
	Unconstrains the object's attribute or the object's point. More...
bool	UpdateChartState (String resource_name, int state)
	Triggers updating the chart's state after prefilling it with data using the quick mode of AddDataSampleNode. More...
bool	UpdateChartTimeAxis (String resource_name, double time_stamp, bool initialize)
	Scrolls the chart forward to show all data samples up to the provided time stamp or index. More...
bool	UpdateGlg ()
	Updates the drawing of a viewport or a light viewport with the latest resource values. More...
bool	UpdateImmediately ()
	Advanced: Updates the drawing of a viewport or a light viewport with the latest resource values, immediately. More...
bool	WorldToScreen (bool inside_vp, GlgPoint in_point, GlgPoint out_point)
	Converts a point's coordinates from the GLG world coordinate system to the screen coordinate system. More...

Additional Inherited Members
Static Public Member Functions inherited from GlgObject
static void	AddHandler (String handler_name, GlgHandler handler)
	Registers a custom interaction handler. More...
static void	Bell ()
	Emits an audio beep. More...
static void	CatchGlobalErrors (bool catch_all, bool exit)
	Installs the GLG error handler as a global error handler for processing any uncaught exceptions in a GLG application. More...
static String	ConcatResNames (String resource_name1, String resource_name2)
	Creates a composite resource path from two components. More...
static GlgObject	ConvertViewportType (GlgObject object)
	Converts a viewport to a light viewport, or a light viewport to a viewport. More...
static GlgDataSampleNode	CreateDataSampleNode (GlgObject plot, bool extended)
	Creates a data sample node to be used with the AddDataSampleNode method. More...
static String	CreateIndexedName (String template_name, int resource_index)
	Creates a string with a name of an enumerated resource. More...
static GlgObject	CreateMessage (GlgObject viewport)
	Creates a GLG message object that may be sent by an interaction handler to a parent handler or a parent's Input callback via SendMessageToParent. More...
static String	CreateResourcePath (GlgObject object, GlgObject parent)
	Returns a relative resource path that can be used to access the object as a resource of the parent object. More...
static GlgObject	CreateSelection (GlgObject top_vp, GlgCube rectangle, GlgObject selected_vp)
	Returns a list of the objects intersecting a given rectangle. More...
static GlgObject	CreateSelection (MouseEventArgs mouse_event, int delta, GlgObject top_vp, GlgObject selected_vp)
	Returns a list of names of objects located under the mouse. More...
static GlgObject	CreateSelectionMessage (GlgObject top_vp, GlgCube rectangle, GlgObject selected_vp, GlgSelectionEventType selection_type, int button)
	Searches for an Action object that would be activated by the user interaction event. More...
static GlgObject	CreateSelectionNames (GlgObject top_vp, GlgCube rectangle, GlgObject selected_vp)
	Returns a list of names of objects intersecting a given rectangle. More...
static GlgObject	CreateSelectionNames (MouseEventArgs mouse_event, int delta, GlgObject top_vp, GlgObject selected_vp)
	Returns a list of names of objects located under the mouse. More...
static bool	EnableAttachmentPoints (bool state)
	Controls the use of attachment points to determine object extents when the objects are aligned. More...
static bool	EnableTimerXforms (bool state)
	ADVANCED: Enables or disables all timer transformations defined inside GLG drawings. More...
static void	Error (GlgErrorType error_type, String message, Exception exception, bool async_error=false)
	Display an error message using the GLG error handler. More...
static void	FreeDataSampleNode (GlgObject plot, GlgDataSampleNode node)
	Returns a data sample node to the plot cache for reuse, if possible. More...
static Object	GetHandlerData (GlgObject viewport)
	Retrieves stored data used by a custom handler instance. More...
static bool	GetModifierState (GlgModifierType modifier)
	Returns the current state of a modifier. More...
static GlgDataSample	GetNodeDataSample (GlgDataSampleNode node)
	Returns the datasample contained in the node. More...
static GlgObject	GetSelectedPlot ()
	Returns the plot object corresponding to the last legend item selected with the mouse, if any. More...
static String	GetStackTraceAsString ()
	Returns current stack trace as a string. More...
static String	GetStackTraceAsString (Exception e)
	Returns the stack trace of the specified exception as a string. More...
static void	GlmConvert (GlgProjectionType projection, bool stretch, GlgCoordType coord_type, bool coord_to_lat_lon, GlgPoint center, GlgPoint extent, double angle, double min_x, double max_x, double min_y, double max_y, GlgPoint in_point, GlgPoint out_point)
	A low level method that performs coordinate conversion from the GIS coordinates of a map to the GLG coordinates of the drawing and visa versa without the help of a GLG GIS Object. More...
static bool	IHCallCurrIH (GlgIHCallEvent call_event)
	Passes an event to the current handler. More...
static bool	IHCallCurrIHWithModifToken (GlgIHCallEvent call_event, int token)
	A variation on IHCallCurrIHWithToken that reuses an existing user interface event. More...
static bool	IHCallCurrIHWithToken (int token)
	Passes a token to the current handler. More...
static void	IHCallPrevIHWithModifToken (GlgIHCallEvent call_event, int token)
	A variation on IHCallPrevIHWithToken that reuses an existing user interface event. More...
static void	IHCallPrevIHWithToken (int token)
	Passes the token to the parent handler of the currently active handler. More...
static void	IHChangeBParameter (GlgObject ih, String name, bool value)
	Changes a boolean value stored in a named parameter. More...
static void	IHChangeDParameter (GlgObject ih, String name, double value)
	Changes a double value stored in a named parameter. More...
static void	IHChangeIParameter (GlgObject ih, String name, int value)
	Changes an integer value stored in a named parameter. More...
static void	IHChangeNParameter (GlgObject ih, String name, Object value)
	Replaces a native object stored in a named parameter. More...
static void	IHChangeOParameter (GlgObject ih, String name, GlgObject value)
	Replaces a GLG object stored in a named parameter. More...
static void	IHChangeSParameter (GlgObject ih, String name, String value)
	Replaces a string stored in a named parameter. More...
static bool	IHGetBParameter (GlgObject ih, String name)
	Returns a boolean value stored in a named parameter. More...
static GlgObject	IHGetCurrIH ()
	Retrieves the current active interface handler. More...
static double	IHGetDParameter (GlgObject ih, String name)
	Returns a double value stored in a named parameter. More...
static GlgIHHandlerInterface	IHGetHandlerInterface (GlgObject ih)
	Retrieves a handler interface instance used to implement a handler. More...
static int	IHGetIParameter (GlgObject ih, String name)
	Returns an integer value stored in a named parameter. More...
static Object	IHGetNParameter (GlgObject ih, String name)
	Returns a native object stored in a named parameter. More...
static GlgObject	IHGetOParameter (GlgObject ih, String name)
	Returns a GLG object stored in a named parameter. More...
static bool	IHGetOptBParameter (GlgObject ih, String name, bool default_value)
	Returns a boolean value stored in an optional named parameter. More...
static double	IHGetOptDParameter (GlgObject ih, String name, double default_value)
	Returns a double value stored in an optional named parameter. More...
static int	IHGetOptIParameter (GlgObject ih, String name, int default_value)
	Returns an integer value stored in an optional named parameter. More...
static Object	IHGetOptNParameter (GlgObject ih, String name, Object default_value)
	Returns a native object stored in an optional named parameter. More...
static GlgObject	IHGetOptOParameter (GlgObject ih, String name, GlgObject default_value)
	Returns a GLG object stored in an optional named parameter. More...
static String	IHGetOptSParameter (GlgObject ih, String name, String default_value)
	Returns a string stored in an optional named parameter. More...
static GlgIHHandlerInterface	IHGetPrevHandlerInterface ()
	Retrieves a handler interface instance used to implement the parent handler of the currently active handler. More...
static GlgObject	IHGetPrevIH ()
	Retrieves the currently active interface handler's parent handler. More...
static String	IHGetSParameter (GlgObject ih, String name)
	Returns a string stored in a named parameter. More...
static int	IHGetToken (GlgIHCallEvent call_event)
	Returns a token associated with the MESSAGE_EVENT event. More...
static GlgCallEventType	IHGetType (GlgIHCallEvent call_event)
	Returns an event's type. More...
static void	IHInit ()
	Initializes installable handler utilities, must be invoked after Init, but before any installable handler methods are used. More...
static GlgObject	IHInstall (GlgIHHandlerInterface handler_interface)
	Creates an interface handler with the specified handler interface and installs it. More...
static void	IHPassToken (GlgIHHandlerInterface handler_interface, int token, bool uninstall)
	Installs a handler, starts it and invokes its entry point with the specified token. More...
static void	IHResetup (GlgObject ih)
	Reinitializes the current handler that have already been installed to "restart" its logic. More...
static void	IHSetBParameter (GlgObject ih, String name, bool value)
	Creates and stores a named boolean parameter. More...
static void	IHSetDParameter (GlgObject ih, String name, double value)
	Creates and stores a named string parameter. More...
static void	IHSetIParameter (GlgObject ih, String name, int value)
	Creates and stores a named integer parameter. More...
static void	IHSetNParameter (GlgObject ih, String name, Object value)
	Creates and stores a named parameter that holds any native object. More...
static void	IHSetOParameter (GlgObject ih, String name, GlgObject value)
	Creates and stores a named parameter that holds a GLG object. More...
static void	IHSetOParameterFromD (GlgObject ih, String name, double value)
	Creates and stores a named double parameter that is stored as a GLG Data object of the D type. More...
static void	IHSetOParameterFromG (GlgObject ih, String name, double value1, double value2, double value3)
	Creates and stores a named parameter that keeps X, Y and Z or R, G and B values stored as a GLG Data object of the G type. More...
static void	IHSetOParameterFromG (GlgObject ih, String name, GlgPoint point)
	Creates and stores a named parameter that contains geometrical (XYZ) or color (RGB) data and is stored as a GLG Data object of the G type. More...
static void	IHSetSParameter (GlgObject ih, String name, String value)
	Creates and stores a named string parameter. More...
static void	IHStart ()
	Initializes and starts the current handler after it has been installed with IHInstall. More...
static void	IHTerminate ()
	Terminates installable handler utilities. More...
static void	IHUninstall ()
	Uninstalls the current handler (the last handler on the handler stack). More...
static void	IHUninstallWithEvent (GlgIHCallEvent call_event)
	Uninstalls the current handler and passes an event to the previous handler. More...
static void	IHUninstallWithToken (int token)
	Uninstalls the current handler and passes a token to the previous handler. More...
static void	Init ()
	Initializes GLG Toolkit. More...
static bool	IsDemo ()
	Queries the type of the GLG library. More...
static GlgObject	LoadObject (Object medium, GlgMediumType medium_type)
	Loads an object from a stream using a default encoding. More...
static GlgObject	LoadObject (Object medium, GlgMediumType medium_type, Encoding encoding)
	Loads an object from a stream using the specified encoding. More...
static GlgObject	LoadObject (String filename, GlgMediumType medium_type)
	Loads an object from a GLG drawing file or a URL using a default encoding. More...
static GlgObject	LoadObject (String filename, GlgMediumType medium_type, Encoding encoding)
	Loads an object from a file or a URL using the specified encoding. More...
static GlgObject	LoadWidget (GlgObject glg_object)
	Finds a viewport named $Widget inside an object and returns it. More...
static GlgObject	LoadWidget (String filename, GlgMediumType medium_type)
	Loads a viewport named $Widget from a file or a URL using a default encoding. More...
static GlgObject	LoadWidget (String filename, GlgMediumType medium_type, Encoding encoding)
	Loads a viewport named $Widget from a file or a URL using the specified encoding. More...
static String	Printf (String format, double value)
	C-style printf method for formatting double values. More...
static String	Printf (String format, int value)
	C-style printf method for formatting integer values. More...
static String	Printf (String format, String value)
	C-style printf method for formatting strings. More...
static double	Rand (double low, double high)
	Returns a random number in the specified range. More...
static bool	RootToScreenCoord (GlgObject viewport, GlgPoint point)
	Converts screen coordinates relative to the root window to the screen coordinates in the specified viewport. More...
static bool	SaveImage (Bitmap image, String image_file, System.Drawing.Imaging.ImageFormat image_format)
	Saves an image to a file in a requested format. More...
static void	SendMessageToParent (GlgObject viewport, GlgObject message_obj, String action, String subaction)
	Sends a message to the Input callback. More...
static GlgAlarmHandler	SetAlarmHandler (GlgAlarmHandler alarm_handler)
	Installs a global alarm handler that will be invoked to process alarms. More...
static bool	SetAttachmentMoveMode (bool state)
	Changes the global attachment point move mode and returns the previous mode state. More...
static void	SetBrowserObject (GlgObject browser, GlgObject glg_object)
	Sets the object for browsing with the GLG Resource, Tag and Alarm browser widgets. More...
static void	SetCustomSetupHandler (GlgCustomSetupHandler handler)
	Installs a custom setup handler that will be invoked to perform custom processing of objects tagged using the CustomSetup flag in the GLG drawing. More...
static bool	SetEditMode (GlgObject viewport, String resource_name, bool edit_mode)
	Sets the viewport's edit mode to disable input objects in the viewport while the drawing is being edited. More...
static GlgErrorHandler	SetErrorHandler (GlgErrorHandler new_handler)
	Replaces the GLG Toolkit error handler and returns the previous error handler. More...
static void	SetHandlerData (GlgObject viewport, Object data)
	Stores data used by the custom handler instance. More...
static GlgTooltipFormatter	SetTooltipFormatter (GlgTooltipFormatter formatter)
	Supplies a custom tooltip formatter. More...
static bool	Sleep (long millisec)
	Sleeps for the specified number of milliseconds. More...
static void	Terminate ()
	Destroys GLG Toolkit's internal objects. More...
static void	ThrowExceptionOnError (bool user_error, bool internal_error)
	Controls displaying a stack trace on errors. More...
static bool	TraceObject (GlgObject object, bool state, bool is_widget, GlgObject top_parent, GlgObjectActionInterface action)
	Highlights all objects in the drawing that depend on the tag or resource object that is being traced. More...
static bool	TranslatePointOrigin (GlgObject from_viewport, GlgObject to_viewport, GlgPoint point)
	Converts screen coordinates of a point in one viewport to the screen coordinates of another viewport. More...
Static Public Attributes inherited from GlgObject
const int	CHART_FILTER_VERSION = 2
	Custom filter version. More...
const double	COORD_MAPPING_ADJ = 0.5
	Coordinate adjustement constant used to map the pixel index to the center of the pixel (i.e pixel #5 is mapped to coord=5.5). More...
const double	EQUATOR_RADIUS = 6378136.0
	Equator radius in meters. More...
const double	GIS_OUTSIDE_VALUE = -2000.0
	A negative value for Z coordinates of converted points outside of the visible part of the globe in the GIS orthographic projection. More...
static GlgObject	IH_CURR
	ID of the current installable interface handler. More...
static GlgObject	IH_GLOBAL
	ID of the global data cache of the installable interface handlers. More...
static GlgObject	IH_NEW
	ID of the last installed installable interface handler. More...
const int	MAJOR_VERSION = 4
	Major version number. More...
const int	MINOR_VERSION = 6
	Minor version number. More...
const double	POLAR_RADIUS = 6356752.0
	Polar radius in meters. More...

Constructor & Destructor Documentation

GlgTag() [1/2]

GlgTag	(	String	tag_name_p,
		String	tag_source_p,
		String	tag_comment_p,
		GlgTagType	tag_type_p
	)

Constructor to create a tag of the requested tag type.

Parameters

tag_name_p	Optional tag name.
tag_source_p	Optional tag source.
tag_comment_p	Optional tag comment.
tag_type_p	Optional tag type constant (one of the GlgTagType constants, default: DATA_TAG).

GlgTag() [2/2]

GlgTag	(	String	tag_name_p,
		String	tag_source_p,
		String	tag_comment_p
	)

Constructor, creates a data tag.

Parameters

tag_name_p	Optional tag name.
tag_source_p	Optional tag source.
tag_comment_p	Optional tag comment.