GLG Toolkit, C / C++ API Library  Version 4.5
GlgApi.h File Reference

Classes

struct  GlgCallEvent
 A structure used to pass data to a custom Interaction Handler. More...
 
struct  GlgChartFilterData
 Contains data passed to the chart filter callback. More...
 
struct  GlgCube
 Defines a rectangular parallelepiped in 3D space (usually an object's bounding box) by its two diagonal points. More...
 
struct  GlgDataSample
 Chart data sample structure, holds data for one point of a chart. More...
 
struct  GlgDataSampleExt
 Extended chart data sample structure, holds data for one point of a chart. More...
 
struct  GlgFindObjectsData
 A structure used to pass information to the GlgFindObjects function, and to return the search results. More...
 
struct  GlgHierarchyCBStruct
 A structure used to pass data to the Hierarchy callback. More...
 
struct  GlgMatrixData
 Contains matrix data used by GlgGetMatrixData and GlgSetMatrixData. More...
 
struct  GlgMinMax
 Contains data extent information returned by the GlgGetChartDataExtent function. More...
 
struct  GlgPoint
 Defines an XYZ point in 3D space or an RGB color. More...
 
struct  GlgPoint2
 2D point with x and y coordinates. More...
 
struct  GlgRectangle
 2D rectangle defined by two diagonal points. More...
 
struct  GlgTraceCBStruct
 A structure used to pass information to the Trace callback. More...
 
struct  GlgTraceCBStruct_GTK
 A structure used to pass information to the Trace callback in GTK. More...
 
struct  GlgTraceCBStruct_Windows
 A structure used to pass information to the Trace callback on Windows. More...
 
struct  GlgTraceCBStruct_X11
 A structure used to pass information to the Trace callback in X11. More...
 
struct  GXAnyEvent
 GTK only: A generic event containing an event type field that is common for all GXEvent events. More...
 
struct  GXButtonEvent
 GTK only: Mouse button event, see GXEvent. More...
 
struct  GXConfigureEvent
 GTK only: Widget resize event, see GXEvent. More...
 
struct  GXCrossingEvent
 GTK only: Widget entering or leaving event, see GXEvent. More...
 
union  GXEvent
 GTK only: A simulated event used to pass GTK event information to the Trace callback. More...
 
struct  GXExposeEvent
 GTK only: Paint event generated when the widget is drawn, see GXEvent. More...
 
struct  GXKeyEvent
 GTK only: Key event, see GXEvent. More...
 
struct  GXMapEvent
 GTK only: Widget mapping event, see GXEvent. More...
 
struct  GXMotionEvent
 GTK only: Motion event, see GXEvent. More...
 
struct  GXUnmapEvent
 GTK only: Widget unmapping event, see GXEvent. More...
 
struct  GXVisibilityEvent
 GTK only: Widget visibility change event, see GXEvent. More...
 

Macros

#define False   0
 A platform-independent boolean constant. More...
 
#define GLG_ARROW_POSITION_MASK   0x0f
 Arrow position mask. More...
 
#define GLG_ARROW_TYPE_MASK   0xf0
 Arrow type mask. More...
 
#define GLG_BOX   0x2
 MarkerType constant. More...
 
#define GLG_C_CONST_CHAR_PTR   0
 C++ compatibility macro. More...
 
#define GLG_CHART_FILTER_VERSION   2
 Chart filter version. More...
 
#define GLG_CIRCLE   0x8
 MarkerType constant. More...
 
#define GLG_CLOSED   0
 Object OpenType constant. More...
 
#define GLG_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 coordinate=5.5). More...
 
#define GLG_CROSS   0x1
 MarkerType constant. More...
 
#define GLG_CROSS_BOX   ( GLG_CROSS | GLG_BOX )
 Composite MarkerType constant. More...
 
#define GLG_CROSS_CIRCLE   ( GLG_CROSS | GLG_CIRCLE )
 Composite MarkerType constant. More...
 
#define GLG_CROSS_DIAMOND   ( GLG_CROSS | GLG_DIAMOND )
 Composite MarkerType constant. More...
 
#define GLG_DIAGONAL_CROSS   0x100
 MarkerType constant. More...
 
#define GLG_DIAMOND   0x40
 MarkerType constant. More...
 
#define GLG_DOT   0x20
 MarkerType constant. More...
 
#define GLG_EDGE   0x1
 Draw edge. More...
 
#define GLG_EDGE_LINE_FILL   ( GLG_EDGE | GLG_LINE_FILL )
 Convenience constant to draw filled thick lines. More...
 
#define GLG_END_APOS   2
 Arrow position constant. More...
 
#define GLG_EQUATOR_RADIUS   6378136.
 Equator radius in meters. More...
 
#define GLG_EXIT_ERROR   PlatformDependent
 Exit status constant. More...
 
#define GLG_EXIT_OK   PlatformDependent
 Exit status constant. More...
 
#define GLG_FILL   0x2
 Draw fill. More...
 
#define GLG_FILL_ATYPE   0x20
 Arrow fill type constant. More...
 
#define GLG_FILL_EDGE   ( GLG_FILL | GLG_EDGE )
 Convenience constant to draw both fill and edge. More...
 
#define GLG_FILL_EDGE_ATYPE   0x30
 Arrow fill type constant. More...
 
#define GLG_FILLED_BOX   0x4
 MarkerType constant. More...
 
#define GLG_FILLED_CIRCLE   0x10
 MarkerType constant. More...
 
#define GLG_FILLED_DIAMOND   0x80
 MarkerType constant. More...
 
#define GLG_GIS_OUTSIDE_VALUE   -2000.
 A negative value for Z coordinates of converted points outside of the visible part of the globe in the GIS orthographic projection. More...
 
#define GLG_GRID_Xx   ( GLG_GRID_X | GLG_GRID_x )
 Major and minor X grid. More...
 
#define GLG_GRID_XxY   ( GLG_GRID_Xx | GLG_GRID_Y )
 Major and minor X grid, and major Y grid. More...
 
#define GLG_GRID_XxYy   ( GLG_GRID_Xx | GLG_GRID_Yy )
 Major and minor X and Y grid. More...
 
#define GLG_GRID_XY   ( GLG_GRID_X | GLG_GRID_Y )
 Major X and Y grid. More...
 
#define GLG_GRID_XYy   ( GLG_GRID_X | GLG_GRID_Yy )
 Major X grid, and major and minor Y grid. More...
 
#define GLG_GRID_Yy   ( GLG_GRID_Y | GLG_GRID_y )
 Major and minor Y grid. More...
 
#define GLG_HCENTER   0x0
 Horizontal anchoring constant. More...
 
#define GLG_HLEFT   0x1
 Horizontal anchoring constant. More...
 
#define GLG_HLINE   0x200
 MarkerType constant. More...
 
#define GLG_HRIGHT   0x2
 Horizontal anchoring constant. More...
 
#define GLG_IH_CURR
 Specifies the ID of the current handler. More...
 
#define GLG_IH_GLOBAL
 The ID of the global data storage. More...
 
#define GLG_IH_NEW
 Specifies the ID of the just installed handler. More...
 
#define GLG_INVERSED_LINE_FILL   0x8
 A flag that reverses colors when combined with GLG_LINE_FILL: thick lines will use EdgeColor for fill and FillColor for edges. More...
 
#define GLG_LINE_ATYPE   0x10
 Arrow fill type constant. More...
 
#define GLG_LINE_FILL   0x4
 A flag used with GLG_EDGE to render the outer edges of thick lines using EdgeColor and the middle part using FillColor. More...
 
#define GLG_LINE_FILL_INV   ( GLG_LINE_FILL | GLG_INVERSED_LINE_FILL )
 Convenience constant to draw filled thick lines with inversed colors. More...
 
#define GLG_LONG_MAX   PlatformDependent
 The maximum value of GlgLong. More...
 
#define GLG_LONG_MIN   PlatformDependent
 The minimum value of GlgLong. More...
 
#define GLG_MAJOR_VERSION   4
 Major version number. More...
 
#define GLG_MIDDLE_APOS   4
 Arrow position constant. More...
 
#define GLG_MIDDLE_INVERSED_APOS   5
 Arrow position constant. More...
 
#define GLG_MINOR_VERSION   5
 Minor version number. More...
 
#define GLG_OPEN   1
 Object OpenType constant. More...
 
#define GLG_OPEN_INVERSED   2
 Object OpenType constant. More...
 
#define GLG_POLAR_RADIUS   6356752.
 Polar radius in meters. More...
 
#define GLG_POSITIVE_AXIS_MASK   0x1
 Positive axis mask. More...
 
#define GLG_START_APOS   1
 Arrow position constant. More...
 
#define GLG_START_END_APOS   3
 Arrow position constant. More...
 
#define GLG_ULONG_MAX   PlatformDependent
 The maximun value of GlgULong. More...
 
#define GLG_VBOTTOM   0x20
 Vertical anchoring constant. More...
 
#define GLG_VCENTER   0x00
 Vertical anchoring constant. More...
 
#define GLG_VERTICAL_AXIS_MASK   0x8
 Vertical axis mask. More...
 
#define GLG_VLINE   0x400
 MarkerType constant. More...
 
#define GLG_VTOP   0x10
 Vertical anchoring constant. More...
 
#define GlgAllocStruct(size)
 Allocates a structure using GlgAlloc and initializes it with 0s. More...
 
#define GlgFalse   0
 A platform-independent boolean constant. More...
 
#define GlgInitStruct(ptr, size)
 Initializes structure with 0s. More...
 
#define GlgNullObjectMacro(object_holder)
 Assigns a NULL object to the GlgObject variable and dereferences its old value. More...
 
#define GlgSetObjectMacro(object_holder, new_value)
 Assigns a new object value to the object variable. More...
 
#define GlgTrue   1
 A platform-independent boolean constant. More...
 
#define True   1
 A platform-independent boolean constant. More...
 

Typedefs

typedef void * GlgAnyType
 Data type that can hold either an integer value or a pointer. More...
 
typedef void * GlgAppContext
 Platform-independent application context. More...
 
typedef PlatformDependent GlgBoolean
 Boolean data type. More...
 
typedef struct _GlgDataSampleNode GlgDataSampleNode
 Opaque structure containing GlgDataSample as well as additional fields used to process it by the chart object. More...
 
typedef GlgObject GlgIH
 Opaque type that represents an installable interface handler. More...
 
typedef void * GlgIHCallEvent
 Opaque type that represents installable interface handler events. More...
 
typedef void(* GlgIHEntryPoint) (GlgIH ih, GlgIHCallEvent call_event)
 An entry point that is invoked to handle user interaction logic of an installable interface handler. More...
 
typedef GlgLong GlgIHToken
 An installable interface handler token that identifies the event that needs to be handled. More...
 
typedef PlatformDependent GlgIntervalID
 Timer ID. More...
 
typedef PlatformDependent GlgLong
 Integer data type, can hold a pointer. More...
 
typedef struct GlgObjectData * GlgObject
 Opaque GlgObject type that represents all GLG objects in the GLG C API. More...
 
typedef PlatformDependent GlgULong
 Unsigned integer data type, can hold a pointer. More...
 
typedef void(* GlgCallbackProc) (GlgObject viewport, GlgAnyType data1, GlgAnyType data2)
 A platform-independent GLG callback installed via GlgAddCallback and used for the Input, Select, adds Trace and Hierarchy callbacks. More...
 
typedef void(* GlgInputCallback) (GlgObject viewport, GlgAnyType client_data, GlgObject message_object)
 An Input callback is used to handle user interaction with input objects, as well as to perform object selection and action processing. More...
 
typedef void(* GlgSelectCallback) (GlgObject viewport, GlgAnyType client_data, char **name_array)
 A simplified selection callback used to process name-based object selection, installed via GlgAddCallback. More...
 
typedef void(* GlgTraceCallback) (GlgObject viewport, GlgAnyType client_data, GlgTraceCBStruct *trace_info)
 A Trace callback used to handle native windowing events, installed via GlgAddCallback. More...
 
typedef void(* GlgCustomSetupHandler) (GlgObject object, GlgCustomSetupType type)
 A custom setup handler installed via GlgSetCustomSetupHandler. More...
 
typedef void(* GlgHierarchyCallback) (GlgObject viewport, GlgAnyType client_data, GlgHierarchyCBStruct *hierarchy_info)
 A Hierarchy callback used to get access to the drawing to be displayed in the SubWindow and SubDrawing objects before the drawing is displayed, installed via GlgAddCallback. More...
 
typedef void(* GlgTimerProc) (GlgAnyType client_data, GlgIntervalID *timer_id)
 A platform-independent timer callback installed via GlgAddTimeOut. More...
 
typedef GlgBoolean(* GlgWorkProc) (GlgAnyType client_data)
 A platform-independent work procedure callback installed via GlgAddWorkProc. More...
 
typedef void(* GlgErrorHandler) (char *message, GlgErrorType error_type)
 A custom error handler installed via GlgSetErrorHandler. More...
 
typedef void(* GlgHandler) (GlgCallEvent *call_event)
 A function that implements a custom interaction handler. More...
 
typedef GlgLong(* GlgChartFilter) (GlgChartFilterCBReason reason, GlgChartFilterData *filter_data, void *client_data)
 A custom chart filter callback installed via GlgSetChartFilter. More...
 
typedef char *(* GlgLabelFormatter) (GlgObject axis, GlgLabelType label_type, GlgValueType value_type, double value, time_t sec, double fractional_sec, void *reserved)
 A label formatter used to supply custom labels for chart axes and installed via GlgSetLabelFormatter. More...
 
typedef char *(* GlgTooltipFormatter) (GlgObject viewport, GlgObject object, GlgObject tooltip_obj, GlgLong root_x, GlgLong root_y)
 A tooltip formatter used to supply custom tooltip strings and installed via GlgSetTooltipFormatter. More...
 
typedef void(* GlgAlarmHandler) (GlgObject data_obj, GlgObject alarm_obj, char *alarm_label, char *action, char *subaction, GlgAnyType reserved)
 An alarm handler used to handle alarms attached to the GLG objects in the drawing and installed via GlgSetAlarmHandler. More...
 
typedef char *(* GlgGetURLCallback) (char *request, void *reserved)
 A custom callback used to fetch data from URLs, installed via GlgSetGetURLCallback. More...
 

Enumerations

enum  GlgAccessType
 Container access type. More...
 
enum  GlgActionType
 Specifies an action type. More...
 
enum  GlgAnnotationType
 Specifies a type of a chart's annotation. More...
 
enum  GlgAntiAliasingType
 Specifies anti-aliasing type. More...
 
enum  GlgArcAngleDefType
 Specifies the way the arc's start and end angles are used. More...
 
enum  GlgArcFillType
 Specifies arc fill type. More...
 
enum  GlgArmedStateType
 Choices of the armed_state parameter of the GlgGetAction function that controls selection of the returned action object. More...
 
enum  GlgArrowType
 Specifies arrow type. More...
 
enum  GlgAxisDirection
 Axis position and direction options. More...
 
enum  GlgAxisOutlineElem
 Binary flags used to form GlgAxisOutlineType elements by combining them with bitwise OR. More...
 
enum  GlgAxisOutlineType
 Axis outline type constants. More...
 
enum  GlgAxisType
 Specifies axis type. More...
 
enum  GlgBoolConversionType
 Specifies conversion type for parameters of the boolean transformation. More...
 
enum  GlgBoolXformType
 Specifies the operation to be performed by the boolean transformation. More...
 
enum  GlgBoundType
 Controls binding of a data object. More...
 
enum  GlgCallbackType
 Specifies callback type. More...
 
enum  GlgCallEventType
 Specifies the call event type for custom interaction handlers and installable interface handlers. More...
 
enum  GlgChartAutoScale
 Specifies a type of a chart's autoscaling. More...
 
enum  GlgChartCacheUse
 Controls the use of a per-plot chart cache. More...
 
enum  GlgChartElemDrawOrder
 Controls drawing order of the chart's elements, may be combined with bitwise OR. More...
 
enum  GlgChartFilterCBReason
 Specifies the reason the chart filter callback is invoked. More...
 
enum  GlgChartFilterRval
 Return value of a Flush method of a custom chart data filter. More...
 
enum  GlgChartFilterType
 Specifies a filter type of a chart's plot. More...
 
enum  GlgChartState
 Flags for updating chart state, may be combined with bitwise OR. More...
 
enum  GlgCloneType
 Specifies clone type. More...
 
enum  GlgCompareXformType
 Specifies the comparison operator of the compare transformation. More...
 
enum  GlgCompatibilityMode
 Specifies compatibility mode. More...
 
enum  GlgComponentQueryType
 Specifies a native component to return. More...
 
enum  GlgConfigureMask
 Specifies window configuration masks that can be combined with bitwise OR. More...
 
enum  GlgContainerType
 Specifies a type of objects to be held in a container object. More...
 
enum  GlgControlPointType
 Specifies control point type. More...
 
enum  GlgConvexType
 Specifies convex type of a polygon for OpenGL. More...
 
enum  GlgCoordType
 Coordinate types for transforming objects. More...
 
enum  GlgCursorType
 Specifies a cursor type. More...
 
enum  GlgCustomSetupType
 Indicates when the custom setup handler is invoked. More...
 
enum  GlgDataType
 Data object types. More...
 
enum  GlgDoubleBufferingType
 Specifies double buffering type. More...
 
enum  GlgDoubleClickStateType
 Choices of the double_click_state parameter of the GlgGetAction() method that controls selection of the returned action object. More...
 
enum  GlgDrawingCoordSystem
 Specifies the type of a drawing's coordinate system that defines the drawing's resize policy (CoordSystem attribute of the viewport screen). More...
 
enum  GlgElementDrawType
 Controls existence and drawn order of the angular axis elements. More...
 
enum  GlgEnableXY
 Specifies chart crosshair type. More...
 
enum  GlgErrorType
 Specifies error message type for the GlgError function. More...
 
enum  GlgEventType
 GLG event type constants that define GLG-specific events not covered by the native event types. More...
 
enum  GlgExtDataFlag
 Possible values of a plot's Extended Data attribute. More...
 
enum  GlgExtDataType
 Specifies type of information stored in the extended data sample. More...
 
enum  GlgFillSpace
 Choices of filling extra space left by invisible elements in a square series. More...
 
enum  GlgFrameType
 Specifies a type of a frame object. More...
 
enum  GlgFunctionXformType
 Specifies the operation to be performed by the function transformation. More...
 
enum  GlgGlobalType
 Specifies global type of a data object that controls how it is cloned. More...
 
enum  GlgGradientType
 Specifies gradient type. More...
 
enum  GlgGridType
 Specifies chart grid type. More...
 
enum  GlgHandleInvisible
 Choices of handling invisible cells by a square series Rows are vertical if ColumnsFirst=YES. More...
 
enum  GlgHierarchyCallbackType
 Indicates when the hierarchy callback is invoked. More...
 
enum  GlgHistoryScrollType
 Specifies the scroll type of the History object. More...
 
enum  GlgImageFormat
 Specifies image format. More...
 
enum  GlgImageType
 Specifies image object type. More...
 
enum  GlgKeepEditRatio
 Possible values of the KeepEditRatio attribute, used only by the GLG Editor when performing HierarchyDown. More...
 
enum  GlgLabelType
 Provides a label type for a custom label formatter. More...
 
enum  GlgLayoutType
 Specifies layout type. More...
 
enum  GlgLegendLayoutType
 Specifies legend layout type. More...
 
enum  GlgLevelDrawOrder
 Specifies a drawing order of a chart's Level Lines and Time Lines. More...
 
enum  GlgLevelType
 Specifies a type of a chart's Level Line or a Time Line. More...
 
enum  GlgLightType
 Specifies light type. More...
 
enum  GlgLineAnchoringType
 Specifies line anchoring type for multi-line text objects. More...
 
enum  GlgLineAttrType
 Specifies the type of a Line Attributes object. More...
 
enum  GlgLineCap
 Specifies line cap style. More...
 
enum  GlgLocaleType
 Locale type constants. More...
 
enum  GlgLogLevel
 Specifies logging level. More...
 
enum  GlgMapServerUsage
 Possible values of the GlgMapServerUsage global configuration resource that control the use of the map server. More...
 
enum  GlgMBType
 Specifies a font's MB flag. More...
 
enum  GlgModifierType
 Modifier type. More...
 
enum  GlgMoveMode
 Specifies the way an object is moved. More...
 
enum  GlgObjectCoordSystem
 Specifies types of an object's CoordFlag: the type of the coordinate system used to interpret point coordinates of an object. More...
 
enum  GlgObjectMatchType
 Object matching criteria for the GlgFindObjects function. More...
 
enum  GlgObjectType
 GLG object types. More...
 
enum  GlgOffsetXformMoveFlag
 Move Flag of the offset transformations. More...
 
enum  GlgOpenGLType
 The type of the OpenGL driver used by the viewport (OpenGL attribute of the viewport's screen. More...
 
enum  GlgOrientationType
 Specifies orientation type. More...
 
enum  GlgPanType
 Specifies the mode for a viewport's pan scrollbars. More...
 
enum  GlgParallType
 Specifies parallelogram type. More...
 
enum  GlgPathRotationType
 Specifies the rotation type of a path transformation. More...
 
enum  GlgPlotType
 Specifies a type of a chart's plot. More...
 
enum  GlgPolygonShading
 Specifies polygon shading type. More...
 
enum  GlgPositionModifier
 Container position modifier. More...
 
enum  GlgPositionType
 Container position type for the GlgIsAt function. More...
 
enum  GlgPreAllocType
 Specifies the type of preallocation to perform by the GlgPreAlloc function. More...
 
enum  GlgProcessArmedType
 Choices of the Action object's ProcessArmed attribute that controls processing of the Control key modifier. More...
 
enum  GlgProcessDoubleClickType
 Choices of the Action object's ProcessArmed attribute that controls processing of the double-click. More...
 
enum  GlgProcessMouseMask
 Specifies the type of the mouse events to be processed by a viewport. More...
 
enum  GlgProjectionType
 Specifies map server GIS projection. More...
 
enum  GlgRefType
 Reference object subtypes. More...
 
enum  GlgRenderingMode
 Rendering mode for the CustomDraw callback. More...
 
enum  GlgScaleAdjustmentType
 Specifies scaling adjustment type for pixel offset and screen scaling transformations. More...
 
enum  GlgScalingType
 Specifies scaling type for fixed size properties: text size, polygon line width, marker size, etc. More...
 
enum  GlgScrollbarType
 Type of scrollbars to use for integrated panning. More...
 
enum  GlgSearchType
 Container search type. More...
 
enum  GlgSelectionEventType
 Specifies the type of events returned by the GlgCreateSelectionMessage function. More...
 
enum  GlgSelectionType
 Specifies selection type. More...
 
enum  GlgShellType
 Specifies viewport screen's shell type. More...
 
enum  GlgSplineType
 Specifies spline type. More...
 
enum  GlgStorageType
 Specifies template storage type of a reference object. More...
 
enum  GlgStretchType
 Specifies stretch type of a viewport drawing. More...
 
enum  GlgTabNavigationType
 Specifies the type of native components to traverse on a TAB press. More...
 
enum  GlgTagAccessType
 Specifies tag access type. More...
 
enum  GlgTagType
 Specifies tag type. More...
 
enum  GlgTextDirection
 Specifies text direction. More...
 
enum  GlgTextType
 Specifies text type. More...
 
enum  GlgTimeConversionType
 Specifies time conversion type for the time format transformation. More...
 
enum  GlgTriggerType
 Specifies a type of the mouse event that triggers an object's action. More...
 
enum  GlgUnitsType
 Specifies the type of units that determine the size of the rounded corner of the Rounded object. More...
 
enum  GlgValueType
 Provides value type for a custom label formatter. More...
 
enum  GlgWaveformType
 Specifies timer transformation waveform type. More...
 
enum  GlgWidgetType
 Specifies the native widget type used by the viewport screen object. More...
 
enum  GlgXFontType
 Specifies the type of the X Windows font for the X11 version of the GLG library. More...
 
enum  GlgXformRole
 Specifies a role of an attribute object. More...
 
enum  GlgXformType
 Specifies transformation type. More...
 
enum  GlgZoomMode
 Specifies zoom mode. More...
 
enum  GlgZoomState
 Zoom state constants indicating the current Zoom operation in progress, if any. More...
 
enum  GlgZSortType
 Specifies Z-sort type for hidden surface removal. More...
 
enum  GXEventType
 GTK only: Windowing system events types. More...
 

Functions

GlgLong CALLBACK GlgControlWindowProc (HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
 Windows only: Passes messages to the GLG Custom Control. More...
 
GlgObject GlgCreateSelectionMessage (GlgObject top_vp, GlgRectangle *rectangle, GlgObject selected_vp, GlgSelectionEventType selection_type, GlgLong button)
 Searches for an Action object that would be activated by the user interaction event. More...
 
GlgObject GlgCreateSelectionNames (GlgObject top_vp, GlgRectangle *rectangle, GlgObject selected_vp)
 Returns a list of names of objects intersecting a given rectangle. More...
 
GlgBoolean GlgGetModifierState (GlgModifierType modifier)
 Provides a cross-platform way to query the state of the Control and Shift keys, as well as the type of the mouse click: a single or double click. More...
 
GlgObject GlgGetWindowViewport (HWND window)
 Windows only: Returns a viewport object used by the GLG Custom Control. More...
 
GlgBoolean GlgIHCallCurrIH (GlgIHCallEvent call_event)
 Passes an event to the current handler. More...
 
GlgBoolean GlgIHCallCurrIHWithModifToken (GlgIHCallEvent call_event, GlgIHToken token)
 A variation on GlgIHCallCurrIHWithToken that reuses an existing user interface event. More...
 
GlgBoolean GlgIHCallCurrIHWithToken (GlgIHToken token)
 Passes a token to the current handler. More...
 
void GlgIHCallPrevIHWithModifToken (GlgIHCallEvent call_event, GlgIHToken token)
 A variation on GlgIHCallPrevIHWithToken that reuses an existing user interface event. More...
 
void GlgIHCallPrevIHWithToken (GlgIHToken token)
 Passes the token to the parent handler of the currently active handler. More...
 
void GlgIHChangeDParameter (GlgIH ih, char *name, double value)
 Changes a double value stored in a named parameter. More...
 
void GlgIHChangeIParameter (GlgIH ih, char *name, GlgLong value)
 Changes an integer value stored in a named parameter. More...
 
void GlgIHChangeOParameter (GlgIH ih, char *name, GlgObject value)
 Changes a GLG object ID stored in a named parameter. More...
 
void GlgIHChangePParameter (GlgIH ih, char *name, void *value)
 Changes a pointer stored in a named parameter. More...
 
void GlgIHChangeSParameter (GlgIH ih, char *name, char *value)
 Changes a string value stored in a named parameter. More...
 
GlgIH GlgIHGetCurrIH (void)
 Retrieves ID of the current active interface handler. More...
 
double GlgIHGetDParameter (GlgIH ih, char *name)
 Returns a double value stored in a named parameter. More...
 
GlgIHEntryPoint GlgIHGetFunction (GlgIH ih)
 Returns function that implements the handler's logic. More...
 
GlgLong GlgIHGetIParameter (GlgIH ih, char *name)
 Returns an integer value stored in a named parameter. More...
 
GlgObject GlgIHGetOParameter (GlgIH ih, char *name)
 Returns a GLG object ID stored in a named parameter. More...
 
double GlgIHGetOptDParameter (GlgIH ih, char *name, double default_value)
 Returns a double value stored in an optional named parameter. More...
 
GlgLong GlgIHGetOptIParameter (GlgIH ih, char *name, GlgLong default_value)
 Returns an integer value stored in an optional named parameter. More...
 
GlgObject GlgIHGetOptOParameter (GlgIH ih, char *name, GlgObject default_value)
 Returns a GLG object ID stored in an optional named parameter. More...
 
void * GlgIHGetOptPParameter (GlgIH ih, char *name, void *default_value)
 Returns a pointer stored in an optional named parameter. More...
 
char * GlgIHGetOptSParameter (GlgIH ih, char *name, char *default_value)
 Returns a string value stored in an optional named parameter. More...
 
void * GlgIHGetPParameter (GlgIH ih, char *name)
 Returns a pointer stored in a named parameter. More...
 
GlgIHEntryPoint GlgIHGetPrevFunction (void)
 Returns function used to implement the parent handler of the currently active handler. More...
 
GlgIH GlgIHGetPrevIH (void)
 Retrieves ID of the currently active interface handler's parent handler. More...
 
char * GlgIHGetSParameter (GlgIH ih, char *name)
 Returns a pointer stored in a named parameter. More...
 
GlgIHToken GlgIHGetToken (GlgIHCallEvent call_event)
 Returns a token associated with the GLG_MESSAGE_EVENT event. More...
 
GlgCallEventType GlgIHGetType (GlgIHCallEvent call_event)
 Returns an event's type. More...
 
void GlgIHInit (void)
 Initializes installable handler utilities, must be invoked after GlgInit but before any installable handler functions are used. More...
 
GlgIH GlgIHInstall (GlgIHEntryPoint handler)
 Creates a handler with the specified entry point and installs it. More...
 
void GlgIHPassToken (GlgIHEntryPoint handler, GlgIHToken token, GlgBoolean uninstall)
 Installs a handler, starts it and invokes its entry point with the specified token. More...
 
void GlgIHResetup (GlgIH ih)
 Reinitializes the current handler that have already been installed and used to "restart" its logic. More...
 
void GlgIHSetDParameter (GlgIH ih, char *name, double value)
 Creates and stores a named double parameter. More...
 
void GlgIHSetIParameter (GlgIH ih, char *name, GlgLong value)
 Creates and stores a named integer parameter. More...
 
void GlgIHSetOParameter (GlgIH ih, char *name, GlgObject value)
 Creates and stores a named parameter that keeps a GLG object ID. More...
 
void GlgIHSetOParameterFromD (GlgIH ih, char *name, double value)
 Creates and stores a named double parameter that is stored as a GLG Data object of the GLG_D type. More...
 
void GlgIHSetOParameterFromG (GlgIH ih, char *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 GLG_G type. More...
 
void GlgIHSetPParameter (GlgIH ih, char *name, void *value)
 Creates and stores a named pointer parameter. More...
 
void GlgIHSetSParameter (GlgIH ih, char *name, char *value)
 Creates and stores a named string parameter. More...
 
void GlgIHStart (void)
 Initializes and starts the current handler after it has been installed with GlgIHInstall. More...
 
void GlgIHTerminate (void)
 Terminates installable handler utilities. More...
 
void GlgIHUninstall (void)
 Uninstalls the current handler (the last handler on the handler stack). More...
 
void GlgIHUninstallWithEvent (GlgIHCallEvent call_event)
 Uninstalls the current handler and passes an event to the previous handler. More...
 
void GlgIHUninstallWithToken (GlgIHToken token)
 Uninstalls the current handler and passes a token to the previous handler. More...
 
GlgAnyType GlgSendMessage (GlgObject object, char *resource_name, char *message, GlgAnyType param1, GlgAnyType param2, GlgAnyType param3, GlgAnyType param4)
 Sends a message to an object to request some action to be performed. More...
 
void GlgSetDefaultViewport (GlgObject viewport)
 Windows only: Sets a drawing to be used by the GLG Custom Control. More...
 
void GlgSetFocus (GlgObject object, char *resource_name)
 Sets the keyboard focus to an object's viewport. More...
 
GlgTooltipFormatter GlgSetTooltipFormatter (GlgTooltipFormatter formatter)
 Supplies a custom tooltip formatter. More...
 
void GlgSetWindowViewport (HWND window, GlgObject viewport)
 Windows only: Sets or replaces the viewport of the GLG Custom Control after its window has been created. More...
 
void GlgStopButtonRepeat (void)
 Stops the button repeat in progress, if any. More...
 
GlgBoolean GlgConfigureWindow (GlgObject object, GlgLong x, GlgLong y, GlgLong width, GlgLong height, GlgConfigureMask mask, GlgObject parent)
 Sets the size and/or position of a viewport's window. More...
 
void GlgDialogInitialDraw (GlgObject object, GlgObject parent)
 Displays a GLG drawing as a floating dialog for the first time after it has been created or loaded. More...
 
void GlgDialogSetupHierarchy (GlgObject object, GlgObject parent)
 Provides an explicit request to set up the object hierarchy of a drawing displayed in a dialog window. More...
 
GlgAppContext GlgInit (GlgBoolean tk_initialized, GlgAppContext app_context, int argc, char **argv)
 Initializes GLG Toolkit API. More...
 
void GlgInitialDraw (GlgObject object)
 Draws a GLG viewport object for the first time after it has been created or loaded. More...
 
GlgObject GlgLoadObject (char *filename)
 Loads an object from a GLG drawing file or a URL. More...
 
GlgObject GlgLoadObjectFromImage (void *image, GlgLong size)
 Loads an object from a memory image. More...
 
GlgObject GlgLoadWidgetFromFile (char *filename)
 Loads a GLG widget from a GLG drawing file or a URL. More...
 
GlgObject GlgLoadWidgetFromImage (void *image, GlgLong size)
 Loads a GLG widget from a memory image. More...
 
GlgObject GlgLoadWidgetFromObject (GlgObject object)
 Loads a widget from a GLG object. More...
 
GlgLong GlgMainLoop (GlgAppContext context)
 Implements an event polling loop in a platform independent way. More...
 
GlgBoolean GlgReset (GlgObject object)
 Reinitializes the drawing by resetting the drawing hierarchy, then setting it up again and rendering the drawing. More...
 
void GlgResetHierarchy (GlgObject object)
 Resets the object hierarchy. More...
 
void GlgSetupHierarchy (GlgObject object)
 Provides an explicit request to set up the object hierarchy without rendering the object. More...
 
void GlgTerminate (void)
 Terminates the application's use of the GLG Toolkit. More...
 
GlgBoolean GlgUpdate (GlgObject object)
 Updates a drawing to show new resource values. More...
 
void GlgError (GlgErrorType type, char *message)
 Displays error and information messages using the currently installed error handler. More...
 
GlgErrorHandler GlgSetErrorHandler (GlgErrorHandler new_handler)
 Replaces the GLG Toolkit error handler and returns the previous error handler. More...
 
GlgObject GlgCreateAlarmList (GlgObject object)
 Creates and returns a list of alarms defined in the drawing. More...
 
GlgAlarmHandler GlgSetAlarmHandler (GlgAlarmHandler handler)
 Installs a global alarm handler function that will be invoked to process alarms. More...
 
GlgBoolean GlgExportPostScript (GlgObject object, char *file, double x, double y, double width, double height, GlgBoolean portrait, GlgBoolean stretch, GlgBoolean center)
 Generates a PostScript output of the current state of the viewport's graphics. More...
 
PlatformDependent GlgGenerateImage (GlgObject object, char *resource_name, PlatformDependent image)
 Creates and returns an image of the current state of the viewport's graphics. More...
 
PlatformDependent GlgGenerateImageCustom (GlgObject object, char *resource_name, PlatformDependent image, GlgLong x, GlgLong y, GlgLong width, GlgLong height, GlgLong gap)
 Creates an image of the specified rectangular region of the viewport's graphics. More...
 
GlgBoolean GlgNativePrint (GlgObject object, PlatformDependent print_context, double x, double y, double width, double height, GlgBoolean stretch, GlgBoolean center)
 GTK and Windows only: Generates printing output of the current state of the viewport's graphics. More...
 
GlgBoolean GlgSaveImage (GlgObject object, char *resource_name, char *filename, GlgImageFormat format)
 Generates a JPEG or PNG image of the current state of the viewport's graphics and saves it to a file. More...
 
GlgBoolean GlgSaveImageCustom (GlgObject object, char *resource_name, char *filename, GlgImageFormat format, GlgLong x, GlgLong y, GlgLong width, GlgLong height, GlgLong gap)
 Generates a JPEG or PNG image of the specified rectangular region of the viewport's graphics and saves it to a file. More...
 
void * GlgAlloc (GlgLong size)
 Allocates memory using the Toolkit's memory allocator. More...
 
char * GlgConcatResNames (char *resource_name1, char *resource_name2)
 Creates a composite resource path from two components. More...
 
char * GlgConcatStrings (char *string1, char *string2)
 Concatenates two character strings. More...
 
char * GlgCreateIndexedName (char *template_name, GlgLong resource_index)
 Creates a string with a name of an enumerated resource. More...
 
void GlgFree (void *ptr)
 Frees memory used to store character strings or allocated using GlgAlloc. More...
 
GlgBoolean GlgPreAlloc (GlgLong size, GlgPreAllocType type)
 Preallocates memory under the control of mission critical real-time applications. More...
 
char * GlgStrClone (char *string)
 Creates a copy of a character string. More...
 
void GlgChangeObject (GlgObject object, char *resource_path)
 Sends a change message to an object without actually changing the object's properties. More...
 
GlgBoolean GlgGetDResource (GlgObject object, char *resource_name, double *value)
 Returns the current value of a D (double) resource. More...
 
GlgBoolean GlgGetGResource (GlgObject object, char *resource_name, double *x_value, double *y_value, double *z_value)
 Returns the current value of a G (geometrical or color) resource. More...
 
GlgBoolean GlgGetSResource (GlgObject object, char *resource_name, char **value)
 Returns the current value of a S (string) resource. More...
 
GlgBoolean GlgHasResourceObject (GlgObject object, char *resource_name)
 Checks if a named resource exists. More...
 
GlgBoolean GlgSetDResource (GlgObject object, char *resource_name, double value)
 Sets a new value of a D (double) resource. More...
 
GlgBoolean GlgSetDResourceIf (GlgObject object, char *resource_name, double value, GlgBoolean if_changed)
 Sets a new value of a D (double) resource. More...
 
GlgBoolean GlgSetGResource (GlgObject object, char *resource_name, double x_value, double y_value, double z_value)
 Sets new values of a G (geometrical or color) resource. More...
 
GlgBoolean GlgSetGResourceIf (GlgObject object, char *resource_name, double x_value, double y_value, double z_value, GlgBoolean if_changed)
 Sets new values of a G (geometrical or color) resource. More...
 
GlgBoolean GlgSetResourceFromObject (GlgObject object, char *resource_name, GlgObject value)
 Sets a new value of a data resource to the value of contained in the provided data object of the same data type. More...
 
GlgBoolean GlgSetResourceFromObjectIf (GlgObject object, char *resource_name, GlgObject value, GlgBoolean if_changed)
 Sets the value of the data object to the value of another data object of the same data type. More...
 
GlgBoolean GlgSetSResource (GlgObject object, char *resource_name, char *value)
 Replaces the string of an S (string) resource. More...
 
GlgBoolean GlgSetSResourceFromD (GlgObject object, char *resource_name, char *format, double value)
 Sets the string of an S (string) resource from a double value, converting the value into a string using a printf format string. More...
 
GlgBoolean GlgSetSResourceFromDIf (GlgObject object, char *resource_name, char *format, double value, GlgBoolean if_changed)
 Sets the string of an S (string) resource from a double value, converting the value into a string using a printf format string. More...
 
GlgBoolean GlgSetSResourceIf (GlgObject object, char *resource_name, char *value, GlgBoolean if_changed)
 Replaces the string of an S (string) resource. More...
 
GlgObject GlgCreateTagList (GlgObject object, GlgBoolean unique_tag_sources)
 Creates and returns a list of data tags defined in the drawing. More...
 
GlgLong GlgExportTags (GlgObject object, char *filename, GlgLong separator1, GlgLong separator2)
 Writes tag names and tag sources of all data tags defined in a drawing to a tag translation file. More...
 
GlgBoolean GlgGetDTag (GlgObject object, char *tag_source, double *value)
 Returns the current value of a D (double) tag. More...
 
GlgBoolean GlgGetGTag (GlgObject object, char *tag_source, double *x_value, double *y_value, double *z_value)
 Returns the current value of a G (geometrical or color) tag. More...
 
GlgBoolean GlgGetSTag (GlgObject object, char *tag_source, char **value)
 Returns the current value of a S (string) tag. More...
 
GlgBoolean GlgHasTagName (GlgObject object, char *tag_source)
 Checks if a data tag with a specified tag name exists. More...
 
GlgBoolean GlgHasTagSource (GlgObject object, char *tag_source)
 Checks if a data tag with a specified tag source exists. More...
 
GlgLong GlgImportTags (GlgObject object, char *filename, GlgBoolean verbose)
 Replaces the TagName and TagSource attributes of the data tags in a drawing with information loaded from a tag translation file. More...
 
GlgBoolean GlgSetDTag (GlgObject object, char *tag_source, double value, GlgBoolean if_changed)
 Sets a new value of a D (double) tag. More...
 
GlgBoolean GlgSetGTag (GlgObject object, char *tag_source, double x_value, double y_value, double z_value, GlgBoolean if_changed)
 Sets new values of a G (geometrical or color) tag. More...
 
GlgBoolean GlgSetSTag (GlgObject object, char *tag_source, char *value, GlgBoolean if_changed)
 Replaces the string of an S (string) tag. More...
 
GlgBoolean GlgSetSTagFromD (GlgObject object, char *tag_source, char *format, double value, GlgBoolean if_changed)
 Replaces the string of an S (string) tag with a value specified by an input number and a format string. More...
 
void GlgAddCallback (GlgObject viewport, GlgCallbackType type, GlgCallbackProc callback, GlgAnyType client_data)
 Adds a callback function to a viewport. More...
 
GlgLong GlgGetSelectionButton (void)
 Queries the mouse button that initiated the callback. More...
 
GlgBoolean GlgSetZoom (GlgObject object, char *resource_name, GlgLong type, double value)
 Provides a programmatic interface to integrated zooming and panning. More...
 
GlgBoolean GlgSetZoomMode (GlgObject object, char *resource_name, GlgObject zoom_object, char *zoom_object_resource_name, GlgZoomMode zoom_mode)
 Sets or resets a viewport's zoom mode by supplying a GIS or Chart object to be zoomed. More...
 
GlgLong GlgExportStrings (GlgObject object, char *filename, GlgLong separator1, GlgLong separator2)
 Writes all text strings defined in the drawing to a string translation file. More...
 
GlgLong GlgImportStrings (GlgObject object, char *filename, GlgBoolean verbose)
 Replaces text strings in the drawing with the strings loaded from a string translation file. More...
 
GlgBoolean GlgInitLocale (char *locale)
 Sets the program locale. More...
 
GlgDataType GlgGetDataType (GlgObject data_object)
 Returns a data object's data type. More...
 
char * GlgGetObjectName (GlgObject object)
 Returns an object's name. More...
 
GlgObjectType GlgGetObjectType (GlgObject object)
 Returns an object's type. More...
 
void GlgDropObject (GlgObject object)
 Decrements an object's reference count. More...
 
GlgLong GlgGetRefCount (GlgObject object)
 Returns an object's reference count. More...
 
GlgObject GlgReferenceObject (GlgObject object)
 Increments an object's reference count. More...
 
GlgLong GlgAddTimeOut (GlgAppContext context, GlgLong interval, GlgTimerProc callback, GlgAnyType client_data)
 Adds an interval timer in a platform-independent way. More...
 
GlgLong GlgAddWorkProc (GlgAppContext context, GlgWorkProc work_proc, GlgAnyType client_data)
 Adds a work procedure in a platform-independent way. More...
 
void GlgBell (GlgObject viewport)
 Produces an audio bell in a platform-independent way. More...
 
char * GlgCreateRelativePath (char *base_path, char *filename, GlgBoolean return_null_if_not_found, GlgBoolean check_if_exists)
 Creates a filepath relative to the specified base path and provides options for checking if the path points to an existing file. More...
 
char * GlgFindFile (char *filename, char *path, GlgBoolean check_glg_path)
 Searches for a file, first in the current directory, then in the specified directory and then in the GLG search path. More...
 
char * GlgGetDir (char *path)
 Returns the directory portion of the specified path. More...
 
GlgBoolean GlgGetLParameter (char *name, GlgLong *value)
 Queries a value of a global parameter. More...
 
GlgLong GlgGetMajorVersion (void)
 Returns the library's major version number. More...
 
GlgLong GlgGetMinorVersion (void)
 Returns the library's minor version number. More...
 
GlgAnyType GlgGetNativeComponent (GlgObject object, char *resource_name, GlgComponentQueryType type)
 ADVANCED: Returns an ID of a native windowing system component used to render the viewport. More...
 
char * GlgGetRelativePath (char *base_path, char *filename)
 Creates a filepath relative to the specified base path. More...
 
GlgBoolean GlgGetTime (GlgULong *sec, GlgULong *microsec)
 Returns number of seconds and microseconds since the Epoch. More...
 
char * GlgGetURLCB (char *request, void *reserved)
 Fetches data from a URL and saves it in a temporary file. More...
 
GlgObject GlgParseArgs (char *program_name, char *args_string, GlgLong *argc, char ***argv)
 This function is used by the GlgMain generic program entry point on Windows to parse command-line arguments. More...
 
void GlgPrintObjectCountChanges (void)
 Prints object count changes since the last call to this function. More...
 
void GlgPrintObjectCounts (void)
 Prints total object count for each of the GLG object types. More...
 
double GlgRand (double low, double high)
 Generates a random number in a platform-independent way. More...
 
void GlgRemoveTimeOut (GlgLong id)
 Removes a timer procedure. More...
 
void GlgRemoveWorkProc (GlgLong id)
 Removes a work procedure. More...
 
GlgBoolean GlgResetSizeConstraint (GlgObject text_obj)
 Forces GLG_FIT_TO_BOX_TEXT Text objects with a constrained SizeConstraint attribute to renegotiate their font size. More...
 
GlgBoolean GlgSetCursorType (GlgObject viewport, char *resource_name, GlgCursorType cursor_type)
 Sets cursor for a drawing or one of its child viewports. More...
 
GlgGetURLCallback GlgSetGetURLCallback (GlgGetURLCallback callback)
 Installs a custom callback used to fetch data from URLs. More...
 
GlgBoolean GlgSetLParameter (char *name, GlgLong value)
 Sets a value of a global parameter. More...
 
void GlgSleep (GlgLong millisec)
 Suspends application execution for a specified interval in a platform independent way. More...
 
GlgBoolean GlgSync (GlgObject viewport)
 Flushes the windowing system output to the display. More...
 
char * GlgGetExePath (void)
 Windows only: Returns the path of the program's executable. More...
 
void GlgLoadExeIcon (GlgObject viewport, GlgLong icon_id)
 Windows only: Loads small and big icons from the executable and associates them with the top level window of a viewport. More...
 
GlgBoolean GlgOnDrawMetafile (GlgObject viewport, HDC print_dc)
 Windows only: Provides MFC metafile output support. More...
 
GlgBoolean GlgOnPrint (GlgObject viewport, HDC print_dc)
 Windows only: Provides MFC printing support. More...
 
GlgBoolean GlgSetCursor (GlgObject viewport, char *resource_name, GlgLong cursor)
 Windows only: Sets a custom cursor for a drawing or one of its child viewports. More...
 
GlgObject GlgAddAnnotation (GlgObject object, char *resource_name, GlgObject annotation, double position_x, double position_y, GlgBoolean add_box)
 Adds an annotation to a chart object. More...
 
GlgObject GlgAddPlot (GlgObject object, char *resource_name, GlgObject plot)
 Adds a plot line to a chart object. More...
 
GlgObject GlgAddTimeLine (GlgObject object, char *resource_name, GlgObject time_line, double time_stamp)
 Adds a vertical time line to a chart object. More...
 
GlgBoolean GlgClearDataBuffer (GlgObject object, char *resource_name)
 Clears accumulated data samples of a real-time chart or one of its plots. More...
 
GlgBoolean GlgDeleteAnnotation (GlgObject object, char *resource_name, GlgObject annotation, double position_x, double position_y)
 Deletes an annottion from a chart. More...
 
GlgBoolean GlgDeletePlot (GlgObject object, char *resource_name, GlgObject plot)
 Deletes a plot line from a chart. More...
 
GlgBoolean GlgDeleteTimeLine (GlgObject object, char *resource_name, GlgObject time_line, double time_stamp)
 Deletes a time line from a chart. More...
 
GlgBoolean GlgGetChartDataExtent (GlgObject object, char *resource_name, GlgMinMax *min_max, GlgBoolean x_extent, GlgBoolean visible_only)
 Queries the minimum and maximum extent of the data accumulated in a chart or in one of its plots in the specified X or Y direction. More...
 
GlgObject GlgGetNamedPlot (GlgObject object, char *resource_name, char *plot_name)
 Given a name of a chart's plot, returns the plot's object ID. More...
 
GlgObject GlgGetSelectedPlot (void)
 Returns the plot object corresponding to the last legend item selected with the mouse, if any. More...
 
GlgBoolean GlgSetChartFilter (GlgObject object, char *resource_name, GlgChartFilter chart_filter, void *client_data)
 Attaches a custom data filter to a chart's plot. More...
 
GlgBoolean GlgSetLabelFormatter (GlgObject object, char *resource_name, GlgLabelFormatter formatter)
 Attaches a custom label formatter to a chart axis or a stand-alone axis object. More...
 
GlgBoolean GlgSetLinkedAxis (GlgObject object, char *resource_name, GlgObject axis_object, char *axis_resource_name)
 Associates a chart's plot, level line or annotation object with an Y axis for automatic rescaling. More...
 
GlgBoolean GlgUpdateChartState (GlgObject object, char *resource_name, GlgChartState state)
 Triggers updating a chart's state after prefilling it with data using the quick mode of GlgAddDataSampleNode. More...
 
GlgBoolean GlgUpdateChartTimeAxis (GlgObject object, char *resource_name, double time_stamp, GlgBoolean initialize)
 Scrolls the chart forward to show all data samples up to the provided time stamp or index. More...
 
GlgBoolean GlgGISConvert (GlgObject object, char *resource_name, GlgCoordType coord_type, GlgBoolean 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 GlgGISCreateSelection (GlgObject object, char *resource_name, char *layers, GlgLong x, GlgLong y, GlgLong select_labels)
 Returns a message object containing information about GIS features located at a specified position on the map. More...
 
GlgObject GlgGISGetDataset (GlgObject object, char *resource_name)
 Returns a dataset object associated with the GIS Object. More...
 
GlgBoolean GlgGISGetElevation (GlgObject object, char *resource_name, char *layer_name, double lon, double lat, double *elevation)
 Returns an elevation of a lat/lon point on a map. More...
 
void GlmConvert (GlgProjectionType projection, GlgBoolean stretch, GlgCoordType coord_type, GlgBoolean 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 function 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...
 
void GlgSetBrowserObject (GlgObject browser, GlgObject object)
 Sets the object for browsing with the GLG Resource, Tag and Alarm browser widgets. More...
 
GlgBoolean GlgSetBrowserSelection (GlgObject object, char *resource_name, char *selection, char *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...
 
GlgBoolean GlgSetEditMode (GlgObject viewport, char *resource_name, GlgBoolean edit_mode)
 Sets the viewport's edit mode to disable input objects in the viewport while the drawing is being edited. More...
 
GlgBoolean GlgArrayAddAt (GlgObject object, GlgAnyType elem, GlgLong add_index)
 Insert an element at the specified position in the Simple Array. More...
 
GlgBoolean GlgArrayAddToBottom (GlgObject object, GlgAnyType elem)
 Add an element at the end of the Simple Array. More...
 
GlgBoolean GlgArrayAddToTop (GlgObject object, GlgAnyType elem)
 Add an element at the beginning of the Simple Array. More...
 
GlgObject GlgArrayCreate (GlgLong init_size, GlgLong increment)
 Creates a Simple Array object. More...
 
GlgBoolean GlgArrayDeleteAt (GlgObject object, GlgLong delete_index)
 Delete an element at the specified position in the Simple Array. More...
 
GlgBoolean GlgArrayDeleteFirst (GlgObject object)
 Deletes the first element of the Simple Array. More...
 
GlgBoolean GlgArrayDeleteLast (GlgObject object)
 Deletes the last element of the Simple Array. More...
 
void GlgArrayFlush (GlgObject object, GlgLong size)
 Set the size of a Simple Array. More...
 
GlgAnyType GlgArrayGetElement (GlgObject object, GlgLong index)
 Returns the element at the specified position in a Simple Array. More...
 
GlgLong GlgArrayGetIndex (GlgObject object, GlgAnyType elem)
 Returns the index of the first occurrence of an element in the Simple Array. More...
 
GlgLong GlgArrayGetSize (GlgObject object)
 Queries the size of a Simple Array. More...
 
GlgBoolean GlgArraySetElement (GlgObject object, GlgLong elem_index, GlgAnyType elem)
 Sets the value of an element at the specified position in a Simple Array. More...
 
void * GlgGetObjectData (GlgObject object)
 Retrieves application data attached to the object via GlgSetObjectData. More...
 
void GlgSetObjectData (GlgObject object, void *data)
 Attaches arbitrary application data to a graphical object. More...
 
GlgBoolean GlgSaveObject (GlgObject object, char *filename)
 Saves an object to a file. More...
 
GlgBoolean GlgSerialize (GlgObject object, GlgBoolean(*func)(void *data, GlgLong size, void *user_data), void *user_data)
 Saves a GLG object into a data stream by invoking a custom serialization callback, which can be used to implement custom save methods. More...
 
void * GlgSerializeFull (GlgObject object, GlgLong *size)
 Saves a GLG object into a raw memory block. More...
 
GlgBoolean GlgContainsObject (GlgObject container, GlgObject object)
 Checks if object belongs to a container. More...
 
GlgObject GlgFindObject (GlgObject container, GlgAnyType object, GlgSearchType search_type, GlgAnyType reserved)
 A generic find function that finds an object in a container. More...
 
GlgObject GlgGetElement (GlgObject container, GlgLong index)
 Returns the object at the specified position in a container. More...
 
GlgLong GlgGetIndex (GlgObject container, GlgObject object)
 Returns index of the first occurrence of an object in a container. More...
 
GlgObject GlgGetNamedObject (GlgObject container, char *name)
 Finds an object with the specified name inside the container of GLG objects and returns it. More...
 
GlgLong GlgGetSize (GlgObject container)
 Returns size of a container object. More...
 
GlgLong GlgGetStringIndex (GlgObject container, char *string)
 Returns index of the first occurrence of a string in a container of the GLG_STRING type. More...
 
void GlgInverse (GlgObject container)
 Inverses the order of elements inside a container object. More...
 
GlgBoolean GlgIsAt (GlgObject container, GlgPositionType position)
 Checks the position of the iteration pointer (the current element of the container). More...
 
GlgObject GlgIterate (GlgObject container)
 Traverses the container object's elements in the forward direction. More...
 
GlgObject GlgIterateBack (GlgObject container)
 Traverses the container object's elements in the backward direction. More...
 
GlgBoolean GlgReorderElement (GlgObject container, GlgLong old_index, GlgLong new_index)
 Changes an element's position inside a container. More...
 
void GlgSetEnd (GlgObject container)
 Initializes the container object for the backward traversing. More...
 
void GlgSetStart (GlgObject container)
 Initializes the container object for the forward traversing. More...
 
GlgObject GlgCreatePointArray (GlgObject object, GlgControlPointType type)
 ADVANCED: Creates and returns an array containing all control points of an object. More...
 
GlgObject GlgCreateResourceList (GlgObject object, GlgBoolean list_named_res, GlgBoolean list_def_attr, GlgBoolean list_aliases)
 Returns a list of an object's resources. More...
 
GlgBoolean GlgFindObjects (GlgObject object, GlgFindObjectsData *data)
 Finds either one or all parents or children of the specified object that match the supplied search criteria. More...
 
GlgObject GlgGetAction (GlgObject object, GlgActionType action_type, GlgTriggerType trigger_type, GlgLong button, GlgArmedStateType armed_state, GlgDoubleClickStateType double_click_state, char *action, char *subaction, GlgBoolean enabled_only)
 Returns the first found action with the matching parameters attached to the object. More...
 
GlgObject GlgGetAlarmObject (GlgObject object, char *alarm_label, GlgBoolean single_alarm, GlgLong reserved)
 Returns an alarm object with a specified alarm label, or a list of alarms matching the specified alarm label pattern. More...
 
GlgCubeGlgGetBoxPtr (GlgObject object)
 Returns an object's bounding box extent in screen coordinates. More...
 
GlgObject GlgGetObjectViewport (GlgObject object, GlgBoolean heavy_weight, GlgBoolean self)
 Returns parent viewport of a drawable GLG object. More...
 
GlgObject GlgGetParent (GlgObject object, GlgLong *num_parents)
 ADVANCED: Returns an object's parent object, if one exists, or an array of all parents for constrained data objects. More...
 
GlgObject GlgGetParentViewport (GlgObject object, GlgBoolean heavy_weight)
 Returns parent viewport of a drawable GLG object. More...
 
GlgObject GlgGetResourceObject (GlgObject parent, char *resource_name)
 Retrieves an object ID of a resource object. More...
 
GlgObject GlgGetTagObject (GlgObject object, char *search_string, GlgBoolean by_name, GlgBoolean unique_tags, GlgBoolean single_tag, GlgTagType tag_type_mask)
 Retrieves a tag object with a specified tag name, data tag source, or export tag category, or retrieves a list of tags matching the specified tag name, tag source or category pattern. More...
 
GlgBoolean GlgHasTag (GlgObject object, char *tag_name, GlgTagType tag_type_mask)
 Checks if a data or export tag with a specified tag name exists. More...
 
GlgBoolean GlgIsDrawable (GlgObject object)
 Checks if an object is drawable. More...
 
GlgObject GlgQueryTags (GlgObject object, GlgTagType tag_type_mask)
 Returns a group of all tags of the requested tag type defined in the object. More...
 
void GlgTraverseObjects (GlgObject object, GlgBoolean(*func)(GlgObject object, void *data), void *data)
 Traverses the object hierarchy of the object and invokes the supplied function on the object itself and all its subobjects, including object attributes. More...
 
void GlgTraverseObjectsExt (GlgObject object, GlgBoolean(*enter_func)(GlgObject object, void *data), GlgBoolean(*exit_func)(GlgObject object, void *data), void *data)
 Traverses the object hierarchy of the object and invokes the supplied functions on the object itself and all its subobjects, including object attributes. More...
 
GlgBoolean GlgConstrainObject (GlgObject from_attribute, GlgObject to_attribute)
 Constrains an attribute or a point of an object to an attribute or a point of another object. More...
 
GlgBoolean GlgDeleteTags (GlgObject object, GlgTagType tag_type_mask)
 Deletes all object's data tags or all object's public properties. More...
 
void GlgReleaseObject (GlgObject object, GlgObject suspend_info)
 Releases an object that was suspended for editing. More...
 
void GlgSetCustomSetupHandler (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...
 
GlgObject GlgSuspendObject (GlgObject object)
 Suspends a drawn object for editing. More...
 
GlgBoolean GlgUnconstrainObject (GlgObject attribute)
 Unconstrains a object's attribute or an object's point. More...
 
GlgObject GlgCreateInversedMatrix (GlgObject matrix)
 Inverts a matrix object. More...
 
GlgObject GlgGetDrawingMatrix (GlgObject object)
 ADVANCED: Returns transformation matrix used to draw the object. More...
 
void GlgGetMatrixData (GlgObject matrix, GlgMatrixData *matrix_data)
 ADVANCED: Queries matrix coefficients. More...
 
GlgBoolean GlgRootToScreenCoord (GlgObject viewport, GlgPoint2 *point)
 Converts screen coordinates relative to the root window to the screen coordinates in the specified viewport. More...
 
GlgBoolean GlgScreenToWorld (GlgObject object, GlgBoolean inside_vp, GlgPoint *in_point, GlgPoint *out_point)
 Converts a point's screen coordinates to the GLG world coordinate system. More...
 
void GlgSetMatrixData (GlgObject matrix, GlgMatrixData *matrix_data)
 ADVANCED: Sets matrix coefficients. More...
 
void GlgTransformPoint (GlgObject matrix, GlgPoint *in_point, GlgPoint *out_point)
 Transforms a single point. More...
 
GlgBoolean GlgTranslatePointOrigin (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...
 
GlgBoolean GlgWorldToScreen (GlgObject object, GlgBoolean 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...
 
GlgObject GlgCreateSelection (GlgObject top_vp, GlgRectangle *rectangle, GlgObject selected_vp)
 Returns a list of the objects intersecting a given rectangle. More...
 
GlgBoolean GlgEnableAttachmentPoints (GlgBoolean state)
 Controls the use of attachment points to determine object extents when the objects are aligned. More...
 
GlgBoolean GlgFitObject (GlgObject object, GlgCoordType coord_type, GlgCube *box, GlgBoolean keep_ratio)
 Fits an object to the specified rectangular area. More...
 
GlgBoolean GlgLayoutObjects (GlgObject object, GlgObject anchor, GlgLayoutType type, double distance, GlgBoolean use_box, GlgBoolean process_subobjects)
 Performs operations ranging from setting an object's width and height to aligning and layout of groups of objects. More...
 
GlgBoolean GlgMoveObject (GlgObject object, GlgCoordType coord_type, GlgPoint *start_point, GlgPoint *end_point)
 Moves an object by a move vector. More...
 
GlgBoolean GlgMoveObjectBy (GlgObject object, GlgCoordType coord_type, double x, double y, double z)
 Moves an object by the specified distances. More...
 
GlgBoolean GlgPositionObject (GlgObject object, GlgCoordType coord_type, GlgLong anchoring, double x, double y, double z)
 Positions an object at the specified location. More...
 
GlgBoolean GlgRotateObject (GlgObject object, GlgCoordType coord_type, GlgPoint *center, double x_angle, double y_angle, double z_angle)
 Rotates an object. More...
 
GlgBoolean GlgScaleObject (GlgObject object, GlgCoordType coord_type, GlgPoint *center, double x_scale, double y_scale, double z_scale)
 Scales an object. More...
 
GlgBoolean GlgTransformObject (GlgObject object, GlgObject xform, GlgCoordType coord_type, GlgObject parent)
 ADVANCED: Transforms all control points of an object with an arbitrary transformation. More...
 
GlgBoolean GlgAddDataSampleNode (GlgObject plot, GlgDataSampleNode *node, GlgBoolean quick_mode)
 Adds a data sample node directly to a plot's data buffer. More...
 
GlgObject GlgCreateChartSelection (GlgObject object, GlgObject plot, double x, double y, double dx, double dy, GlgBoolean screen_coord, GlgBoolean include_invalid, GlgBoolean x_priority)
 Selects a chart's data sample closest to the specified position and returns a message object containing the selected sample's information. More...
 
GlgDataSampleNodeGlgCreateDataSampleNode (GlgObject plot, GlgBoolean extended)
 Creates a data sample node structure to be used with the GlgAddDataSampleNode function. More...
 
char * GlgCreateTooltipString (GlgObject object, double x, double y, double dx, double dy, char *format)
 Creates and returns a chart or axis tooltip string corresponding to the specified position in screen coordinates. More...
 
void GlgFreeDataSampleNode (GlgObject plot, GlgDataSampleNode *node)
 Returns a data sample node to the plot cache for reuse, if possible. More...
 
GlgObject GlgGetLegendSelection (GlgObject object, double x, double y)
 Returns the plot object corresponding to the legend item at the specified position, if any. More...
 
GlgDataSampleGlgGetNodeDataSample (GlgDataSampleNode *node)
 Returns the node's data sample. More...
 
GlgBoolean GlgPositionToValue (GlgObject object, char *resource_name, double x, double y, GlgBoolean outside_x, GlgBoolean outside_y, double *value)
 Returns a value corresponding to the specified position on top of a Chart or an Axis object. More...
 
GlgObject GlgCloneObject (GlgObject object, GlgCloneType clone_type)
 Creates a specialized copy (clone) of an object. More...
 
GlgObject GlgCopyObject (GlgObject object)
 Creates a copy of an object. More...
 
GlgObject GlgCreateObject (GlgObjectType type, char *name, GlgAnyType param1, GlgAnyType param2, GlgAnyType param3, GlgAnyType param4)
 Creates a GLG object of a specified type. More...
 
GlgObject GlgAddAttachmentPoint (GlgObject object, double dx, double dy, double dz)
 Adds an attachment point to a reference object and returns the added point. More...
 
GlgObject GlgConvertViewportType (GlgObject object)
 Converts a viewport to a light viewport, or a light viewport to a viewport. More...
 
GlgBoolean GlgSetAttachmentMoveMode (GlgBoolean state)
 Changes the global attachment point move mode and returns the previous mode state. More...
 
GlgBoolean GlgSetResourceObject (GlgObject object, char *resource_name, GlgObject value)
 Replaces a resource object. More...
 
GlgBoolean GlgSetXform (GlgObject object, GlgObject xform)
 Adds or deletes transformations attached to an object. More...
 
GlgBoolean GlgTraceObject (GlgObject object, GlgBoolean state, GlgBoolean is_widget, GlgObject top_parent, GlgBoolean(*func)(GlgObject object, void *data), void *data)
 Highlights all objects in the drawing that depend on the tag or resource object that is being traced. More...
 
GlgBoolean GlgAddObject (GlgObject container, GlgAnyType object, GlgAccessType access_type, GlgPositionModifier pos_modifier)
 A generic function for adding an object to a container. More...
 
GlgBoolean GlgAddObjectAt (GlgObject container, GlgObject object, GlgLong index)
 Adds an object at the specified position inside the container. More...
 
GlgBoolean GlgAddObjectToBottom (GlgObject container, GlgObject object)
 Adds an object at the end of the container. More...
 
GlgBoolean GlgAddObjectToTop (GlgObject container, GlgObject object)
 Adds an object at the beginning of the container. More...
 
GlgBoolean GlgDeleteBottomObject (GlgObject container)
 Deletes an object from the bottom of the container. More...
 
GlgBoolean GlgDeleteObject (GlgObject container, GlgAnyType object, GlgAccessType access_type, GlgPositionModifier pos_modifier)
 A generic function for deleting an object from a container. More...
 
GlgBoolean GlgDeleteObjectAt (GlgObject container, GlgLong index)
 Deletes an object from the specified position in the container. More...
 
GlgBoolean GlgDeleteThisObject (GlgObject container, GlgObject object)
 Finds and deletes an object from a container. More...
 
GlgBoolean GlgDeleteTopObject (GlgObject container)
 Deletes an object from the beginning of the container. More...
 
void GlgFlush (GlgObject container, GlgLong size)
 Set the size of the container object. More...
 
GlgBoolean GlgSetElement (GlgObject container, GlgLong index, GlgObject new_object)
 Replaces the object at the specified position in a container. More...
 
void GlgAddHandler (char *handler_name, GlgHandler func)
 Registers a custom interaction handler. More...
 
GlgObject GlgCreateMessage (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 GlgSendMessageToParent. More...
 
void * GlgGetHandlerData (GlgObject viewport)
 Retrieves stored data used by a custom handler instance. More...
 
PlatformDependent GlgHandlerGetNativeEvent (GlgCallEvent *call_event)
 Retrieves a native event that triggered handler invocation. More...
 
void GlgSendMessageToParent (GlgObject viewport, GlgObject message_obj, char *action, char *subaction)
 Sends a message to the Input callback. More...
 
void GlgSetHandlerData (GlgObject viewport, void *data)
 Stores data used by the custom handler instance. More...
 

Function Documentation

◆ GlgCreateSelectionMessage()

GlgObject GlgCreateSelectionMessage ( GlgObject  top_vp,
GlgRectangle rectangle,
GlgObject  selected_vp,
GlgSelectionEventType  selection_type,
GlgLong  button 
)

Searches for an Action object that would be activated by the user interaction event.

This function provides a low-level API for searching all objects inside the given rectangle for an action with the specified selection trigger type attached to an object and returning a selection message for the first found action attached to the object.

It may be used inside the Trace callback to determine whether a mouse event was meant to trigger an action attached to a graphical object in a drawing.

Parameters
top_vpThe top viewport or light viewport of the selection query (must be an ancestor of selected_vp or the same as selected_vp). It may be either a viewport or a light viewport.
rectangleThe bounding rectangle in screen coordinates of the selected_vp viewport. All graphical shapes whose rendering intersects this rectangle, including shapes in the top_vp viewport, are included in the selection list.
selected_vpThe viewport relatively to which the bounding rectangle is defined. When used with the mouse events, this is the viewport in which the mouse event occurred. If a light viewport is supplied, its parent viewport will be used.
selection_typeSpecifies the selection type:
buttonThe mouse button (1, 2 or 3) for the GLG_CLICK_SELECTION selection type.
Returns
A message equivalent to the message received in the input callback when the event specified by the selection_type occurs in the specified rectangular area, or NULL if no matching actions were found.

◆ GlgCreateSelectionNames()

GlgObject GlgCreateSelectionNames ( GlgObject  top_vp,
GlgRectangle rectangle,
GlgObject  selected_vp 
)

Returns a list of names of objects intersecting a given rectangle.

This function provides a low-level API to determine whether a mouse event was meant to select graphical objects in a drawing, and may be used inside the Trace callback to implement custom handling of mouse events.

Action objects attached to objects in the drawing provide a higher level interface for custom object selection processing.

A more powerful GlgCreateSelection function of the Intermediate API returns object IDs of the selected objects and may be used to handle unnamed objects.

Parameters
top_vpThe top viewport or light viewport of the selection query (must be an ancestor of selected_vp or the same as selected_vp). It may be either a viewport or a light viewport.
rectangleThe bounding rectangle in screen coordinates of the selected_vp viewport. All graphical shapes whose rendering intersects this rectangle, including shapes in the top_vp viewport, are included in the selection list.
selected_vpThe viewport relatively to which the bounding rectangle is defined. When used with the mouse events, this is the viewport in which the mouse event occurred. If a light viewport is supplied, its parent viewport will be used.
Returns
An array of strings containing selected object names, or NULL if no named objects were selected. The returned array must be dereferenced with GlgDropObject when done.

The function returns an array of strings containing names of all objects that overlap with the given rectangle completely or partially. Both the selected objects at the bottom of the hierarchy and all their named parents will be included.

Objects in the array are listed in the reversed order compared to their drawing order, so that the objects that are at the bottom of the drawing list and are drawn on top of other objects will be listed first in the array.

Each returned name string is a complete resource path name (relative to top_vp) which can be used get the object ID of the object:

GlgObject selected_object = GlgGetResourceObject( top_vp, path_name );
struct GlgObjectData * GlgObject
Opaque GlgObject type that represents all GLG objects in the GLG C API.
Definition: GlgApi.h:3376
GlgObject GlgGetResourceObject(GlgObject parent, char *resource_name)
Retrieves an object ID of a resource object.

◆ GlgGetModifierState()

GlgBoolean GlgGetModifierState ( GlgModifierType  modifier)

Provides a cross-platform way to query the state of the Control and Shift keys, as well as the type of the mouse click: a single or double click.

Parameters
modifierSpecifies the modifier state to query.
Returns
True if the modifier is active, False otherwise.

◆ GlgSendMessage()

GlgAnyType GlgSendMessage ( GlgObject  object,
char *  resource_name,
char *  message,
GlgAnyType  param1,
GlgAnyType  param2,
GlgAnyType  param3,
GlgAnyType  param4 
)

Sends a message to an object to request some action to be performed.

Parameters
objectSpecifies an object to send the message to. In most cases, it is a viewport with a GLG input handler attached, such as a button or a slider.
resource_name

Specifies the resource name of a child object to send the message to, or NULL to send the message to the object specified by the object parameter. The resource path is relative to the object parameter.

For example, to send the message to a viewport's handler, use the viewport as the object parameter and "Handler" as the resource_name parameter.

messageA string that defines the message type.
param1Message type dependent.
param2Message type dependent.
param3Message type dependent.
param4Message type dependent.
Returns
The query result of messages that execute some query, is ignored otherwise.

This function is used to send a message to an input object with a request to execute some action. For example, a program can send an "Activate" message to a push button widget to simulate a user click, which will activate any click processing Action objects attached to the button. "Set" and "Reset" messages may be sent to a toggle button widget to change its value, which will also process any Action objects attached to the toggle.

The function also serves as an escape mechanism for actions that can not be easily accomplished by setting or querying a single resource, such us adding items to a list widget or querying a state of a multiple-selection list.

Refer to the Input Objects chapter of the of the GLG User's Guide and Builder Reference Manual for the description of the function's parameters and returned value for each of the GLG input handlers.

◆ GlgSetFocus()

void GlgSetFocus ( GlgObject  object,
char *  resource_name 
)

Sets the keyboard focus to an object's viewport.

If the target object is a viewport, the focus is set to this viewport, otherwise the focus is set to the target object's parent viewport.

Parameters
objectAn object used to determine the target viewport.
resource_nameThe resource path of a child object to use, or NULL to use the object specified by the object parameter. The resource path is relative to the object specified by the object parameter.

◆ GlgSetTooltipFormatter()

GlgTooltipFormatter GlgSetTooltipFormatter ( GlgTooltipFormatter  formatter)

Supplies a custom tooltip formatter.

A custom tooltip formatter may be used to supply custom context-sensitive tooltip strings by querying an object's properties and displaying them in the tooltip.

See GlgTooltipFormatter for more.

Parameters
formatterSpecifies a custom tooltip formatter.
Returns
The previously set formatter, if any, NULL otherwise.

◆ GlgStopButtonRepeat()

void GlgStopButtonRepeat ( void  )

Stops the button repeat in progress, if any.