> For the complete documentation index, see [llms.txt](https://sandbox-docs.verifone.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sandbox-docs.verifone.com/s-adk-5.1-programmers-guide/readme/annotated/class_u_i_catalog.md). # UICatalog [Public Types](#pub-types) | [Public Member Functions](#pub-methods) `#include <`[ui.h](/s-adk-5.1-programmers-guide/ui_8h_source.md)`>` | | | | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Public Types | | | enum | [Priority](#a315655b1bb5848c063491adffde62b15) { [Intern](#a315655b1bb5848c063491adffde62b15a080ea5eddade4e450a13597d3abfc7cb) = 0, [Extern](#a315655b1bb5848c063491adffde62b15acc2095146c832d047006acd1fbad8d40) = 1, [IntExt](#a315655b1bb5848c063491adffde62b15aa66af95f11d4ab9cb729a44a46bcbb29) = 2, [ExtInt](#a315655b1bb5848c063491adffde62b15a0f50e7103bfa6183d89169bdd33f16af) = 3 } | | | | | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Public Member Functions | | | | [UICatalog](#ad503da21c91ade8c4d676010393836ec) (sdi::Language lang=sdi::LANG\_NO\_LANG, const std::string \&www\_dir="") | | virtual | [\~UICatalog](#ab85073367df4bd2b88e6588ea085235e) () | | bool | [set](#a358e213b2dc57bf1d49d353707b6c0ae) (sdi::Language lang, const std::string \&www\_dir="") | | std::string | [error](#a088fd30b0c4d1f217fcf44728f789f36) () | | bool | [valid](#a9b7ed11a4b19fd017a125345cdb7ef4e) ([Priority](#a315655b1bb5848c063491adffde62b15) prio) | | bool | [setUIGlobal](#aab3ca0cbe3d23cd9577ae2ecdcf191ae) ([Priority](#a315655b1bb5848c063491adffde62b15) prio, bool restore=true) | | std::string | [getText](#a9bf11d9db05366a4dc04f6c53a16c2e6) (const std::string \&name, const std::string \&deflt="", [Priority](#a315655b1bb5848c063491adffde62b15) prio=[Intern](#a315655b1bb5848c063491adffde62b15a080ea5eddade4e450a13597d3abfc7cb)) | ### DetailedDescription helper class to use 2 UI text catalogs (one internal and one external, provided by customer) at the same time, which is not supported by ADKGUI. SDI passes all texts with XML processing instruction \ or \ to its HTML dialogs (\ in HTML is not used). All catalog texts are previously looked up by [UICatalog](/s-adk-5.1-programmers-guide/readme/annotated/class_u_i_catalog.md):[getText()](#a9bf11d9db05366a4dc04f6c53a16c2e6) function. For the dual catalog support, SDI implements an additional XML processing instruction \, which more or less works the same as \ (as supported by ADKGUI), but this instruction has a special meaning when used in internal SDI text catalogs: If an internal text is looked up, UiCatalog:[getText()](#a9bf11d9db05366a4dc04f6c53a16c2e6) substitutes all place holders \ by the corresponding text value provided by the external customer catalog (if available). In this way, SDI supports priorization of custom texts (from external catatag) before using SDI default texts (in own internal text catalog). In addition, instruction \ in internal catalog will directly refer the corresponding text key in the internal catalog only, thus, this instruction can be used to compose SDI texts from multiple private text keys. Intructions \ and \, both work in texts of the internal catalog only, whereas instruction \ read from the external catalog are kept, since these are processed by ADKGUI running with the external catalog afterwards. [UICatalog](/s-adk-5.1-programmers-guide/readme/annotated/class_u_i_catalog.md):[getText()](#a9bf11d9db05366a4dc04f6c53a16c2e6) and other functions of class [UICatalog](/s-adk-5.1-programmers-guide/readme/annotated/class_u_i_catalog.md) use parameter of enum Priority, which allows to select the catalog type and and to specify priority for catalog access. {% hint style="info" %} [UICatalog](/s-adk-5.1-programmers-guide/readme/annotated/class_u_i_catalog.md) is designed for usage on stack, since function [setUIGlobal()](#aab3ca0cbe3d23cd9577ae2ecdcf191ae) allows to switch global language catalog for ADKGUI temporarily (with use of [uiSetCatalog()](/s-adk-5.1-programmers-guide/readme/modules/group__vfigui/namespacevfigui.md#ab103c683852a0d4b19695e76f90dcf82)). Depending on the restore flag of this function, the previous ADKGUI catalog is restored, if the [UICatalog](/s-adk-5.1-programmers-guide/readme/annotated/class_u_i_catalog.md) object is deleted or [set()](#a358e213b2dc57bf1d49d353707b6c0ae) function is called to switch the catalog. Thus, [UICatalog](/s-adk-5.1-programmers-guide/readme/annotated/class_u_i_catalog.md) object must not be shared between threads and if multiple threads use different [UICatalog](/s-adk-5.1-programmers-guide/readme/annotated/class_u_i_catalog.md) objects at the same time they might have to enable thread local properties (ADKGUI), since [uiSetCatalog()](/s-adk-5.1-programmers-guide/readme/modules/group__vfigui/namespacevfigui.md#ab103c683852a0d4b19695e76f90dcf82) would switch language of ADKGUI globally. {% endhint %} ### MemberEnumeration Documentation ### Priority enum \[Priority]\(#a315655b1bb5848c063491adffde62b15) priority to select catalog type for [valid()](#a9b7ed11a4b19fd017a125345cdb7ef4e), [setUIGlobal()](#aab3ca0cbe3d23cd9577ae2ecdcf191ae) and [getText()](#a9bf11d9db05366a4dc04f6c53a16c2e6) | | | | ---------- | --------------------------------------------------------------------------------------------------------------------------------------- | | Enumerator | | | Intern | use/lookup internal catalog only | | Extern | use/lookup external catalog only | | IntExt | use/lookup internal catalog first. If internal catalog is not available (or text not found there), use the external catalog afterwards. | | ExtInt | use/lookup external catalog first. If external catalog is not available (or text not found there), use the internal catalog afterwards. | ### Constructor& Destructor Documentation ### UICatalog() [UICatalog](/s-adk-5.1-programmers-guide/readme/annotated/class_u_i_catalog.md) constructor, which checks for required internal and external dialog depending on required language. The catalog works with both catalogs at the same time. By default (with empty *www\_dir*), the external (custom) catalog custom-\.ctlg is looked up from external user configuration folders: VOS/VOS2: 1. "/etc/config/sdi/www/<\terminal folder\\>" 1. "/etc/config/sdi/www/default" VOS3: 1. "/home/usr\\\/sdi/www/<\terminal folder\\>" 1. "/home/usr\\\/sdi/www/default" In addition, the internal calalog sdi-\.ctlg is looked up from internal SDI resource 1. "$HOME/www/\\\" 2. "$HOME/www/default" **Parameters** \[in] **lang** language ID (see supported SDI languages in lang.h) LANG\_NO\_LANG means using the SDI system default language. \[in] **www\_dir** Instead of using standard SDI www folders above, the folder \ might be specified by parameter www\_dir to look up catalog files:"\\\/\\\""\\\/default" Providing an external \ directory with parameter www\_dir will always use "custom-\\\.ctlg" and ommit usage of "sdi-\\\.ctlg".

Usually SDI uses flags SDI standard folders to lookup catalog files. Only SDI command HTML Dialog (24-0A) uses parameter www_dir, since customer dialogs/resource files are separated from normal SDI dialogs (installed to "www/custom" with the standard system package).

### \~UICatalog() \\\~[UICatalog](/s-adk-5.1-programmers-guide/readme/annotated/class_u_i_catalog.md) virtual destructor (will restore the previous ADKGUI catalog, if setUIGlobal(true) was invoked on this object) ### MemberFunction Documentation ### error() std::string error inline returns the error string in case of internal error #### Returns readable error information as string (e.g. used for trace) ### getText() string getText lookup a text from this catalog object by key `name`. If text is not found in catalog(s) or the corresponding catalog does not exist, the function returns default value passed with parameter `deflt`. Parameter *prio* specifies priority, which catalog is used to lookup the text first. Usually, SDI looks up texts from internal catalog with default priority *Intern*. Internal SDI texts may contain processing instructions \ or \. Placeholder \ will be automatically substituted with the corresponding value of the external custom catalog (if the referred key is found there), for more details see description of function textSubstitute(). Placeholder \ in internal catalog works the same as for ADKGUI and is used to refer private text variables of the internal text catalog only. For special cases (e.g. PIN entry) SDI accesses external catalog directly with priority *Extern*. External catalog lookups do not substitute \ or \ as described above. **Parameters** \[in] **name** of key used to lookup the text in calalog \[in] **deflt** text that is returned, if text is not found in calalog \[in] **prio** specifying catalog priority and lookup order (see enum Priority) #### Returns text from catalog for success, else default value passed with parameter `deflt` ### set() bool set switch the catalog for this object Please note that this function will restore the previous ADKGUI catalog, if setUIGlobal(true) was invoked on this object. **Parameters** \[in] **lang** language ID (for more details see constructor description) \[in] **www\_dir** alternative www folder (for more details see constructor description) #### Returns true if catalog is valid, else false (call [error()](#a088fd30b0c4d1f217fcf44728f789f36) for more details) ### setUIGlobal() bool setUIGlobal If the object is valid, this functions sets the catalog to UI property context with [uiSetCatalog()](/s-adk-5.1-programmers-guide/readme/modules/group__vfigui/namespacevfigui.md#ab103c683852a0d4b19695e76f90dcf82), so that HTML documents can use XML processing instruction \ with next call of [uiInvoke()](/s-adk-5.1-programmers-guide/readme/modules/group__vfigui/namespacevfigui.md#af330e250493b2c6546274bea96d87fca)/uiInvokeURL(). **Parameters** \[in] **restore** set to true, if the previous global UI dialog shall be restored, if this object is deleted or set() is called to switch the dialog. Set to false to keep this catalog for UI after object deletion. \[in] **prio** specifying the catalog priorty (see enum Priority). #### Returns true for success, else false if [uiSetCatalog()](/s-adk-5.1-programmers-guide/readme/modules/group__vfigui/namespacevfigui.md#ab103c683852a0d4b19695e76f90dcf82) has failed (call [error()](#a088fd30b0c4d1f217fcf44728f789f36) for more details). In case this function is invoked with catalog priority, which is not valid (see function [UICatalog::valid()](#a9b7ed11a4b19fd017a125345cdb7ef4e)), the UI catalog is reset to empty and the function returns true. Then ADKGUI invokes dialogs w/o catalog support. ### valid() bool valid returns true, if this [UICatalog](/s-adk-5.1-programmers-guide/readme/annotated/class_u_i_catalog.md) object is valid/available for the specified catalog priority *prio*. [UICatalog::getText()](#a9bf11d9db05366a4dc04f6c53a16c2e6) will work for this catalog priority and not just returning default value. In addtion, [UICatalog::setUIGlobal()](#aab3ca0cbe3d23cd9577ae2ecdcf191ae) will effectly load an UI catalog and not just reset the recent one. **Parameters** \[in] **prio** specifying the catalog to validate (see enum Priority). {% hint style="info" %} Priority ExtInt and IntExt effect the same and check availability of both, internal and external catalog. {% endhint %} #### Returns true if the catalog(s) is/are valid and available. {% hint style="info" %} In case false is returned, function [error()](#a088fd30b0c4d1f217fcf44728f789f36) can be used to retrieve error reason. {% endhint %} *** The documentation for this class was generated from the following files: * sdi/src/[ui.h](/s-adk-5.1-programmers-guide/ui_8h_source.md) * sdi/src/[ui\_priv.cpp](/s-adk-5.1-programmers-guide/readme/files/dir_44d926a17fc606d3c25449ba60427c63/dir_048f823fee1bfb22502a8732b9a001aa/ui__priv_8cpp.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://sandbox-docs.verifone.com/s-adk-5.1-programmers-guide/readme/annotated/class_u_i_catalog.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.