|
void | unRecipeFunctions_getSelectedRecipeDp (string &sSelected, dyn_string &exceptionInfo) |
|
void | unRecipeFunctions_animateSelectionProgressBar (string sDpName) |
|
bool | unRecipeFunctions_selectItemInComboBox (string sShape, string sSelect, int indexOtherwise=1) |
|
void | _unRecipeFunctions_setTableColumnBGColor (string tableName, string columnName, string color) |
|
void | _unRecipeFunctions_setTableRowBGColor (string tableName, int rowIndex, string color) |
|
void | _unRecipeFunctions_setTableCellBGColor (string tableName, int rowIndex, string columnName, string color) |
|
void | _unRecipeFunctions_resetRecipeElementsBgColor () |
|
void | _unRecipeFunctions_setInvalidRows (dyn_string rows, string sTableName="RecipeElements") |
|
string | _unRecipeFunctions_adjustStringToSize (shape hiddenShape, string aString, int width) |
|
void | _unRecipeFunctions_setRecipeInstancePanelComponentsEnabled (bool value) |
|
void | _unRecipeFunctions_enableRecipeInstanceWarning (bool bEnable, string sMessage="") |
|
void | unRecipeFunctions_registerSelectButtonCB (string sDp, bool bSystemConnected) |
|
void | unRecipeFunctions_animateSelectButtonCB (string sDp1, bool bLocked, string sDp2, string sSelectedManager) |
|
void | unRecipeFunctions_disconnectSelectButton () |
|
(c) Copyright CERN 2005. All rights not expressly granted are reserved. iceco.nosp@m.ntro.nosp@m.ls.su.nosp@m.ppor.nosp@m.t@cer.nosp@m.n.ch
SPDX-License-Identifier: LGPL-3.0-only
unRcpFunctions_gui.ctl This file contains functions related to the graphical user interface.
- Creation Date
- 15/03/2017
- Modification History
- Constraints
- None
- Usage
- Public
- PVSS managers
- Ui, CTRL
- Author
- Ivan Prieto Barreiro (BE-ICS)
◆ unRecipeFunctions_getSelectedRecipeDp()
void unRecipeFunctions_getSelectedRecipeDp |
( |
string & |
sSelected, |
|
|
dyn_string & |
exceptionInfo |
|
) |
| |
Get the data point name of the recipe instance selected in the panel.
- Parameters
-
sSelected | - [OUT] DP name of the recipe instance selected in the panel. |
exceptionInfo | - [OUT] Standard exception handling variable. |
◆ unRecipeFunctions_animateSelectionProgressBar()
void unRecipeFunctions_animateSelectionProgressBar |
( |
string |
sDpName | ) |
|
Method used to animate the selection progress bar in the recipe instance panel.
- Parameters
-
sDpName | - [IN] Data point name of the selected recipe instance. |
- Reviewed:
- 2018-09-12 Thread
Selection Progress Bar animation
◆ unRecipeFunctions_selectItemInComboBox()
bool unRecipeFunctions_selectItemInComboBox |
( |
string |
sShape, |
|
|
string |
sSelect, |
|
|
int |
indexOtherwise = 1 |
|
) |
| |
Selects an item in a combo box.
- Parameters
-
sShape | - [IN] Combo box name. |
sSelect | - [IN] Item to select. |
indexOtherwise | - [IN] Index to select in case the selected item does not exist. |
- Returns
- TRUE if the item to select exists in the combobox, otherwise false.
◆ _unRecipeFunctions_setTableColumnBGColor()
void _unRecipeFunctions_setTableColumnBGColor |
( |
string |
tableName, |
|
|
string |
columnName, |
|
|
string |
color |
|
) |
| |
Set the background color of a column in a table.
- Parameters
-
tableName | - [IN] The name of the table. |
columnName | - [IN] The name of the column. |
color | - [IN] The new color for the column. |
◆ _unRecipeFunctions_setTableRowBGColor()
void _unRecipeFunctions_setTableRowBGColor |
( |
string |
tableName, |
|
|
int |
rowIndex, |
|
|
string |
color |
|
) |
| |
Set the background color of a row in a table.
- Parameters
-
tableName | - [IN] The name of the table. |
rowIndex | - [IN] The row index. |
color | - [IN] The new color for the row. |
◆ _unRecipeFunctions_setTableCellBGColor()
void _unRecipeFunctions_setTableCellBGColor |
( |
string |
tableName, |
|
|
int |
rowIndex, |
|
|
string |
columnName, |
|
|
string |
color |
|
) |
| |
Set the background color of a cell in a table.
- Parameters
-
tableName | - [IN] The name of the table. |
rowIndex | - [IN] The row index. |
columnName | - [IN] The name of the column. |
color | - [IN] The new color for the row. |
◆ _unRecipeFunctions_resetRecipeElementsBgColor()
void _unRecipeFunctions_resetRecipeElementsBgColor |
( |
| ) |
|
Restore the original colors in the recipe elements table (recipe instance panel).
◆ _unRecipeFunctions_setInvalidRows()
void _unRecipeFunctions_setInvalidRows |
( |
dyn_string |
rows, |
|
|
string |
sTableName = "RecipeElements" |
|
) |
| |
Set the background color of the rows in the RecipeElements table that contains invalid values.
- Parameters
-
rows | - [IN] Indices of the invalid rows. |
sTableName | - [IN] Name of the table where the invalid rows must be set. |
◆ _unRecipeFunctions_adjustStringToSize()
string _unRecipeFunctions_adjustStringToSize |
( |
shape |
hiddenShape, |
|
|
string |
aString, |
|
|
int |
width |
|
) |
| |
Method used to trim a label to the appropriate size.
- Parameters
-
hiddenShape | - [IN] Hidden shape (label) to calculate the width of the string. |
aString | - [IN] String to be trimmed if its width is bigger than the size specified. |
width | - [IN] Width of the shape where the label will be placed. |
- Returns
- A new string that fits in the specified width.
◆ _unRecipeFunctions_setRecipeInstancePanelComponentsEnabled()
void _unRecipeFunctions_setRecipeInstancePanelComponentsEnabled |
( |
bool |
value | ) |
|
Enable/disable some graphical components of the recipe instance panel (required for the recipe activation).
- Parameters
-
value | - [IN] The value for the enabled property of the graphical components. |
◆ _unRecipeFunctions_enableRecipeInstanceWarning()
void _unRecipeFunctions_enableRecipeInstanceWarning |
( |
bool |
bEnable, |
|
|
string |
sMessage = "" |
|
) |
| |
Function to show/hide the recipe instance warning message.
- Parameters
-
bEnable | - [IN] Flag to specify the visibility of the warning message. |
sMessage | - [IN] Message to display in the WarningText label. |
◆ unRecipeFunctions_registerSelectButtonCB()
void unRecipeFunctions_registerSelectButtonCB |
( |
string |
sDp, |
|
|
bool |
bSystemConnected |
|
) |
| |
Registers the callback to the select button
- Parameters
-
sDp | - [IN] |
bSystemConnected | - [IN] |
- Reviewed:
- 2018-08-06 Callback
◆ unRecipeFunctions_animateSelectButtonCB()
void unRecipeFunctions_animateSelectButtonCB |
( |
string |
sDp1, |
|
|
bool |
bLocked, |
|
|
string |
sDp2, |
|
|
string |
sSelectedManager |
|
) |
| |
Animates the select button
- Parameters
-
sDp1 | |
bLocked | |
sDp2 | |
sSelectedManager | |
- Reviewed:
- 2018-08-06 Callback
◆ unRecipeFunctions_disconnectSelectButton()
void unRecipeFunctions_disconnectSelectButton |
( |
| ) |
|
Disconnection of the select button