PREV NEXT

Generic Logic, Inc. www.genlogic.com


7 Appendices

7.1 Appendix A: Global Configuration Resources

There are a small number of drawing features that can't be said to belong to any particular object in a GLG drawing. When a drawing is displayed in the GLG Graphics Builder, those drawing features, such as the file save format, are managed by the Builder. When a drawing is displayed in an application program, that program must assume the responsibility of managing those features. Rather than include more functions in the GLG API, the Toolkit provides configuration resources to control these features. These resources can be queried and modified with the same resource access functions you use to control any other feature of a drawing.

The path name of a configuration resource starts with $config followed by the configuration resource name. For example, $config/GlgSaveFormat is the name of the configuration parameter that controls the default save format. When configuration parameters are accessed in C, the object parameter of functions that query or set resource values may be NULL. In the object-oriented environment, any GLG object can be used to access global parameters.

The glg_config configuration file may be used to set global configuration resources for the GLG Graphics Builder, and the glg_hmi_config file may be used for HMI Configurator. At run time, the GLG API may be used to query or set these global resources in a program.

The configuration resources, their types and possible values, are listed in the following table. The table also lists environment variables which can be used as an alternative way of setting some global configuration resources for quick testing, or for the cases when the application code can not be accessed. The environment variables settings do not apply to the Java, C#/.NET and JavaScript versions of the Toolkit.

