VisuStructWinControlElementClientData (STRUCT) ¶ TYPE VisuStructWinControlElementClientData EXTENDS VisuStructWinControlClientData : STRUCT InOut: Name Type Comment Inherited from checksum VisuTypeCheckSum VisuStructWinControlClientData initialized BOOL Flag to indicate whether the client data has been initialized checksumxScaleUpdate VisuTypeChecksum The scale checksum checksumxScalePaint VisuTypeChecksum The scale checksum labelSize VisuStructStaticSize The size of the label iTextSizeIndex INT The index used for measure string m_bInit BOOL m_iNearScaleNear INT The left/top scales leftmost/topmost coordinate m_iNearScaleFar INT The left/top scales rightmost/bottommost coordinate m_iFarScaleNear INT The right/bottom scales leftmost/topmost coordinate m_iFarScaleFar INT The right/bottom scales rightmost/bottommost coordinate m_rDeltaPixel REAL The difference (in pixels) between two subsequent scale lines m_iBarLeftX INT the rectanglepoints, that describes the backgound of the bar, on which the knob can be dragged. Depending on the usage of a scale, there is more or less space at the edges to the total element size. m_iBarRightX INT m_iBarTopY INT m_iBarBottomY INT m_ColoredBarArea VisuStructPaintRectangle only used in flat style and white style m_iKnobWidthHalf INT half of the width of the knob m_KnobPaintRectangle VisuStructPaintRectangle The rectangle, that describes the knob, size used for painting: m_KnobTouchRectangle VisuStructPaintRectangle The rectangle, that describes the knob, size used for touch / moving:
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 23.05.2024, 09:55:22 companyName string 3S-Smart Software Solutions GmbH libraryFile VisuElemsWinControls.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile VisuElemsWinControls.clean.json version version 2.0.0.0 ProjectInformation PreserveCompiledLibComments bool True Released True VisuElements True LastModificationDateTime date 23.05.2024, 09:55:18 LibraryCategories library-category-list Intern|Visu AdditionalLibsToLoadAsUsed string CmpBitmapPool;CmpLog;Standard AllowVisuLibraryRedirection AllowVisuLibraryRedirection Author CODESYS Development GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP16 Description See: Description Placeholder System_VisuElemsWinControls Project VisuElemsWinControls ServerBuildException ok Title VisuElemsWinControls UseDefaultToggleTapVariable Version version 4.6.0.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. Base Interfaces ¶ Library Identification ¶ Name: Base Interfaces Version: newest Company: System Namespace: IBaseLibrary Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Base Interfaces, * (System) CmpBitmapPool ¶ Library Identification ¶ Placeholder: CmpBitmapPool Default Resolution: CmpBitmapPool, * (System) Namespace: CmpBitmapPool Library Properties ¶ LinkAllContent: False Optional: False PublishSymbolsInContainer: True QualifiedOnly: False SystemLibrary: False Key: CmpBitmapPool CmpDynamicText ¶ Library Identification ¶ Placeholder: CmpDynamicText Default Resolution: CmpDynamicText, * (System) Namespace: CmpDynamicText Library Properties ¶ LinkAllContent: False Optional: False PublishSymbolsInContainer: True QualifiedOnly: False SystemLibrary: False Key: CmpDynamicText CmpLog ¶ Library Identification ¶ Placeholder: CmpLog Default Resolution: CmpLog, * (System) Namespace: CmpLog Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpLog CmpVisuHandler ¶ Library Identification ¶ Placeholder: CmpVisuHandler Default Resolution: CmpVisuHandler, * (System) Namespace: CmpVisuHandler Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpVisuHandler Datasources Interfaces ¶ Library Identification ¶ Name: Datasources Interfaces Version: newest Company: 3S - Smart Software Solutions GmbH Namespace: IDatasources Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: Datasources Interfaces, * (3S - Smart Software Solutions GmbH) Standard ¶ Library Identification ¶ Placeholder: Standard Default Resolution: Standard, * (System) Namespace: Standard Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Standard Standard64 ¶ Library Identification ¶ Placeholder: Standard64 Default Resolution: Standard64, * (System) Namespace: Standard64 Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Standard64 StringUtils ¶ Library Identification ¶ Placeholder: StringUtils Default Resolution: StringUtils, * (System) Namespace: Stu Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: StringUtils VisuElemBase ¶ Library Identification ¶ Placeholder: System_VisuElemBase Default Resolution: VisuElemBase, * (System) Namespace: VisuElemBase Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuElemBase VisuElems ¶ Library Identification ¶ Placeholder: System_VisuElems Default Resolution: VisuElems, * (System) Namespace: VisuElems Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuElems VisuInputs ¶ Library Identification ¶ Placeholder: System_VisuInputs Default Resolution: VisuInputs, * (System) Namespace: VisuInputs Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuInputs
VisuInputs Library Documentation ¶ Company : System Title : VisuInputs Version : 4.6.0.0 Categories : Intern|Visu Author : CODESYS Development GmbH Placeholder : System_VisuInputs Description [ 1 ] ¶ This library contains functionality used for the visualization. This functionality includes basic input handling for visuelements as well as two special inputs that can be used for implementing a button element. Contents: ¶ Functions VisuInput_CheckUpdateElementStatePossible_DependingOnCurrentInput (Function) TL_ElementProperties (TextList) Indices and tables ¶ [ 1 ] Based on VisuInputs.library, last modified 23.05.2024, 09:57:13. LibDoc 4.5.0.0 The content file VisuInputs.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 23.05.2024, 09:57:17.
Functions ¶ VisuInput_CheckUpdateElementStatePossible_DependingOnCurrentInput (Function)
VisuInput_CheckUpdateElementStatePossible_DependingOnCurrentInput (FUN) ¶ FUNCTION VisuInput_CheckUpdateElementStatePossible_DependingOnCurrentInput : BOOL Checks, if the element has an unfinished tap input event. Returns true, if element state can be updated, because input handling is done. An element should not be switched invisible or deactive, if tap event is not finished. Therefore, we delay the change of the element state. InOut: Scope Name Type Comment Return VisuInput_CheckUpdateElementStatePossible_DependingOnCurrentInput BOOL Input ive IVisualElement the current visual element, we do the check for. pInput2 POINTER TO VisuFbInputBase2 input configuration the element is using. Can be null. iElemNr DINT the element index, used with VisuFbInputBase2 pCurrentClientData POINTER TO VisuStructClientData
TL_ElementProperties (Text List) ¶
VisuEnumCurrentCheckboxState (ENUM) ¶ TYPE VisuEnumCurrentCheckboxState : This enumeration describes the states of the range values InOut: Name Initial FILTER_AND_LIMITED_RANGE 1 JUST_FILTER 2 JUST_LIMITED_RANGE 3 NOTHING 4
VisuEnumTableParts (ENUM) ¶ TYPE VisuEnumTableParts : InOut: Name CONTENT COL_HEAD ROW_HEAD COL_ROW_HEAD
VisuFbTableColumnSimpleBase (FB) ¶ FUNCTION_BLOCK VisuFbTableColumnSimpleBase EXTENDS VisuFbAbstractTableColumn IMPLEMENTS IVisualTableColumnSimpleBase InOut: Scope Name Type Initial Comment Inherited from Input m_pFirstCellData POINTER TO BYTE this input variable is used by CoDeSys to set the address of the first data cell of the column VisuFbAbstractTableColumn m_pSecondCellData POINTER TO BYTE The address of the second data cell of the column VisuFbAbstractTableColumn m_iLineOffset DWORD the offset of the addresses of the 1st and the 2nd data cell. Needed to calculate the addresses of the subsequent (3,4,5…) data cells VisuFbAbstractTableColumn DataArray IComplexElementCall VisuFbAbstractTableColumn m_pParentElement POINTER TO BYTE special attribute for this node, to make it real invisible by the AP VisuFbAbstractTableColumn m_sColumnVariable STRING(255) This variable stores the name of the variable, that is used to retrieve the cell values of the column Width INT 20 the width of the column. Default width is 20 m_bBitmapColumn BOOL Indicates, whether the content of the cell has to be interpreted as bitmap ID for drawing a bitmap. Can only be used if the cell content is of type string. BitmapConfiguration VisuStructBitmapConfiguration The configuration of the bitmap Editable BOOL TRUE if the cells of the column can be edited. Not used at the moment Selected BOOL TRUE if the column has to be displayed in the table Template VisuFbElemSimple The rectangle, that has to be used if Template is TRUE RowCount INT the number of rows of the column ColumnType TypeClass The data type of the column m_arrCells POINTER TO ARRAY [0..1] OF VisuFbElemSimple a pointer to an array of visualisation elements, that render the cells. The number of elements in the array corresponds to the number of visible rows in the table. The number of visible rows is also a parameter of the paint method. Should be accessed using the property “Cells”. m_iCountCells INT The number of elements in m_arrCells Should be accessed using the property “CellCount”. m_arrVisuFbAnalyzeTextVars POINTER TO ARRAY [0..1] OF VisuFbAnalyzeTextVars This variable stores the information for each cell (m_arrCells), how the text of a cell is retrieved. We need an array with the same size like m_arrCells, because all visible cells are computed during protUpdateCell m_iArrayIndex INT The array index which belongs to the column (example: The leftmost column (column index = 0) doesn’t have the array index 0 if the array dimension starts with a value != 0. So we have to store the corresponding array index too). Necessary Properties: DynamicCellsData DynamicCellsDataBase TemplateActive Methods: Checksum ContainsPoint GetColWidth GetMouseDownRectColumn GetRowCount GetSurroundingRectCell GetSurroundingRectColumn GetSurroundingRectColumnStatic IncreaseCellCount Initialize Paint PaintContent ResetCellCount SetClientData SetVisible UpdateDynamicCells protPaintCell protUpdateCell DoUpdateCell DoUpdateCellWithTemplate IsCellSelected Structure: Checksum (Method) ContainsPoint (Method) GetColWidth (Method) GetMouseDownRectColumn (Method) GetRowCount (Method) GetSurroundingRectCell (Method) GetSurroundingRectColumn (Method) GetSurroundingRectColumnStatic (Method) IncreaseCellCount (Method) Initialize (Method) Paint (Method) PaintContent (Method) ResetCellCount (Method) SetClientData (Method) SetVisible (Method) UpdateDynamicCells (Method) protPaintCell (Method) protUpdateCell (Method) virtual DoUpdateCell (Method) DoUpdateCellWithTemplate (Method) DynamicCellsData (Property) DynamicCellsDataBase (Property) IsCellSelected (Method) TemplateActive (Property)