IGestureEventHandler.HandleFlickGesture (METH) ¶ METHOD HandleFlickGesture : BOOL This method will be called when a pan gesture was detected by the visualiuation. RETURN: TRUE - When the handler has handled this event and it should not be handled by someone else FALSE - When the event is not handled by this handler InOut: Scope Name Type Comment Return HandleFlickGesture BOOL Input start VisuStructPoint The point on the screen where this gesture was started offset VisuStructPoint In fact not a point but an offset. The distance, the gesture was moved on the screen. velocityPxPerSecond UDINT The velocity of this flick gesture in pixels per second pClient POINTER TO VisuStructClientData A pointer to the client structure were the event occurred.
IGestureEventHandler.HandlePanGesture (METH) ¶ METHOD HandlePanGesture : BOOL This method will be called when a pan gesture was detected by the visualiuation. RETURN: TRUE - When the handler has handled this event and it should not be handled by someone else FALSE - When the event is not handled by this handler InOut: Scope Name Type Comment Return HandlePanGesture BOOL Input start VisuStructPoint The point on the screen where this gesture was started offset VisuStructPoint In fact not a point but an offset. The distance, the gesture was moved on the screen. pClient POINTER TO VisuStructClientData A pointer to the client structure were the event occurred.
IFrameManager.SwitchToVisuGlobally (METH) ¶ METHOD SwitchToVisuGlobally : INT Changes the shown visualization in a frame for some sorts of clients. All clients of the given type will switch to the given visualization. If no according visu is found, nothing will happen. InOut: Scope Name Type Comment Return SwitchToVisuGlobally INT Input clientsToChange Visu_ClientType This can be a combination of the values in the enumeration Visu_ClientType, all clients of this type will be switched to the given visu. stFramePath STRING(255) The identification of the frame that should be switched iIndex INT The Index of the visu that should be shown
IFrameManager.UnregisterFrame (METH) ¶ METHOD UnregisterFrame : INT InOut: Scope Name Type Return UnregisterFrame INT Input stPath STRING(255)
IFrameManager2 (ITF) ¶ INTERFACE IFrameManager2 EXTENDS IFrameManager Methods: GetFrameByIndex GetSelectedVisuByIndex SwitchToVisu2 SwitchToVisuByIndex GetFrameCount , inherited from IFrameManager GetRegisteredFrames , inherited from IFrameManager GetSelectedVisu , inherited from IFrameManager GetVisuCount , inherited from IFrameManager GetVisuName , inherited from IFrameManager RegisterFrame , inherited from IFrameManager SwitchToVisu , inherited from IFrameManagerBase SwitchToVisuGlobally , inherited from IFrameManager UnregisterFrame , inherited from IFrameManager Structure: GetFrameByIndex (Method) GetSelectedVisuByIndex (Method) SwitchToVisu2 (Method) SwitchToVisuByIndex (Method)
IFrameManager2.SwitchToVisuByIndex (METH) ¶ METHOD SwitchToVisuByIndex : INT It switches the visualization using the index instead of the frame path InOut: Scope Name Type Comment Return SwitchToVisuByIndex INT Input iIndexFrame INT The internal array index of the frame that should be handled pClientData POINTER TO VisuStructClientData The client whose frame content shall be changed iIndex INT The index of the visualization that should be selected xUpdVar BOOL If also the variable linked to the frame has to be updated xUpdLastIndex BOOL If also the index stored as “last call” has to be updated (specifically used in redundancy)
IFrameManagerBase (ITF) ¶ INTERFACE IFrameManagerBase EXTENDS __SYSTEM.IQueryInterface could be used by endusers too -> visible Methods: SwitchToVisu Structure: SwitchToVisu (Method)
IFrameManagerBase.SwitchToVisu (METH) ¶ METHOD SwitchToVisu : INT InOut: Scope Name Type Comment Return SwitchToVisu INT Input stFramePath STRING(255) The path of the frame that should be handled @IECCodeConverter_Type: String pClientData POINTER TO VisuStructClientData The client whose frame content shall be changed iIndex INT the index of the visualization that should be selected
IFrameManager2.GetFrameByIndex (METH) ¶ METHOD GetFrameByIndex : STRING Will return the frame based on the index InOut: Scope Name Type Comment Return GetFrameByIndex STRING Input index INT The the internal array index of the frame that should be handled
IFrameManager2.GetSelectedVisuByIndex (METH) ¶ METHOD GetSelectedVisuByIndex : INT Will return the index of the currently selected visualization or a negative value in case of an error InOut: Scope Name Type Comment Return GetSelectedVisuByIndex INT Input index INT The the internal array index of the frame that should be handled pClientData POINTER TO VisuStructClientData The client whose frame information is requested