GLG Toolkit Configuration Resources
Name
Type
Default
Description (possible values)
GlgGridPolygon
polygon object
solid black line, one pixel wide
Defines grid attributes such as a line width and a color (the grid spacing is controlled by an attribute of the viewport screen object). The polygon is not accessed directly, but its attributes are, for example: $config/GlgGridPolygon/LineWidth
GlgArrowShape
polygon object
default arrow shape as seen in the Graphics Builder
3-point polygon defining the pixel dimensions and the shape of the arrowheads drawn by the rendering object. To change the arrowheads, change the coordinates of the polygon's points.
GlgHighlightPolygon
polygon object
thin red line as seen in the Graphics Builder
Defines the line attributes of the outline used to highlight traced objects.
GlgTooltipErase-
Distance
Double
5
Specifies the maximum distance in pixels the mouse can move without erasing the currently displayed tooltip. It is used to avoid erasing the tooltip on accidental small mouse movements. If a mouse moves over another object, the tooltip for the new object will be activated only when the current tooltip is erased due to the mouse move exceeding the tooltip erase distance.
For environments other than Java, C# or JavaScript, the GLG_TOOLTIP_ERASE_DISTANCE environment variable may also be used to specify the erase distance.
GlgTooltipLabelColor
G - holds 3 RGB color values
(0;0;0) in X Windows and JavaScript,
unset (-1;-1;-1) on Windows and in Java/C#
Specifies the tooltip label color. If unset, uses the default color inherited from the environment.
GlgTooltipBGColor
G - holds 3 RGB color values
(1;1;1) in X Windows,
(1;1;0.9) in JavaScript,
unset (-1;-1;-1) on Windows and in Java/C#
Specifies the background color of the tooltip. If unset, uses the default color inherited from the environment.
GlgTooltipText-
Alignment
String
"left"
Specifies the row alignment of a multi-line tooltip: "left", "right" or "center".
For environments other than Java, C# or JavaScript, the GLG_TOOLTIP_TEXT_ALIGNMENT environment variable can also be used and set to one of the following strings: LEFT, RIGHT or CENTER.
GlgNativeTooltip
(Java and C# only)
Double
GLG_TOOLTIP
Controls the type of the tooltips in the Java and C#/.NET environments; may be set to the following values:
  • GLG_TOOLTIP - uses GLG tooltips.
    In Java, this setting should be used to properly handle dynamically changing tooltips for buttons with the GlgButton and GlgNButton interaction handlers.
  • BOX_TOOLTIP - enables native tooltips of the box style. In Java, native tooltips are used only for buttons with the GlgButton and GlgNButton interaction handlers, and GLG tooltips are still used for object tooltips.
  • BALLOON_TOOLTIP (C# only) - enables C# balloon tooltips.
GlgButtonTooltip-
Timeout
Double
0.5
The button tooltip timeout in seconds.
For environments other than Java, C# or JavaScript, the GLG_BUTTON_TOOLTIP_TIMEOUT environment variable may also be used to specify the timeout.
GlgMouseTooltip-
Timeout
Double
0.5
The "object mouse over" tooltip timeout in seconds.
For environments other than Java, C# or JavaScript, the GLG_MOUSE_TOOLTIP_TIMEOUT environment variable may also be used to specify the timeout.
GlgTouchTooltip-
Timeout
(JavaScript only)
Double
1.0
The "touch and hold" tooltip timeout in seconds for JavaScript deployed on mobile devices with a touch screen.
GlgDoubleClick-
Timeout
Double
0.5
The maximum time interval in seconds between two consecutive mouse clicks interpreted as a double-click. Two mouse clicks separated by a time interval greater than this interval will be reported as single clicks.
For environments other than Java, C# or JavaScript, the GLG_DOUBLE_CLICK_TIMEOUT environment variable may also be used to specify the timeout.
GlgDoubleClickDelta
Double
5
The maximum distance in pixels between two consecutive mouse clicks interpreted as a double-click. Two mouse clicks separated by a distance greater than this value will be reported as single clicks.
For environments other than Java, C# or JavaScript, the GLG_DOUBLE_CLICK_DELTA environment variable may also be used to specify the timeout.
GlgURLTimeout
(Java and C# only)
Double
-1
Defines the URL load timeout in seconds. If it is set to a value greater than zero, loading operations that use a URL as a source will timeout and generate an error after the timeout interval specified by this resource. It may be used in mission-critical applications to abort loading remote resources from URLs if it takes too long for the remote server to respond.
GlgZoomToButton
Double
1
The mouse button used by the ZoomTo operation.
GlgPanDragButton
Double
1
The mouse button used for panning and scrolling by dragging the drawing with the mouse.
GlgPickResolution
Double
5
Defines pick resolution for user input. When the mouse is within this many pixels of a point, it is considered to be on that point.
GlgChartCacheUse
Double
-1
If it is set to a value greater or equal than zero, it defines a global chart cache use setting for all charts. It overrides the setting of each plot's CacheUse attribute and provides a convenient way to test application performance with and without a cache.
For environments other than Java, C# or JavaScript, the GLG_CHART_CACHE_USE environment variable may also be used to specify the global cache use setting.
GlgChartCacheExtraSamples
Double
10
Defines a number of extra data samples created when a cache is prefilled. The size of the preallocated cache will be equal to the chart's buffer size plus the number of extra data samples.
For environments other than Java, C# or JavaScript, the GLG_CHART_CACHE_EXTRA_SAMPLES environment variable may also be used to specify the number of extra samples.
GlgSaveFormat
String
"ascii"
Defines a default save format ("binary", "ascii" or "extended").
GlgLocaleType
(C/C++ only)
String
null
Specifies the default locale type which will be used by all viewports with the LocaleType attribute set to Default, and all top-level viewports with LocaleType=Inherit. It may be set to the following values defined in the GlgApi.h file:
GLG_DEFAULT_LOCALE = 0
GLG_UTF8_LOCALE = 2
GLG_XFT_CHAR8_LOCALE = 3
   (Linux/Unix only)
The GLG_LOCALE_TYPE environment variable can also be used and set to one of the following strings: DEFAULT, UTF8 or XFT_LATIN1.
Alternatively, the -glg-utf8, -glg-default-locale and
-glg-xft-latin1 command-line options can be used.
GlgDefaultCharset
(Java only)
String
null
Specifies the name of a Java charset that will be used as the default charset. If it is set to null, the platform's default charset will be used. The default charset controls string decoding in the loaded GLG drawings if the load method does not explicitly specify a charset name.
GlgDefaultEncoding
(C# and JavaScript only)
Encoding
null
Specifies the name of a C# or JavaScript encoding that will be used as the default encoding. If it is set to null, the platform's default encoding will be used. The default encoding controls string decoding in the loaded GLG drawings if the load method does not explicitly specify an encoding.
For the JavaScript, the following encodings are supported: ASCII, UTF8 and LATIN1
(ISO-8859-1).
GlgCompressFormat
String
"uncompressed"
Enables saved drawing compression ("compressed" or "uncompressed").
GlgPSLevel
Double
2
The level of the PostScript output (1 or 2).
GlgSearchPath
(C/C++ and ActiveX only)
String
GLG_PATH
env. var. or
NULL
The search path used to resolve not found relative file names. May be changed from a program.
The GLG_PATH environment variable can also be used to define a search path. The search path can contain multiple directory entries separated by a colon on Linux/Unix or by a semicolon on Windows.
GlgCustomDataLib
(C/C++ and ActiveX only)
String
NULL
The filename of a custom data browser DLL.
The GLG_CUSTOM_DATA_LIB environment variable can also be used to define the DLL filename.
GlgLogLevel
(all environments except Java and
JavaScript)
Double
5
Controls logging of errors and warnings, may be set to the following values defined in the GlgApi.h file:
GLG_DISABLE_LOGGING = 0
GLG_LOG_INTERNAL_ERRORS = 1
GLG_LOG_USER_ERRORS = 2
GLG_LOG_WARNINGS = 3
GLG_LOG_INFO_MESSAGES = 4
GLG_LOG_ALL = 5
For C/C++ and ActiveX environments, the GLG_LOG_LEVEL environment variable can also be used and set to a desired numerical value.
GlgSelectAllOnFocus
Double
0
May be used to override highlighting behavior of text boxes. If set to 0 (default), the text will be highlighted on gaining focus for all text boxes in the GLG editors, and also for the text boxes in the drawing that have their SelectAllOnFocus resource set. If set to 1, the text will always be highlighted on focus in all text boxes regardless of the setting of their SelectAllOnFocus resources. If set to -1, the text will not be highlighted.
GlgTabNavigation
(all environments except Java and
JavaScript)
Double
1
Controls tab navigation traversal order, may be set to the following values defined in the GlgApi.h file:
GLG_TAB_NONE = 0
GLG_TAB_TEXT_BOXES = 1
GLG_TAB_BUTTONS = 2
GLG_TAB_TEXT_AND_BUTTONS = 3
For C/C++ and ActiveX environments, the GLG_TAB_NAVIGATION environment variable can also be used and set to a desired numerical value.
GlgNativeScrollbars
Double
0 for Qt and Gnome integrations
1 for all other environments
Enables (1) or disables (0) the use of native scrollbars used for integrated scrolling. If disabled, GLG viewport-based scrollbars will be used.
For C/C++ and ActiveX environments, the GLG_NATIVE_SCROLLBARS environment variable can also be used and set to either True or False.
GlgNativeScrollbarWidth
Double
Depends on the run time environment
Specifies the width of native scrollbars used for integrated scrolling.
For C/C++ and ActiveX environments, the GLG_NATIVE_SCROLLBAR_WIDTH environment variable can also be used and set to a desired numerical value.
GlgScrollbarWidth
Double
15
Specifies the width of GLG viewport and light viewport scrollbars used for integrated scrolling.
For C/C++ and ActiveX environments, the GLG_SCROLLBAR_WIDTH environment variable can also be used and set to a desired numerical value.
GlgHScrollbar
GlgObject
NULL
Specifies a custom horizontal scrollbar to be used for integrated scrolling.
GlgVScrollbar
GlgObject
NULL
Specifies a custom vertical scrollbar to be used for integrated scrolling.
GlgJavaScriptFile
(all environments except JavaScript)
String
NULL
Specifies a global JavaScript file that contains definitions of global functions.
For environments other than Java, C# or JavaScript, the GLG_JAVA_SCRIPT_FILE environment variable or the -glg-java-script-file command-line option may also be used to specify the file.
In the JavaScript environment, a global JavaScript file can be included in HTML as a script file.
GlgJavaScriptArg-
Check
(C/C++ and ActiveX only)
Double
1 in the GLG editors
0 at run time
The setting of 1 activates a slower strict mode that performs additional check of the script expression's arguments. When set to 0, a relaxed mode is used for faster execution.
GlgAsyncImage-
Loading
(Java and C# only)
Double
0
Controls the global image and GIS map loading mode for the entire application. May be set to 0 for the synchronous loading mode, or to 1 for asynchronous loading.
The AsyncMode attribute may be used to override the global setting for the image and GIS objects.
GlgChangeCursorOnGrab
Double
1
If set to 1, slider and knob widgets will change cursor when they are moved or dragged with the mouse. Setting the resource to 0 disables cursor change.
Alternatively (for environments other than Java, C# or JavaScript), the cursor change behavior may be controlled by setting the GLG_CHANGE_CURSOR_ON_GRAB environment variable to either True or False.
GlgAntiAliasing
Double
GLG_ANTI_
ALIASING_INT
In C/C++/C# and ActiveX, controls the default anti-aliasing setting of the OpenGL renderer.
In C# and JavaScript, controls the default anti-aliasing setting of the GDI+ or web browser renderer.
The default setting is inherited by all polygons with the INHERIT (default) setting of the AntiAliasing attribute. The following values are supported:
  • GLG_ANTI_ALIASING_OFF - disables antialiasing.
  • GLG_ANTI_ALIASING_INT - enables antialiasing and maps vertices to integer pixel boundaries.
  • GLG_ANTI_ALIASING_DBL - enables antialiasing and uses double vertex coordinates.
In C#, the above constants are elements of the GlgAntiAliasingType enum.
In Java, the resource controls the default anti-aliasing setting and may be set to 1 to enable anti-aliasing, or to 0 to disable it.
Alternatively (for environments other than Java, C# or JavaScript), the antialiasing may be disabled by setting the GLG_ANTI_ALIASING environment variable to False.
GlgDisableMouse-
ButtonCheck
Double
0
If set to 1, disables the test of the mouse button number in the mouse click actions. It may be used to deploy applications on devices with a touch screen, so that actions that use the right mouse button will be activated on touch without checking the mouse button number. One example is deploying a GLG application on mobile phones using the GLG JavaScript API.
GlgDisable-
ControlKeyCheck
Double
0
If set to 1, disables the test of the Control key state in the mouse actions with the ProcessArmed condition. It may be used to deploy an application on devices with a touch screen and no physical keyboard, so that actions with the ProcessArmed condition will be activated on touch without checking the state of the Control key.
GlgSliderTouchDrag
(JavaScript only)
Double
1
May be set to 0 to disable dragging sliders and knobs with a touch and drag on mobile devices with a touch screen, in case when it interferes with scrolling the page via touch and drag.
GlgWrapNativeLabels
(JavaScript only)
Double
1
May be set to 0 to disable wrapping text labels in native buttons and toggles.
The wrapping is enabled by default, unless it is disabled by GlgSetNativeAttributes set to 0.
GlgAdjustNative-
LabelColor
(JavaScript only)
Double
1
May be set to 0 to disable color adjustment for text labels in native widgets, such as buttons, toggles, lists, combo boxes, etc. If the background color of a native widget is dark, the color of the text label is set to white by default to improve label visibility.
The color adjustment is enabled by default, unless it is disabled by GlgSetNativeAttributes set to 0.
GlgXResourceFile
String
NULL
Specifies location of the X resource file that can be used to define custom XFT font settings used by the native input objects in both the GLG editors and the C/C++ executables on Linux.
Alternatively, the GLG_X_RESOURCE_FILE environment variable or the -glg-x-resource-file command-line option may be used to specify the resource file location.
A sample glg_x_resource_file file with default settings is provided in the src directory of the GLG installation.
GlgNativeWidgetsXft
Double
1
May be set to 0 to disable the use of XFT fonts by native input objects for C/C++ executables on Linux for backward compatibility.
Alternatively, the use of XFT fonts may be disabled by setting the GLG_NATIVE_WIDGETS_XFT environment variable to false, as well as using the -glg-native-widgets-xft command-line options.
GlgAdjustNative-
LabelColor
(JavaScript only)
Double
1
May be set to 0 to disable color adjustment for text labels in native widgets, such as buttons, toggles, lists, combo boxes, etc. If the background color of a native widget is dark, the color of the text label is set to white by default to improve label visibility.
The color adjustment is enabled by default, unless it is disabled by GlgSetNativeAttributes set to 0.
GlgOpenGLMode
(C/C++ and ActiveX only)
Double
1
Controls the use of the OpenGL renderer. If set to 1, the OpenGL renderer is used for the viewports with OpenGLHint=ON if the OpenGL renderer is available. Setting the resource to 0 suppresses the use of the OpenGL renderer.
Alternatively, the OpenGL renderer may be enabled or disabled by setting the GLG_OPENGL_MODE environment variable to true or false, as well as using the -glg-enable-opengl and
-glg-disable-opengl command-line options.
GlgOpenGLVersion
(C/C++ and ActiveX only)
Double
300
Requests the OpenGL version to be used. The shader-based core OpenGL profile is used for OpenGL versions higher than 3.00, and the Compatibility profile is used for older OpenGL versions. The Core profile is used by default. If the graphics card doesn't support core profile, the driver will automatically revert to the compatibility profile. If the graphics card doesn't support OpenGL, the GDI driver will be used.
Alternatively, the GLG_OPENGL_VERSION environment variable or the
-glg-opengl-version <NNN> command-line option may be used to define the OpenGL version at run time.
GlgOpenGL-
HardwareVendor
GlgOpenGL-
HardwareRenderer
GlgOpenGL-
SoftwareVendor
GlgOpenGL-
SoftwareRenderer
(C/C++ and ActiveX only)
String
NULL
Read-only resources that provide an application access to the OpenGL vendor and renderer strings for the hardware and software OpenGL.
These resources will be set after the viewport that uses a corresponding OpenGL driver is drawn the first time.
GlgOpenGL-
HardwareThreshold
(C/C++ and ActiveX only)
Double
1
Controls the runtime mapping of the OpenGL priorities specified by a viewport's OpenGLHint attribute. All viewports with a non-zero value of the attribute, less than or equal to the threshold value, will be rendered using the hardware OpenGL renderer (if available).

Viewports with attribute values between the GlgOpenGLHardwareThreshold and GlgOpenGLThreshold will be rendered using the software OpenGL renderer (if available).
Alternatively, the GLG_OPENGL_HARDWARE_THRESHOLD environment variable or the
-glg-opengl-hardware-threshold <N> command-line option may be used to define the threshold at run time.
GlgOpenGLThreshold
(C/C++ and ActiveX only)
Double
10
Controls the runtime mapping of the OpenGL priorities specified by a viewport's OpenGLHint attribute. All viewports with attribute values greater than the threshold value will be rendered using the GDI renderer.
Alternatively, the GLG_OPENGL_THRESHOLD environment variable or the
-glg-opengl-threshold <N> command-line option may be used to define the threshold at run time.
GlgOpenGLFull-
Redraw
(C/C++ and ActiveX only)
Double
-1
Controls what portion of the viewport will be redrawn when only a part of the viewport needs to be updated for hardware-accelerated OpenGL with double buffering. If set to 0, only the changed portion of the viewport will be redrawn. Setting the resource to 1 causes the whole viewport to be updated, which helps to eliminate flickering on non-NVidia graphics cards. The default -1 setting automatically selects redraw mode depending on the detected graphics card.
Alternatively, a True or False setting of the GLG_OPENGL_FULL_REDRAW environment variable, or -glg-opengl-enable-full-redraw and -glg-opengl-disable-full-redraw command-line options may be used to define redraw policy.
GlgGLXPixmapDB
(C/C++ and ActiveX only)
Double
0
Controls the type of double buffering used by the hardware-accelerated OpenGL. If set to 0 (default), the double buffering will be performed using the OpenGL back buffer. If set to 1, the double-buffering will be performed by using an off-screen pixmap instead of the OpenGL back buffer.
Alternatively, the GLG_GLX_PIXMAP_DB environment variable may be set to True or False to define the double buffering type.
GlgOpenGLNativeLineAA
(C/C++ and ActiveX only)
Double
-1
Controls the anti-aliasing technique used by the core profile of the hardware-accelerated OpenGL. If set to 1, line anti-aliasing will be performed using the line anti-aliasing capabilities provided by the graphics card. These capabilities are optional and may be substandard or not implemented for graphics cards other than NVidia.
If set to 0, shader-based anti-aliasing will be used. The default value of -1 detects if the graphics card supports line anti-aliasing and automatically selects the anti-aliasing type.
Alternatively, the GLG_OPENGL_NATIVE_LINE_AA environment variable may be set to True or False to define the anti-aliasing type.
GlgOpenGLZSort
(C/C++ and ActiveX only)
Double
2
Controls the number of passes used to eliminate pixel artifacts when drawing polygons with both fill and edges. If polygons have only fill or only edges, the resource can be set to 1 to use a single pass for increased performance. Setting the resource to 0 disables OpenGL hidden surface removal and resorts to the slower non-OpenGL depth-sorting technique.
Alternatively, the GLG_OPENGL_ZSORT environment variable may be used to define the number of passes.
GlgOpenGLDepth-
Offset
(C/C++ and ActiveX only)
Double
100
Controls the depth offset used by the second pass of the hidden surface removal to offset edges of polygons.
Alternatively, the GLG_OPENGL_DEPTH_OFFSET environment variable may be used to define the offset.
GlgOpenMesaLibPath
(C/C++ on Linux/Unix only)
String
NULL
Specifies the location of the libOSMesa library used for the software OpenGL. The library is located in the lib directory of the GLG installation and is found there by default if the GLG_DIR environment variable is set.
Alternatively, the GLG_OPENGL_MESA_LIB_PATH environment variable, or -glg-opengl-mesa-lib-path command-line options may be used to define the library location.
GlgOpenTessLibPath
(C/C++ on Linux/Unix only)
String
NULL
Specifies the location of the libtess_util library used by the software OpenGL renderer if the hardware OpenGL renderer is disabled. The library is located in the lib directory of the GLG installation. By default, it is searched for in the directory where the libOSMesa library was found.
Alternatively, the GLG_OPENGL_MESA_LIB_PATH environment variable, or -glg-opengl-tess-lib-path command-line options may be used to define the library location.
GlgMapServerUsage (C/C++ and ActiveX only)
Double
0
Controls the use of Map Server in C/C++ and ActiveX versions of GLG and may have one of the following values defined in the GlgApi.h file:
GLG_LOCAL_MAP_SERVER - uses the Map Server from the GLG library .
GLG_REMOTE_MAP_SERVER - uses the Map Server from a web server defined by the GISMapServerURL attribute of the GIS Object.
GLG_AUTO_MAP_SERVER (default) - if the drawing was loaded from a URL, use a remote Map Server, otherwise use a local Map Server.
May also be defined by setting GLG_MAP_SERVER_USAGE environment variable to the "auto", "local" or "remote" values.
GlgGISElevation
Layer

(GLG editors only)
String
NULL
Specifies the GIS elevation layer to be used for querying elevation in the map displayed in the GLG Builder or HMI Configurator.
GlgXftFonts
(C/C++ on Linux/Unix only)
Double
1
Controls the use of the XFT fonts: setting the resource to 0 disables XFT fonts, and setting it to 1 enables XFT fonts.
Alternatively, setting the GLG_XFT_FONTS environment variable to true or false, or using the
-glg-enable-xft-fonts and -glg-disable-xft-fonts command-line options may be used to enable or disable XFT fonts.
GlgDebugXftFonts
(C/C++ on Linux/Unix only)
Double
0
If set to 1, enables diagnostic output for troubleshooting XFT fonts. The output is displayed in the terminal, and is also saved in the glg_error.log file.
Alternatively, the GLG_DEBUG_XFT_FONTS environment variable may be set to true, or the
-glg-debug-xft-fonts may be used.
GlgDebugFonts
(C/C++ on Linux/Unix only)
Double
0
If set to 1, enables diagnostic output for troubleshooting font sets. Alternatively, the GLG_DEBUG_FONTS environment variable may be set to true, or the -glg-debug-fonts may be used. The output is displayed in the terminal, and is also saved in the glg_error.log file.
GlgDebugEncoding
(C/C++ and ActiveX only)
Double
0
If set to 1, enables diagnostic output for troubleshooting string encoding conversions. Alternatively, the GLG_DEBUG_ENCODING environment variable may be set to true, or the
-glg-debug-encoding command-line option may be used. The output is displayed in the terminal on Linux/Unix, and is also saved in the glg_error.log file.
GlgDefaultFontTable-
File

(except JavaScript)
String
NULL
The name of a drawing file containing a saved FontTable object to be used as a default font table.
For C/C++ and ActiveX environments, it may also be defined by setting the GLG_DEFAULT_FONT_TABLE_FILE environment variable.
The font table may be saved using the Save Font Table option of the viewport's FontTable object. The drawing can also contain a viewport object with a custom font table attached. In this case, the font table is searched using $Fonttable and then $Widget/Fonttable resource names. If still not found, the fonttable of a $Widget viewport is also considered.
GlgDefaultFontTable
GlgObject
NULL
The FontTable object to be used as a default font table. This resource can be used in a program that creates or loads a font table object at run time.
GlgDefaultFontFile
(except JavaScript)
String
NULL
Specifies name of an ASCII file that contains a list of font names for the default font table. Each font in the file is listed on a separate line.
For C/C++ and ActiveX environments, it may also be defined by setting the GLG_DEFAULT_FONT_FILE_NAME environment variable. The number of font types and sizes for the font table is specified using the GlgDefaultNumFontTypes and GlgDefaultNumFontSizes variables described below.
GlgDefaultFontURL
(Java and C# only)
String
NULL
Specifies a URL of an ASCII file that contains a list of font names for the default font table. Each font in the file is listed on a separate line. The number of font types and sizes for the font table is specified using the GlgDefaultNumFontTypes and GlgDefaultNumFontSizes variables described below.
GlgDefaultFontList
(JavaScript only)
String
NULL
A string containing a list of font names for the default font table in the format of GlgDefaultFontFile. The number of font types and sizes for the font table is specified using the GlgDefaultNumFontTypes and GlgDefaultNumFontSizes variables described below.
GlgDefaultXftFontFile
(except JavaScript)
String
NULL
Specifies name of an ASCII file that contains a list of XFT font names for the default font table. Each font in the file is listed on a separate line.
For the C/C++ environment, it may also be defined by setting the GLG_DEFAULT_XFT_FONT_FILE_NAME environment variable.
The number of font types and sizes for the font table is specified using the GlgDefaultNumFontTypes and GlgDefaultNumFontSizes variables described below.
GlgDefaultPSFont-
File
(except JavaScript)
String
NULL
Specifies name of the file that contains a list of PostScript font names for the default font table.
For C/C++ and ActiveX environments, it may also be defined by setting the GLG_DEFAULT_PS_FONT_FILE_NAME environment variable.
The number of font types and sizes for the font table in specified using the GlgDefaultNumFontTypes and GlgDefaultNumFontSizes variables described below.
GlgDefaultPSFont-
URL

(Java and C# only)
String
NULL
Specifies a URL of the file that contains a list of PostScript font names for the default font table.
The number of font types and sizes for the font table in specified using the GlgDefaultNumFontTypes and GlgDefaultNumFontSizes variables described below.
GlgDefaultNumFont-
Types
Double
12
Defines NumTypes attribute of the default font table.
For C/C++ and ActiveX environments, it may also be defined by setting the GLG_DEFAULT_NUM_FONT_TYPES environment variable to the desired integer value.
GlgDefaultNumFont
Sizes
Double
7
Defines NumSizes attribute of the default font table.
For C/C++ and ActiveX environments, it may also be defined by setting the GLG_DEFAULT_NUM_FONT_SIZES environment variable to the desired integer value.
GlgFontCharset (C/C++ and ActiveX only)
Double
0
Defines a charset to use for fonts with DEFAULT_CHARSET, providing a simple way to change the charset of all fonts in the default font table. May also be defined by setting GLG_FONT_CHARSET environment variable to the integer value of the desired font charset. If not set, the charset of the current system locale is used.
GlgMultibyteFlag (C/C++ and ActiveX only)
Double
0
Defines the value of the multi-byte flag to use for fonts with DEFAULT_CHARSET on Windows or for all fonts on X Windows. It provides a simple way to change the multi-byte flag setting for all fonts in the default font table and may also be defined by setting GLG_MULTIBYTE_FLAG environment variable to the "SINGLE_BYTE", "MULTI_BYTE" or "UTF8" values. If not set, the setting matching the current system locale (SINGLE_BYTE or MULTI_BYTE) is used.
GlgDefaultColor-
TableType
Double
1
Defines type of the default color table: RAINBOW (value of 1) or STANDARD (value of 2). For C/C++ and ActiveX environments, it may also be defined by setting the GLG_DEFAULT_COLOR_TABLE_TYPE environment variable to "rainbow" or "standard".
GlgDefaultColor-
Factor
Double
19
Defines ColorFactor of the default color table. For C/C++ and ActiveX environments, it may also be defined by setting the GLG_DEFAULT_COLOR_FACTOR environment variable to the desired integer value.
GlgDefaultNum-
ColorGrades
Double
1
Defines GradeHint of the default color table. For C/C++ and ActiveX environments, it may also be defined by setting the GLG_DEFAULT_NUM_COLOR_GRADES environment variable to the desired integer value.
GlgDefaultDialog-
Color

(C/C++ on Unix, Java and JavaScript)
G - holds 3 RGB color values
(-1;-1;-1)
Specifies default fill color for the dialog area widget type. If it is set to (-1;-1;-1), the FillColor of the dialog widget is used when the widget is displayed. On Windows, the system setting for the dialog color is used.
GlgIndexedColor-
TableFile

(except JavaScript)
String
NULL
A filename of a custom color palette drawing that defines a list of indexed colors.
For environments other than Java, C# or JavaScript, it may also be defined via the GLG_INDEXED_COLOR_TABLE_FILE environment variable.
GlgIndexedColor-
File

(except JavaScript)
String
NULL
A filename of an ASCII file that defines a list of indexed colors.
For environments other than Java, C# or JavaScript, it may also be defined via the GLG_INDEXED_COLOR_FILE environment variable.
GlgIndexedColor-
Table

(JavaScript only)
GlgObject
NULL
An object ID of a loaded custom color palette drawing that defines a list of indexed colors. This is the same drawing that is used for GlgIndexedColorTableFile in other environments.
GlgIndexedColor-
List

(JavaScript only)
String
NULL
A string containing a list of indexed colors in the format of GlgIndexedColorTableFile.
GlgDisableIndexed-
Colors
Double
0
If set to 1, disables the use of indexed colors for compatibility with any possible special use of RGB values in older releases.
For environments other than Java, C# or JavaScript, the GLG_DISABLE_INDEXED_COLORS environment variable may be set to true or false to control the use of indexed colors.
GlgIHArray
group
object
an array holding default GLG interaction handlers
The array of GLG Interaction Handlers (GlgButton, GlgSlider, etc.) used to resolve interaction handlers names. It may be used by a program to add custom interaction handlers.
GlgCompatibility-
Mode
Double
GLG_LATEST_RELEASE constant
Specifies compatibility mode. For example, when it is set to the GLG_PRE_2_9 constant, the release 2.9 changes which affect code compatibility with the older versions will be disabled. For C/C++ and ActiveX environments, this resource may also be defined by setting the GLG_COMPATIBILITY_MODE environment variable to the integer value corresponding to the desired constant.
GlgMaxDBFactor
 
Double
 
1.25
Controls the threshold for disabling double buffering for exceedingly large children viewports to avoid system slow-down due to swapping at high zoom factors. If the value of GlgMaxDBFactor is non-negative, the viewport's double buffering is disabled if:
      w * h > F * W * H
where w and h are the pixel width and height of the viewport, W and H are the width and height of the display, and F is the value of GlgMaxDBFactor.

If the value of GlgMaxDBFactor is negative, the double-buffering check is suppressed and the double-buffering is never disabled regardless of the viewport size.
In JavaScript, the GLG double buffering is disabled by default, since canvas in the browser is already double buffered.
For environments other than Java, C# or JavaScript, the GLG_MAX_DB_FACTOR environment variable may used to specify the GlgMaxDBFactor value.
GlgDisablePre35-
ObjectEvents
Double
1
When set to 0, disables processing of the old-style (prior to v. 3.5) tooltips, custom events and mouse feedback, which may reduce the CPU load when the mouse moves over a large drawing. For C/C++ and ActiveX environments, this resource may also be defined by setting the GLG_DISABLE_PRE35_OBJECT_EVENTS environment variable to True or False.
GlmMaxIterations
(C/C++ and ActiveX)
Double
10000
Defines the maximum number of internal iterations used to render filled polygons in the map server, which prevents rendering delays if the map is zoomed in too much. This parameter may need to be increased if large filled polygons (such as OSM country or state areas) are rendered with very high zoom levels. This value may be overridden by the MAX ITERATIONS parameter in the dataset's SDF file.

7.2 Appendix B: Message Object Resources

A message object is a GLG object used by the Toolkit to pass information about GLG input, object selection and other events to the Input callback. It is a group object containing data in the form of named resources. The Input callback code can query resources of the message object using the GLG GetResource methods. Refer to the Handling User Input and Other Events section of Using the C/C++ version of the Toolkit for more information on handling input events.

A message object is also used for returning multiple pieces of information from methods such as GlgCreateChartSelection, in which case the message does not include generic resources listed in the following section.

Generic Resources of the Message Object

All message objects received in the Input and other callbacks have the following named attributes:

Resource Name
Data Type
Description
Format
String

Defines the format of the message object and the resources present in it. It is defined by the event type and, for input messages, the type of the input handler which detected the input activity and sent the message. It may have values such as Button, Slider, Knob, ObjectSelection and CustomEvent.

Origin
String

Contains one of the following values:

  • The name of the viewport with an input handler that generated the input message
  • The name of the object that generated the custom event message
  • The name of the viewport that generated the window message
  • An empty string for object selection and other message types.
FullOrigin
String

Contains the full path name of the viewport that initiated an input or window message, or the full path name of the object that initiated a custom event message. This resource will be set to an empty string for other types of messages.

For composite input objects, such as a spinner, Origin and FullOrigin can point to different objects. For example, when an Increase or Decrease button of the spinner is activated, the Origin resource contains the name of the button that was pressed, while the FullOrigin resource contains the full path to the spinner that contains the button. Another example when Origin and FullOrigin point to a different object is when a text object of a spinner gains or loses focus, generating corresponding events

Action
String

Describes the input action occurred. It may have values of ValueChanged, Activated, MouseClick, MouseOver and so on (see below). All input handlers send Abort2 when they receive a middle mouse button click, and Abort3 when they receive a right mouse button click.

SubAction
String

Describes the action in more details. For example, for the ValueChanged action it describes what caused the value change and may have values such as Pick, Motion, Increase, and so on.

Object
GlgObject

The viewport object that triggered the Input callback, or the object that triggered custom event. This resource is present in all messages except the ObjectSelection message.


Specific Resources of the Message Object

A message object can have other resources as well, depending on the type of the input handler (for input events) or the type of the message (for object selection and custom events).

In the case of an input event, the message object includes all handler resources of the widget. For example, the message object coming from a GLG slider object may also contain such resources as ValueX, ValueY, Granularity, Increment, DisableMotion and others. These resources may be queried from either the message object or the viewport object that generated the message.

Handler resources not present in the viewport are not present in the message object. For example, a one-dimensional slider uses only one of its ValueX and ValueY resources, and the second resource will be absent from the message object. Several handlers define resources that appear only in the message object. For example, the GlgMenu input handler defines SelectedIndex and other resources used by the handler during its operation. All such resources are defined in the sections below.

The following sections describe the format of message objects generated by various input handlers as well as object selection and custom events. Refer to the Input Handlers section of the GLG User's Guide for a complete list of resources of various GLG input handlers.

Slider Message Object

This message object is generated by the GlgSlider or GlgNSlider input handlers whenever a user acts to change the position of the slider or scrollbar controlled by these input handlers.

Slider Message Object Resources
Resource
Value
Format
Slider
Action
  • ValueChanged indicates when a value change has resulted from a mouse click.
  • GrabPointer is issued when the mouse button is pressed over the slider active area, causing the mouse to assume control of the slider position. The SubAction is NULL.
  • UngrabPointer is issued when the mouse button is released, ending mouse control of the slider position. The SubAction is NULL.
  • RepeatStart and RepeatEnd are issued before and after the ValueChange messages that were generated by one of the slider's buttons (such as Increase or Decrease) and a button's repeated action was enabled by its RepeatTimeout resource.
SubAction
  • Click when a value change has resulted from a mouse click
  • Motion when a value change has resulted from a mouse motion while the left mouse button is held down
  • Increase, Decrease, PageIncrease or PageDecrease when a value change has resulted from activating the corresponding button.
Object

The slider's viewport.


The ValueX, ValueY, Granularity, Increment, DisableMotion and other slider resources are also present in the message object.

Knob Message Object

This message object is generated by the GlgKnob input handler whenever a user acts to change the position of the knob.

Knob Message Object Resources
Resource
Value
Format
Knob
Action
  • ValueChanged indicates when a value change has resulted from a mouse click
  • GrabPointer is issued when the mouse button is pressed over the slider active area, causing the mouse to assume control of the slider position. The SubAction is NULL.
  • UngrabPointer is issued when the mouse button is released, ending mouse control of the slider position. The SubAction is NULL.
  • RepeatStart and RepeatEnd are issued before and after the ValueChange messages that were generated by one of the knob's buttons (such as Increase or Decrease) and a button's repeated action was enabled by its RepeatTimeout resource.
SubAction
  • Click when a value change has resulted from a mouse click
  • Motion when a value change has resulted from a mouse motion while the left mouse button is held down
  • Increase, Decrease , PageIncrease or PageDecrease when a value change has resulted from activating the corresponding button.
Object

The knob's viewport.


The Value, Granularity, Increment, DisableMotion and other knob resources are also present in the message object.

Button Message Object

This message object is generated by the GlgButton or GlgNButton input handlers whenever a user presses the button or toggle controlled by these handlers.

Button Message Object Resources
Resource
Value
Format
Button
Action
  • Activate when activating push buttons without OnState resource or native push buttons.
  • ValueChanged when activating toggle buttons with OnState resource or native toggle buttons.
  • RepeatStart and RepeatEnd are issued before and after the Activate
    messages if the button's repeated action was enabled by its RepeatTimeout resource.
  • Update for various miscellaneous actions, in which case SubAction will indicate the action type.
SubAction
  • InState when InState changes (GlgButton)
  • PressedState when PressedState changes (GlgButton)
  • ArmedState when ArmedState changes (GlgButton)
  • Pressed or Released (X/Motif push button with the GlgNButton handler)
Object

The button's viewport.


As with all the message objects, the button message object also includes the handler resources that are used in the widget, such as PressedState, OnState and others. Refer to the Input Handlers section of the GLG User's Guide for a complete list of resources of the GlgButton and GlgNButton input handlers.

Text Message Object

This message object is generated by the GlgText or GlgNText input handlers whenever a user enters text into the text input widget controlled by these input handlers.

Text Widget Message Object Resources
Resource
Value
Format
Text
Action
  • Activate if the Enter key was pressed at the end of text input.
  • ValueChanged is generated for one of the following events:
    - if a key press changes the string displayed in a string text input
    - if the Enter key is pressed at the end of a numerical text input
    - if the value of a numerical text input has changed and the text input is about to lose focus.
  • Focus if the text input gained the input focus (GlgNText handler only).
  • LosingFocus if the text input lost the input focus (GlgNText handler only).
  • Update for any other key press or user action. This includes changing the current value displayed in a numerical text input, in which case the ValueChanged action will be generated when the user finishes entering a new value and either presses Enter or moves focus away from the text input.
SubAction

none

Object

The text widget's viewport.


The TextString resource and, for numerical inputs, Value resource are present in the message object even if they do not exist in the Text Widget's viewport, allowing the current values to be passed in the message. The MaxLength and, for numerical inputs, the MinValue, MaxValue, EnforceRange, InputInvalid and ValueFormat resources are also present in the message object.

Spinner Message Object

This message object is generated by the GlgSpinner input handlers whenever a user changes the spinner's value.

Spinner Widget Message Object Resources
Resource
Value
Format
Spinner
Action
  • ValueChanged if the spinner's value has changed
  • Update for any other user interaction.
  • Activate if the spinner's Done button was pressed. The Activate action of the spinner's text input object is also propagated to the spinner.
  • RepeatStart and RepeatEnd are issued before and after the ValueChange messages that were generated by one of the spinner's or spinner slider's buttons (such as Increase or Decrease) and a button's repeated action was enabled by its RepeatTimeout resource.
SubAction

For ValueChange actions, indicates the origin of the action, such as Slider, TextInput, Increase or Decrease buttons. It is set to NULL otherwise.

Object

The spinner widget's viewport.


All resources of the spinner, such as Value, MinValue, MaxValue, Increment, etc. are also present in the message object.

List Message Object

This message object is generated by the GlgNList input handlers when a user selects items in a list widget controlled by this input handler.

List Widget Message Object Resources
Resource
Value
Format

List

Action
  • Select if an item was selected or deselected.
  • Update for any other key.
SubAction

DoubleClick if the item was selected using a double-click, otherwise NULL.

Object

The list's viewport.


The GlgSendMessage method may be used to get extended selection information for a multiple selection list widget.

Option Message Object

This message object is generated by the GlgNOption input handlers when a user changes an option selection in an option menu or combox box widget controlled by this input handler.

List Widget Message Object Resources
Resource
Value
Format

Option

Action
  • Select if a new option was selected.
  • Update for any other key.
SubAction

none

Object

The option widget's viewport.


Menu Message Object

This message object is generated by the GlgMenu input handler whenever a user presses a button in the menu.

Menu Message Object Resources
Resource
Value
Format

Menu

Action

Activate

SubAction

none

Object

The menu's viewport.


The SelectedIndex and SelectedString resources are present in the message object even if they do not exist in the menu viewport, allowing the menu to pass information about the selection with the message.

Clock and Stopwatch Message Object

The first message is generated by the clock and stopwatch widgets (GlgClock input handler) when they update the graphical representation of the clock. This is invoked automatically every second. If seconds are not displayed, the callback is invoked once per minute, instead.

The second message is only called from a stopwatch widget, whenever a user presses one of the control buttons.
Clock Widget Message Object Resources
Resource
Value
Format

Clock

Action

Update

SubAction

none

Object

The widget's viewport.

Stopwatch Widget Message Object Resources
Resource
Value
Format

Clock

Action

Start, Stop, or Reset depending on the corresponding stopwatch button.

SubAction

none

Object

The widget's viewport.

Either message object will also contain resources of GlgClock input handler such as Sec, ValueSec, and so on. For the Stopwatch Widget, the Sec resource is present in the message object even if it does not exist in the stopwatch's viewport.

Timer Message Object

This message object is generated automatically by the GlgTimer input handler upon every update of the timer output Value.

Timer Widget Message Object Resources
Resource
Value
Format

Timer

Action

Update

SubAction

none

Object

The timer's viewport.


The program should call the GlgUpdate() function to make the changes caused by the timer visible. The remaining resources of the message object (Interval, Period, ActiveState, and so on) can be used to change the timer's state and parameters. The timer handler has been superseded by the timer transformation in the release 2.8 of GLG.

Palette Message Object

This message object is generated by the GlgPalette input handler whenever a user selects one of the objects in the palette with the left mouse button, or changes the selection by dragging the mouse over the palette.

Palette Message Object Resources
Resource
Value
Format

Palette

Action
  • Activate when a selection is made with a mouse click
  • ValueChanged when the selection is changed due to a mouse dragging.
SubAction

Click or Motion

Object

The widget's viewport.


The palette's message object also has a resource named SelectedObject. This resource refers to the object selected and is used to get values of the that object's attributes. For example, for a color palette, the SelectedObject/FillColor resource of the message object yields the chosen color.

Font Browser Message Object

This message object is generated by the GlgBrowser input handler whenever any input activity is detected in the font browser controlled by the input handler.

Font Browser Message Object Resources
Resource
Value
Format

FontBrowser

Action
  • Activate when the Done button of the Font Browser is activated
  • Cancel when the Cancel button is pressed.
  • Update on any other activity in the Font Browser.
SubAction

none

Object

The widget's viewport.


All the resources of the font browser widget are also present in the message object, allowing the font selection to be passed in the message.

Browser Message Object

This message object is generated by the GlgBrowser input handler whenever any input activity is detected in the resource, tag, alarm or custom data browser controlled by the input handler.

Browser Message Object Resources
Resource
Value
Format

Browser

Action
  • Activate when the Done button of the Browser is pressed.
  • Cancel when the Cancel button is pressed.
  • Select when the user clicks on a list entry.
  • Update on any other activity in the Browser.
SubAction

For the Update action, the SubAction may be DoubleClick when the user double-clicks to open another hierarchy level. Otherwise, this resource is not used.

Object

The browser's viewport.


The Input callback is called with Activate as the value of the Action resource when the Done button of the file browser is activated, or when the Enter key is pressed with the keyboard focus in the Path text widget and the string is a valid ID (resource name, tag name, etc.) of some element in the browser list.

Zoom Message Object

This message object is generated when a zoom or pan operation is performed, activated either by user interaction or programmatically.

Zoom Message Object Resources
Resource
Value
Format

Zoom

Action
  • Zoom
  • Pan
  • ScrollbarChange
    Generated when an X or Y scrollbar is drawn or erased in the AutoPan mode.
SubAction
  • Left, Right, Up, Down, X, Y, x or y for the Pan action.
  • ZoomIn, ZoomOut or Reset for the Zoom action.
  • Set for the fit to box Zoom actions (`F' and `f').
  • ResetX or ResetY for corresponding `N' and `n' Zoom actions in the Chart Zoom mode.
  • Start, End or Abort for the ZoomTo mode of the Zoom action or the Dragging mode of the Pan action: notifies about the start, end or abort of the action.
  • Drag for the Dragging mode of the Pan action. Repeated messages are generated to notify about the drag action in progress.
  • ZoomRectangle for the ZoomTo mode of the Zoom action: notifies that zoom rectangle was created and is accessible .
  • ZoomRectangleChange for the ZoomTo mode of the Zoom action: notifies that the ZoomTo rectangle was resized by the mouse move.
  • ZoomRectangleEnd for the ZoomTo mode of the Zoom action: notifies that the ZoomTo rectangle is about to be destroyed and may be used to extract the final ZoomTo extent.
Object

The viewport that triggered the message.


The Start and End subactions are generated when the ZoomTo, custom zoom or dragging operation is started or finished. The Reset subaction is generated when the zooming state is reset using the `n' or `N' zoom action. The Set subaction is generated when the drawing is zoomed, paned or rotated using any zoom actions other than ZoomTo, custom zoom or Reset. The ZoomRectangle subaction indicates that the ZoomTo rectangle has been created and is accessible via the GlgZoomRect resource of the viewport in the ZoomTo mode. The ZoomRectangleChange and ZoomRectangleEnd subactions notify the application that the zoom rectangle is resized with the mouse or about to be destroyed at the end of the ZoomTo action.

Custom Event Message Object

This message object is generated by a GLG drawing when a mouse event triggers a custom event action (with ActionType=SEND_EVENT) attached to an object. Depending on the action's Trigger, an action is triggered when an object it is attached to is either clicked on with the mouse, the mouse moved over the object, or, for input objects, a matching input activity has occurred. Alternatively, the message may also be generated by the old-style (prior to v. 3.5) MouseClickEvent or MouseOverEvent custom properties attached to the object instead of an action object.

For actions with the MOUSE_CLICK and MOUSE_OVER triggers, two types of messages are generated: an activation message is generated when the action is activated by a mouse click or mouse over event, and a deactivation message is generated when the action ends due to the mouse button being released or the mouse moving away from the object.

Actions that are sensitive to the state of the Control key (actions with ProcessArmed set to a value other than NONE) may also be activated and deactivated by changes of the state of the Control key, in which case the SubAction parameter of the message in the Input callback will be set to ArmedChange:

For the MOUSE_OVER actions, the deactivation message may not be generated if the mouse moves to another object, triggering an activation message for a MOUSE_OVER action attached to another object.

Messages generated when an action is activated contain information about the action, its EventLabel and the object the action is attached to.

Messages generated on action deactivation have an empty EventLabel and do not contain any additional information. If a program need this information, it can store it when the action is activated.

The viewport's ProcessMouse attribute has to include an appropriate Move and/or Click mask to enable custom event processing (except for actions with Trigger=INPUT). The Input callback can use the message object's resources to process the custom event. This message is invoked for any viewport object and does not require an input handler.

Custom Event Message Object Resources
Resource
Value
Format

CustomEvent

Action
  • MouseOver when a MOUSE_OVER action is activated or deactivated.
  • MouseClick or DoubleClick when a MOUSE_CLICK action is activated, depending on the type of the click and the setting of the
    ProcessDoubleClick action attribute.
  • MouseRelease when a MOUSE_CLICK action is deactivated.
  • InputObject for actions with Trigger=INPUT.
SubAction
  • Armed if the Control key was pressed when activating actions with
    ProcessArmed set to ARMED_ONLY or ARMED_AND_UNARMED.
  • ArmedChange if an action was activated or deactivated due to a change of the state of the Control key.
  • none (an empty string) for all other actions.
EventLabel
  • When activating an action: the value of the action's EventLabel attribute, or the string value of the old-style (prior to v. 3.5) MouseOverEvent or MouseClickEvent properties if the custom event was generated by these properties.
  • When deactivating an action: none (an empty string).
ButtonIndex
  • When activating MOUSE_CLICK actions: an index of the button that
    generated the custom event.
  • A value of 0 for all other actions.
ActionObject
  • When activating an action: the action that generated the message.
  • NULL when deactivation an action, or when activating a custom event generated by the old (prior to v. 3 5) custom event properties.
Object
  • When activating mouse actions: the top-level object that generated the custom event. For example, if a group object has a MOUSE_CLICK action attached, the group will be used as the Object resource when any object in the group is selected with the mouse.
  • When deactivating mouse actions: NULL.
  • For input actions (Trigger=INPUT): the input object the action is attached to.
OrigObject
  • When activating mouse actions: the low-level object that generated the
    custom event. If a group object has a MOUSE_CLICK action attached, the Object resource is the group and OrigObject is the object inside the group that was actually selected with the mouse.
  • When deactivating mouse actions: NULL.
  • For input actions (Trigger=INPUT): the input object the action is attached to.

The GetResourceObject method may be used to get the object ID of the object and origin object from the message using the Object and OrigObject resource names:

GlgObject object = GlgGetResourceObject( message_object, "Object" );

The resources of the object and origin object may be accessed through the message object using the Standard API. For example, the Object/FillColor resource name may be used to access the FillColor attribute of the object as a resource of the message object:

GlgSetGResource( message_object, "Object/FillColor", 1., 0., 0. );

If the ActionObject resource of the message is not NULL, the action data may be accessed via the ActionObject/ActionData resource.

Command Message Object

This message object is generated by a GLG drawing when a command action is triggered by a mouse event or an input object. The viewport's ProcessMouse attribute has to include an appropriate Move and/or Click mask to enable processing of command actions (except for actions with Trigger=INPUT). The Input callback can use the message object's resources to process the command. This message is invoked for any viewport object and does not require an input handler.

Command Message Object Resources
Resource
Value
Format

Command

Action
  • MouseClick for commands with Trigger=MOUSE_CLICK.
  • MouseOver for commands with Trigger=MOUSE_OVER.
  • Input for commands with Trigger=INPUT.
SubAction
  • Armed when activating actions with ProcessArmed=ARMED_ONLY, or if the Control key was pressed when an action with
    ProcessArmed=ARMED_AND_UNARMED was activated.
  • none (an empty string) for all other actions.
EventLabel

The value of the action's EventLabel attribute.

ActionObject

The action that generated the message.

Object
  • For commands activated by the mouse: the top-level object that generated the command. For example, if a group object has a MOUSE_CLICK
    command action, the group will be used as the Object resource when any object in the group is selected with the mouse.
  • For input object commands
    (Trigger=INPUT): the input object the action is attached.
OrigObject
  • For commands activated by the mouse: the low-level object that originated the command. If a group object has a MOUSE_CLICK action attached, the Object resource is the group and OrigObject is the object inside the group that was actually selected with the mouse.
  • For input object commands (Trigger=INPUT): the input object the action is attached.

Tooltip Message Object

This message object is generated by a GLG drawing when a tooltip is activated or erased. The viewport's ProcessMouse attribute has to include Tooltip mask to enable object tooltips in the drawing (button tooltips do not require the mask and are always active). The Input callback can use the message object's resources to process the tooltip event. This message is invoked for any viewport object and does not require an input handler.

Tooltip Message Object Resources
Resource
Value
Format

Tooltip

Action
  • ObjectTooltip when an object tooltip is activated, or when a non-button tooltip (object or special) is erased.
  • ButtonTooltip when a button tooltip is activated or erased.
  • SpecialTooltip when a chart or axis tooltip is activated.
SubAction

none

EventLabel
  • The tooltip string for the tooltip display events
  • An empty string if the tooltip event is generated when the mouse moves away from the object and the tooltip is erased.
ActionObject
  • The tooltip action that generated object tooltip.
  • NULL for old-style (prior to v. 3 5) and button tooltips, as well as when the message is generated on erasing a tooltip.
Object
  • The top-level object that has a tooltip attached. For example, if a group object has a tooltip, the group will be used as the Object resource when a mouse hovers over any object in the group.
  • NULL if the message is invoked on erasing a tooltip.
OrigObject
  • The low-level object the mouse is hovering at. If a group object has the custom events defined, the Object resource is the group and OrigObject is the object inside the group that is under the mouse.
  • NULL if the message is invoked on erasing a tooltip.

UpdateDrawing Message Object

This message object is generated by a GLG drawing when a SET_STATE, RESET_STATE or TOGGLE_STATE action type is triggered. The Input callback can use this message to update the top-level drawing when the State attribute of the action is constrained to an object in another viewport, and that viewport needs to be redrawn when the value of the State object changes. This message is invoked for any viewport object and does not require an input handler.

UpdateDrawing Message Object Resources
Resource
Value
Format

UpdateDrawing

Action

Update

SubAction

none


ImageLoad Message Object

This message object is generated by a GLG drawing in the Java, C# and JavaScript environments when an image with an asynchronous load type finishes loading its data. The Input callback can use this message to update the drawing. This message is invoked for any viewport object and does not require an input handler.

ImageLoad Message Object Resources
Resource
Value
Format

ImageLoad

Action

Update

SubAction

none


TemplateLoad Message Object

This message object is generated by a GLG drawing in the JavaScript environment every time a template of a reference object gets loaded. The Input callback can use this message to update the drawing. This message is invoked for any viewport object and does not require an input handler.

The GetPendingTemplates and GetPendingInstances methods of the JavaScript API may be used to query the number of templates being loaded and the number of reference object instances waiting for their templates to be loaded.

TemplateLoad Message Object Resources
Resource
Value
Format

TemplateLoad

Action

Update

SubAction

none


Object Selection Message Object

This message object is generated by a GLG drawing when objects in the drawing are selected via the mouse over or mouse click events. The viewport's ProcessMouse attribute has include one or both of the Click and Move masks to enable object selection processing. The Input callback can use the message object's resources to process the object selection. This message is invoked for any viewport object and does not require an input handler.

Object Selection Message Object Resources
Resource
Value
Format

ObjectSelection

Action
  • MouseMove when user moves the mouse over objects in the drawing.
  • MouseClick when the user clicks on the objects in the drawing.
SubAction

none

ButtonIndex
  • The index of the button that generated the selection event.
  • 0 for selections generated by mouse over events.
SelectionArray

A group object containing object IDs of all objects on the lowest level of the hierarchy selected by the mouse event.


The objects selected by the mouse event may be queried from the SelectionArray using the GetElement method of the Extended API:

GlgObject selection_array = 
	GlgGetResourceObject( message_object, "SelectionArray" );
for( i=0; i<GlgGetSize( selection_array ); ++i )
	GlgObject selected_object = GlgGetElement( selection_array, i );

The array contains the selected objects on the lowest level of the hierarchy. For example, if the object is part of a group, it will contain the object itself and not the group. The parents of the selected objects may be queried by using the selected object's GetParent method.

Chart Selection Message Object

This message object is returned by the GlgCreateChartSelection method and contains information describing the selected data sample. It does not have generic message object resources such as Format or Action, and contains only the resources listed in the following table.

Chart Selection Message Object Resources
Resource
Value
InputX

The X or time value corresponding to the specified input position.

InputY

The Y value corresponding to the specified input position.

SampleX

The X or time value of the selected data sample.

SampleY

The Y value of the selected data sample.

SampleValid

The value of the selected data sample's valid flag: 0 or 1.

InputXString

A string with the X or time value of the input position in the format of the X axis's label.

SampleXString

A string with the X or time value of the selected data sample in the format of the X axis's label.

SelectedPlot

An object ID of the selected plot.


Chart Message Object

This message object is generated every time a chart's cross-hair cursor is drawn or erased. When the mouse moves over the chart, a repeated draw message for each cross-hair cursor position is generated.

Chart Message Object Resources
Resource
Value
Format

Chart

Action

CrossHairUpdate

SubAction

Draw or Erase.

Object

The chart object that triggered the message.


Window Message Object

This message object is generated by a viewport object when it becomes visible for the first time or receives a message to delete or close its window. The delete window request is received when the user activates the window's controls to close the window. The Input callback gives the program a chance to react to the user's request. This message is invoked for any viewport object and does not require an input handler.

Window Message Object Resources
Resource
Value
Format

Window

Action
  • DeleteWindow when user closes the viewport's window.
  • FirstExposure when the viewport's window is becoming visible for the first time.
SubAction

none

Object

The viewport that triggered the message.



7.3 Appendix C: GLG Object Attribute Table

The following lists the Default Attribute Names that may be used by a program to access attributes of various objects. The generic attributes are common attributes that may be used for objects of any type. The rest of the attributes exist only in certain types of objects and are listed under their corresponding object types.

Most of the attribute names are either self-explanatory or are described in the corresponding section GLG Objects of the GLG User's Guide. There are some attributes that are not described in the User's Guide and may be used only by a program to access some objects' internal structures. Such attributes may have an explanation next to the attribute name.

Generic Attributes

Type

Object type.

Name

HasResources

Global

MoveMode

CoordFlag

HISetup

Indicates if the object's hierarchy has been set up.

Xform

An optional transformation object attached to the object.

Generic Attributes of Drawable objects

Visibility

HighlightFlag

History

A group containing all history objects attached to the object, if any.

CustomData

A group containing all custom properties attached to the object, if any.

NoCustomDataSetup

A flag to disable setup of custom properties when complex objects are attached as properties.

Aliases

A group containing all aliases attached to the object, if any.

Actions

A group containing all actions and commands attached to the object, if any.

RenderingAttr

The rendering object attached to the object, if any. Objects that have a rendering object attached, inherit the rendering object's attributes. In this case, rendering attributes may be queried directly from the object the rendering object is attached to.

Polygon Attributes

EdgeColor

FillColor

LineWidth

LineType

FillType

OpenType

SelectionType

Shading

Controls shading of the polygon's fill and edges.

AntiAliasing

Array

A group object containing polygon points.

Rendering Object Attributes

GradientResolution

GradientType

GradientColor

GradientCenter

GradientLength

GradientAngle

ArrowType

ShadowOffset

ShadowColor

FillDirection

FillAmount

If an object has a rendering object attached, the object inherits all of the rendering object's attributes, so that they can be queried directly from the object.

Marker Attributes

MarkerType

MarkerSize

Point

Control point

EdgeColor

FillColor

AntiAliasing

Text Object Attributes

TextType

String

Point1, Point2, Point3

Control Points

TextColor

FontType

FontSize

MinFontSize

Anchoring

AnchorOffset

TextDirection

TextScaling

BoxAttr

Box Attributes object attached to the text object (if any).

CursorType

Cursor type (SCROLLED TEXT only).

CursorPosition

Cursor position (SCROLLED TEXT only).

TextStart

Start index of the first visible character (SCROLLED TEXT only).

The text object also inherits attributes from its attached Box Attributes object. These attributes may be queried directly from the text object.

Box Attributes Object Attributes

BoxOffset

AnchorOnBox

FillColor

EdgeColor

LineWidth

LineType

FillType

Generic resource names

BoxEdgeColor

BoxFillColor

BoxLineWidth

BoxLineType

BoxFillType

Box-specific resource names

Arc Attributes

Radius

StartAngle

EndAngle

AngleType

Center

Center control point.

Vector

Vector control point.

Resolution, ArcResolution

ArcFillType

FillType

OpenType

EdgeColor

FillColor

LineWidth

LineType

SelectionType

Shading

AntiAliasing

Polygon

The polygon object used to render the arc.

Parallelogram Attributes

EdgeColor

FillColor

LineWidth

LineType

FillType

SelectionType

Shading

Controls shading of the object's fill and edges.

AntiAliasing

Polygon

The polygon object used to render the parallelogram.

Spline Object Attributes

SplineType

Resolution, SplineResolution

EdgeColor

FillColor

LineWidth

LineType

FillType

SelectionType

Shading

Controls shading of the object's fill and edges.

CPArray

A group containing the spline's control points.

Polygon

The polygon object used to render the spline.

Rounded Object Attributes

Radius1

Radius2

UnitType

Resolution, CornerResolution

EdgeColor

FillColor

LineWidth

LineType

FillType

SelectionType

Shading

Controls shading of the object's fill and edges.

AntiAliasing

Polygon

The polygon object used to render the object.

Image Object attributes

ImageType

Anchoring

ImageFile

EnableCache

AsyncMode

Java, C# and JavaScript only.

ImageLoaded

Java, C# and JavaScript only.

Point1, Point2

Control points.

GIS Object attributes

FillColor

GISDisabled

GISProjection

GISCenter

GISUsedCenter

The actual center value used by the map server (read-only).

GISExtent

GISUsedExtent

The actual extent value used by the map server (read-only).

GISAngle

GISStretch

GISDataFile

GISMapServerURL

GISLayers

GISVerbosity

GISDiscardData

AsyncMode

Java, C# and JavaScript only.

ImageLoaded

Java, C# and JavaScript only.

Point1, Point2

Control points.

Group and List Objects' Attributes

ZSort

Connector Object Attributes

EdgeType

EdgeDirection

EdgeColor

LineType

CPArray

A group containing the control points.

Rendering

The polygon or arc object used to render the connector.

Reference Object Attributes

ReferenceType

Source

SourcePath (previously DrawingFile)

A path for the drawing file or resource path for a palette object in the drawing.

ObjectPath

Resource path for the object in the template, may contain an origin resource path after a colon.

Point

Control point.

Reference

The template object.

Origin

The template's origin.

CloneType

EnableCache

KeepEditRatio (SubWindow only)

ContainerXform

The transformation used to scale or otherwise transform the reference's instance.

AttachmentArray

An optional array of the reference object's attachment points.

Bindings

An optional array of bindings for rebinding instance's attributes.

Series Object Attributes

Factor

CloneType

LogType

ZSort

Inversed

Persistent

Shift

Controls instance positioning. Changing the value of the attribute in the range of 0 to 1 may be used to animate the series by moving its instances along the path.

Path

The transformation object used as a path.

StartOrigin

The first point of the path transformation.

Origin

The template's origin point.

Template

The template object.

InstanceArray

A group containing template instances.

Square Series Object Attributes

Rows

Columns

ZSort

ColumnsFirst

CloneType

Persistent

KeepEditRatio

Point1, Point2, Point3

Control points.

Template

The template object.

InstanceArray

A group containing template instances.

Polyline Attributes

Factor

DrawMarkers

DrawLines

Segments

CloneType

Inversed

Path

The transformation object used as a path.

Polygon

The line or segment's template.

Point

The marker's template.

Points

A group containing marker instances.

InstanceArray

A group containing segment instances.

The polyline object also inherits attributes of its polygon template. These attributes may be accessed directly by querying the polyline.

Polysurface Attributes

Rows

Columns

DrawMarkers

DrawLines

ZSort

CloneType

Polygon

The surface segment's template.

Point1, Point2, Point3

Control points.

Point

The marker's template.

Points

A group containing marker instances.

InstanceArray

A group containing segment instances.

The polysurface object also inherits attributes of its polygon template. These attributes may be accessed directly by querying the polysurface.

Frame Object Attributes

FrameType

FrameFactor

CPArray

A group containing the frame's control points.

CNArray

A group containing the frame's constrained points.

Viewport Attributes

Point1, Point2

Control points.

EdgeColor

FillColor

LineWidth

ZSort

Pan

ActivePan

Read-only attribute, contains a bit mask composed of the GLG_PAN_X and GLG_PAN_Y binary flags indicating which scrollbars are currently displayed.

PanX

The horizontal scrollbar (viewport) of the integrated panning and zooming (if PanX is enabled).

PanY

The vertical scrollbar (viewport) of the integrated panning and zooming (if PanY is enabled).

PanSpacer

The spacer viewport of the integrated panning and zooming used in the lower right corner (if both PanX and PanY scrollbars are enabled).

ZoomEnabled

ZoomFactor

Read-only attribute which may be queried to get the viewport's current zoom factor.

ZoomToMode

Read-only attribute which may be queried to get the current state of multi-state zoom and pan actions: GLG_ZOOM_TO_STATE or GLG_PAN_DRAG_STATE. It may also contain the GLG_X_STATE or GLG_Y_STATE binary flags ORed with the return value to indicate ZoomToX / ZoomToY actions or the direction of the pan dragging.

ZoomModeObject

Read-only attribute which may be queried to get the chart or GIS object used for the Chart or GIS Zoom Mode.

XYRatio

Read-only attribute which may be queried to get the X/Y ratio of the viewport's window.

InnerWidth

InnerHeight

Read-only attributes which may be queried to get the viewport's inner width and height.

ProcessMouse

Enables mouse event processing.

KeepEditRatio

OwnsInputCB

JavaScriptFile

BaseWidth

A base width used for scaling text objects in the viewport.

Handler

A function object attached to the viewport as a handler.

DisableInput

Disables input events in the viewport.

Array

The group used by the viewport to contain the objects drawn in the viewport. The view and zoom transformations are attached to this group.

Screen

The screen object associated with the viewport.

The viewport also inherits most of the screen object's attributes and all attributes of the light object attached to the viewport, so that they may be queried directly from the viewport.

Screen Object Attributes

DoubleBuffering

Stretch

PushIn

CoordSystem

ShellType

WidgetType

ShadowWidth

AntiAliasing

Controls anti-aliasing for the screen's viewport. The default is ON.

Colortable

Fonttable

FonttableFile

A filename of a GLG drawing containing a font table to be used for the viewport's drawing.

ScreenName

Window title when the screen is used as a top-level window.

ExactColor

GridInterval

SpanX

SpanY

PreciseSize

OpenGLHint

A requested OpenGL mode.

OpenGL

The current OpenGL mode (read-only).

ScreenName

For screens of top-level viewports: Title to be used for the viewport's window.

XHint
YHint
WidthHint
HeightHint

For screens of top-level viewports with both of viewports control points set to (0,0,0): requested position and dimensions of the viewport on initial appearance.

Width
Height

The current width and height of the screen's viewport (read-only).

Widget

Returns the Widget ID of the native widget used to render the screen and viewport.

Shell

Returns the Widget ID of the highest level parent.

Drawable

The drawable used for rendering. Returns the ID of the double-buffering pixmap when double-buffering is enabled.

Display

Returns the Display pointer (X Windows only).

DisplayName

Returns the display name.

TrueColor

Read-only attribute, is set to a non-zero value when the screen is displayed on a TrueColor display.

The screen also inherits most of the colortable object's attributes which may be queried directly from both the screen and viewport object.

Light Viewport Attributes

Point1, Point2

Control points.

Background

A Line Attributes object containing attributes used to render the light viewport's background.

FillColor
EdgeColor
LineWidth
LineType
FillType

Generic resource names for attributes inherited from Background.

ShadowWidth

Stretch

PushIn

CoordSystem

SpanX

SpanY

GridInterval

ZSort

ProcessMouse

Enables mouse event processing.

Handler

A function object attached to the viewport as a handler.

DisableInput

Disables input events in the viewport.

KeepEditRatio

OwnsInputCB

ZoomEnabled

ZoomFactor

Read-only attribute which may be queried to get the viewport's current zoom factor.

ZoomToMode

Read-only attribute which may be queried to get the current state of multi-state zoom and pan actions: GLG_ZOOM_TO_STATE or GLG_PAN_DRAG_STATE. It may also contain the GLG_X_STATE or GLG_Y_STATE binary flags ORed with the return value to indicate ZoomToX / ZoomToY actions or the direction of the pan dragging.

XYRatio

Read-only attribute which may be queried to get the X/Y ratio of the viewport's window.

InnerWidth

InnerHeight

Read-only attributes which may be queried to get the viewport's inner width and height.

BaseWidth

A base width used for scaling text objects in the viewport.

Array

The group used by the viewport to contain the objects drawn in the viewport. The view and zoom transformations are attached to this group.

The light viewport also inherits attributes of its background object, so that they may be queried directly from the light viewport.

Chart Object Attributes

Point1, Point2

Control points.

NumPlots

NumYAxes

NumLevels

NumTimeLines

NumAnnotations

CommonRange

AutoScroll

AutoScale

DrawGrid

Persistent

SortInput

BufferXSpan

BufferSize

YAxesOffset

TooltipMode

TooltipFormat

DrawOrder

DrawCrossHair

Plots

A group containing the chart's plots.

Levels

A group containing the chart's level objects.

TimeLines

A group containing the chart's time lines.

Annotations

A group containing the chart's annotations.

XAxis

The chart's X axis.

YAxisGroup

A group containing the chart's Y axes.

YAxis

The first Y axis of the chart.

Background

A Line Attributes object containing attributes of the chart's drawing area.

Grid

A Line Attributes object containing attributes of the chart's grid.

SelectionMarker

A Marker object used for annotating the selected data sample.

CrossHair

A Line Attributes object containing attributes of the chart's cross-hair cursor.

DrawSelected

Controls drawing of the selection marker; may be reset to 0 at run time to erase the selection marker for a previous selection.

LegendContainer

The chart's legend, or the legend's parent viewport if the legend is placed in a separate viewport.

SelectedDataSample

A pointer to the GlgDataSample structure, may be used to query information about the selected sample at run time.

Plot Object Attributes

PlotType

Enabled

Annotation

YLow

YHigh

ValueEntryPoint

TimeEntryPoint

ValidEntryPoint

AutoScaleDelta

LinkedAxis

An object ID of the linked axis.

FilterType

FilterPrecision

FilterMarkers

IncludeZero

ExtendedData

RangeLock

NumSamples

Read-only resource for querying the number of accumulated samples.

EdgeColor

FillColor

Fill color of a bar plot.

FillType

Fill type of a bar plot.

LineWidth

LineType

Opacity

AntiAliasing

BarWidth

The width of bars in a bar plot.

BarYLow

The level of the bars' lower edge in a bar plot.

LineAttr

The Line Attributes object used to keep rendering attributes of the plot. The plot inherits the EdgeColor, FillColor, LineWidth and other line and bar rendering properties from this object.

Marker

Defines marker attributes.

Array

An internal group containing the plot's data samples. Data samples are represented by the GlgDataSample structure.

Counter

Keeps the incrementing current sample index for scrolling index charts.

Level Line Object Attributes

Level

YLow

YHigh

Enabled

RangeLock

EdgeColor

LineWidth

LineType

Opacity

AntiAliasing

LineAttr

The Line Attributes object used to keep rendering attributes of the level line. The level line inherits the EdgeColor, LineWidth and other line resources from this object.

LinkedAxis

An object ID of the linked axis.

Annotation Object Attributes

AnnotationType

PositionX

PositionY

AbsoluteX

AbsoluteY

YLow

YHigh

Enabled

RangeLock

LinkedAxis

An object ID of the linked axis.

LabelFormat

Label

The Text object used to render the annotation's label.

Marker

The Marker object used to render the annotation's marker.

Legend Object Attributes

Point1, Point2

Control points.

LayoutType

AutoLayout

Anchoring

RowAnchoring

MinRowSize

MaxRowSize

DisplayValue

ValueFormat

LineLength

MinLineWidth

BarHeight

XOffset

YOffset

XSpacing

YSpacing

LabelXOffset

LabelYOffset

LabelMaxWidth

LabelMaxHeight

Label

A Text object whose attributes are used to render the legend's labels.

Background

A Line Attributes object that defines rendering attributes of a background box drawn around the legend.

Axis Object Attributes

Point1, Point2

Control points.

AxisType

AxisPosition

Inversed

DrawOutline

RangeLock

Low (range axis only)

High (range axis only)

EndValue (scrolling axis only)

Span (scrolling axis only)

RulerStart (ruler axis only)

RulerScale (ruler axis only)

LabelFormat (non-time axis only)

TimeFormat (time axis only)

MilliSecFormat (non-time axis only)

MajorInterval

MinorInterval

AxisLabelString

LowOffset (non-time axis only)

HighOffset (non-time axis only)

RoundedPlacement

FixLeapYears (time axis only)

MajorTickSize

MinorTickSize

LabelOffset

LabelExtentRel

LabelExtentAbs

MajorOffset

TimeOrigin (relative time axis only)

TooltipFormat

AxisLabelOffset

AxisLabelPosition

AxisLabelAnchoring

Tick

A Line Attributes object that defines rendering attributes of the axis's minor and major ticks, as well as the attributes of the outline.

TickLabel

A Text object that defines rendering attributes used to draw the major tick labels.

AxisLabel

A Text object that used to draw the axis's label.

LabelFormatter

A pointer to the label formatting function associated with the axis.

Line Attributes Object

EdgeColor

LineWidth

LineType

FillType

FillColor

Opacity

AntiAliasing

Light Object Attributes

LightType

LightPoint

LightDirection

LightCoefficient

AmbientCoefficient

Colortable Object Attributes

ColortableType

ColorFactor

The requested number of colors.

NumColors

The actual number of colors.

GradeHint

The requested number of color grades.

NumGrades

The actual number of color grades.

PatternFactor

The requested number of dithering patterns.

NumPatterns

The actual number of dithering patterns.

RenderColor

The color to use for B&W rendering (when NumColors=1).

ColorCorrection

If set to True, increases the brightness of dark colors.

PastelLevel

A pastel color coefficient with a value between 0 and 1.

Font Table Object Attributes

NumFontTypes

NumFontSizes

FontArray

A group used to hold the font table's fonts

Font Object Attributes

FontName

XFontName

WinFontName

JavaFontName

FontPSName

MBFlag

Multi-byte flag.

FontCharset

Transformation Object Attributes

XformType

XformAttr1

The first attribute object (any type).

XformAttr2

The second attribute object (any type).

XformAttr3

The third attribute object (any type).

XformAttr4

The fourth attribute object (any type).

XformAttr5

The fifth attribute object (any type).

XformAttr6

The sixth attribute object (any type).

XformAttr7

The seventh attribute object (any type).

Matrix

The transformation's matrix object.

Action Object Attributes

ActionType

Trigger

ProcessArmed

ProcessDoubleClick

MouseButton

Enabled

Tooltip

Tooltip string for tooltip actions.

StateObj

The object whose value is to be set for mouse feedback actions.

EventLabel

ActionData

Action data for SEND_EVENT actions.

Command

Command data for SEND_COMMAND actions.

Alias Object Attributes

Alias

The alias name.

ResPath

The resource path to associate with the alias.

History Object Attributes

ScrollType

VarName

EntryPoint

Inversed

RollBack

HistoryIndex

The index of the current scroll iteration.

Data Object Attributes

DataType

Value

The value of the data object, accessed using NULL as the resource name.

XfValue

The transformed value (value transformed with an xform attached to the data object; in world coordinates for control points).

UTF8Encoding  (S data objects only)

AlwaysChanged

TagObject

An optional tag object attached to the data object. If a tag object is attached, the data object inherits the TagName, TagSource, TagEnabled and other tag attributes from the tag object.

Attribute Object Attributes

DataType

DataRole

Creation type resource that determines the type of transformations that will affect the attribute.

Value

The value of the attribute object, accessed using NULL as the resource name.

XfValue

The absolute value (in screen coordinates for drawable control points).

UTF8Encoding  (S attribute object only)

AlwaysChanged

TagObject

An optional tag object attached to the attribute object. If a tag object is attached, the attribute object inherits the TagName, TagSorce and TagComment attributes from the tag object.

ExportTag

An optional export tag attached to the attribute object to define a public property.

DataObject

The base data object used for storing the attribute's value.

Tag Object Attributes

TagType

Identifies the tag as a data or export tag (OEM).

TagName

Used to persistently identify the tag when browsing.

TagSource

Defines the mapping to a database field.

TagComment

Contains any user-defined information.

TagEnabled

TagAccessType

May be used to designate the tag as output-only.

Function Object Attributes

FunctionName

The name of the function object (GlgSlider, GlgButton, etc.).

7.4 Appendix D: Global Parameters

The following lists names of global parameters used in the GlgSetLParameter and GlgGetLParameter functions:


Generic Logic, Inc.
www.genlogic.com
PREV NEXT