OpenSCADAWiki: Home Page En/Doc/API/part8 ...

8. Subsystem "User interfaces" (TUIS)

The subsystem "User Interfaces" is presented by the TUIS object, which contains modular objects of the TUI user interfaces' on the subsystem's level.

8.1. The object of the "User interfaces" subsystem (TUIS)

Data:
Requests parameters (enum — GetOpts):

• GetPathURL (1) — Path get.
• GetContent (2) — Open document command get.

Public methods:

• int subVer( ); — Subsystem's version.
• void subStart( ); — Start of the subsystem.
• void subStop( ); — Stop of the subsystem.
• AutoHD<TUI> at( const string &name ) const; — Connecting to the user's interface module.
• static string icoGet( const string &inm, string *tp = NULL, bool retPath = false ); — Download image of the icon inm from standard directories or return path, on retPath, to allowed icon. Detecting icons for file extensions "png", "gif", "jpg", "jpeg", which return into tp.
• static string docGet( const string &inm, string *tp = NULL, unsigned opt = 0 ); — Download document inm from standard directories or return path, on retPath, to allowed document. Detecting documents for file extensions "pdf", "html", "odt", which return into tp.
• static string mimeGet( const string &inm, const string &fDt, const string &orig = "" ); — Get file's mime type in view {group}/{type} for the file name inm, its content fDt and the original hint orig.

8.2. The modular object of the user interface (TUI)

Protected attributes:

• bool run_st; — The sign "Running".