fwInstallation
8.4.1
|
Functions | |
int | fwInstallationQtHelp_buildCollection () |
bool | fwInstallationQtHelp_projectHasCollection () |
bool | fwInstallationQtHelp_isAssistantOpen () |
void | fwInstallationQtHelp_closeAssistant () |
int | _fwInstallationQtHelp_buildQhc (string templateFilePath, string collectionPath, dyn_string qchFilePaths) |
string | _fwInstallationQtHelp_getQtHelpAssistantExePath () |
int | _fwInstallationQtHelp_getComponentQchFilePaths (dyn_string &qchFilePaths) |
void | _fwInstallationQtHelp_getExistingQchFilePaths (dyn_string &qchFilePaths, int activeLang=getActiveLang(), int searchPathMin=1, int searchPathMax=SEARCH_PATH_LEN) |
void | _fwInstallationQtHelp_getAdditionalQchFilePaths (dyn_string &qchFilePaths) |
void | _fwInstallationQtHelp_filterQchFiles (dyn_string &qchFilePaths, const dyn_string excludes) |
Variables | |
const string | csFwInstallationQtHelpLibVersion = "8.4.1" |
const string | FW_INSTALLATION_QT_CMD_UNIX_GET_ASSISTANT_PIDS |
const string | FW_INSTALLATION_QT_CMD_WIN_PS_GET_ASSISTANT_PROC |
This file contains functions related to building Qt Help Collection for a project.
int fwInstallationQtHelp_buildCollection | ( | ) |
Built a Qt Help Collection for the current project
Locate all Qt Compressed Help (QCH) files within the help/<language>/
subdirectory, and all QCH files related to JCOP components defined by the data-point element qtHelpFiles
in the data-point type _FwInstallationComponents
.
bool fwInstallationQtHelp_projectHasCollection | ( | ) |
Check if this project has a custom Qt Help Collection
bool fwInstallationQtHelp_isAssistantOpen | ( | ) |
Check if Qt Assistant tool with customized project Qt Help Collection is opened on local system
void fwInstallationQtHelp_closeAssistant | ( | ) |
Close all opened Qt Assistant processes, that use customized project Qt Help Collection
int _fwInstallationQtHelp_buildQhc | ( | string | templateFilePath, |
string | collectionPath, | ||
dyn_string | qchFilePaths | ||
) |
Build the Qt Help Collection (QHC) from the Qt Help Collection Project (QHCP)
Locates the qcollectiongenerator
executable, and sterilises the file paths into quoted native paths, then runs the executable on those paths.
templateFilePath | Qt Help Collection template. |
collectionPath | Output file path for the Qt Help Collection binary. |
qchFilePaths | List of Qt Compressed Help files to include. |
string _fwInstallationQtHelp_getQtHelpAssistantExePath | ( | ) |
Locate the assistant
executable.
Searches for the assistant
executable in the WinCC OA installation ./bin
subdirectory.
assistant
executable, or empty string if not found. int _fwInstallationQtHelp_getComponentQchFilePaths | ( | dyn_string & | qchFilePaths | ) |
Locate Qt Compressed Help files (*.qch) for installed JCOP components.
For installed components, described by data points of type _FwInstallationComponents
, get the path to all files listed in the .qtHelpFiles
data point element. This function also verifies that the files exist and can be read.
[out] | qchFilePaths | A list that QCH file paths will be appended to. |
void _fwInstallationQtHelp_getExistingQchFilePaths | ( | dyn_string & | qchFilePaths, |
int | activeLang = getActiveLang() , |
||
int | searchPathMin = 1 , |
||
int | searchPathMax = SEARCH_PATH_LEN |
||
) |
Find pre-existing Qt Compressed Help files (*.qch)
Searches the 'help' directories in relevant locations, starting from the main WinCC OA installation directory, to find existing QCH files. This should locate the WinCC OA primary documentation.
[out] | qchFilePaths | A list that QCH file paths will be appended to. |
activeLang | Numeric ID of the language subdirectory to search. By default this value is the number returned by the getActiveLang function. | |
searchPathMin | Minimum search path level which is passed as the level parameter for the getPath function. Default is 1. | |
searchPathMax | Maximum search path level which is passed as the level parameter for the getPath function. Default is the constant SEARCH_PATH_LEN . |
void _fwInstallationQtHelp_getAdditionalQchFilePaths | ( | dyn_string & | qchFilePaths | ) |
Add additional *.QCH help files from the FW_INSTALLATION_QT_HELP_INCLUDE list to the list of file paths
[out] | qchFilePaths | A list that QCH file paths will be appended to. |
void _fwInstallationQtHelp_filterQchFiles | ( | dyn_string & | qchFilePaths, |
const dyn_string | excludes | ||
) |
Remove *.QCH help files from the list of file paths if specified as excluded
[out] | qchFilePaths | A list that QCH file paths will be trimmed to remove excluded files. |
excludes | List of filenames to exclude from the collection. |
const string csFwInstallationQtHelpLibVersion = "8.4.1" |
Version of this library. Used to determine the coherency of all libraries of the installation tool Please do not edit it manually
const string FW_INSTALLATION_QT_CMD_UNIX_GET_ASSISTANT_PIDS |
Bash command to get list of PIDs of running assistant processes, that use custom project collection
const string FW_INSTALLATION_QT_CMD_WIN_PS_GET_ASSISTANT_PROC |
PowerShell command to get running assistant processes, that use custom project collection