From OpenSCADAWiki
Jump to: navigation, search
(Importing a new version from external source)
(Importing a new version from external source)
 
Line 13: Line 13:
 
|-
 
|-
 
| perm || Permission || - ||
 
| perm || Permission || - ||
Permission to the widget in the view "'''{user}{group}{other}'''" plus the inheritance flag, enables the inheritance for owner and its permissions from the upper widget.<br/>
+
Permission to the widget in the view "'''{user}{group}{other}'''" of octal number like to "0664-RWRWR_", plus the inheritance flag enables the inheritance for owner and its permissions from the upper widget.<br/>
 
Where "'''user'''", "'''group'''" and "'''other'''" is:
 
Where "'''user'''", "'''group'''" and "'''other'''" is:
* "__" — no access;
+
* "__" (0) — no access;
* "R_" — read-only;
+
* "R_" (4) — read-only;
* "RW" — read and write.<br/>
+
* "RW" (6) — read and write.<br/>
By default the 01000 — inheritance.
+
By default that is in 01000 — inheritance.
 
|-
 
|-
 
| root || Root || 1 || Identifier of the widget-primitive (basic element) which underlies the widget visualization shape.
 
| root || Root || 1 || Identifier of the widget-primitive (basic element) which underlies the widget visualization shape.

Latest revision as of 20:34, 4 May 2025

Information about message (contribute)
This message has no documentation. If you know where or how this message is used, you can help other translators by adding documentation to this message.
Message definition (Sub-projects/VCA)
'''Table.''' The common set of properties/attributes in the widget
{| class="wikitable"
|-
! Identifier !! Name !! Number !! Value
|-
| id || Identifier || - || Identifier of the element. The attribute is read-only, designed to provide information on the ID of the element.
|-
| path || Path || - || Path to the widget. The attribute is read-only and designed to provide full information about the element location.
|-
| parent || Parent || - || Path to the parent widget. The attribute is read-only and designed to provide information about the ancestor location which the widget is inherited from.
|-
| owner || Owner || - || The widget owner and group in the view "'''{owner}:{group[,group1,groupN]}'''", by default the "root:UI". 
|-
| perm || Permission || - ||
Permission to the widget in the view "'''{user}{group}{other}'''" of octal number like to "0664-RWRWR_", plus the inheritance flag enables the inheritance for owner and its permissions from the upper widget.<br/>
Where "'''user'''", "'''group'''" and "'''other'''" is:
* "__" (0) — no access;
* "R_" (4) — read-only;
* "RW" (6) — read and write.<br/>
By default that is in 01000 — inheritance.
|-
| root || Root || 1 || Identifier of the widget-primitive (basic element) which underlies the widget visualization shape.
|-
| name || Name || - || Name of the element. Accessible to modification the element name. 
|-
| dscr || Description || - || Description of the element. Text field of the brief description. 
|-
| en || Enabled || 5 || The state "Enabled" of the element. Disabled element is not shown in the execution mode. 
|-
| active || Active || 6 || The state "Active" of the element. Active element may receive focus in the execution mode, and thus receive keyboard and other events with their subsequent processing.
|-
| geomX || Geometry: x || 7 || Geometry, coordinate 'x' of the element position.
|-
| geomY || Geometry: y || 8 || Geometry, coordinate 'y' of the element position.
|-
| geomW || Geometry: width || 9 || Geometry, the width of the element.
|-
| geomH || Geometry: height || 10 || Geometry, the height of the element.
|-
| geomXsc || Geometry: x scale || 13 || Horizontally scale of the element. 
|-
| geomYsc || Geometry: y scale || 14 || Vertical scale of the element. 
|-
| geomZ || Geometry: z || 11 || Geometry, coordinate 'z' (level) of the element on the frame. Defines also the order to transfer the focus through active elements.
|-
| geomMargin || Geometry: margin || 12 || Geometry, the margins of the element. 
|-
| tipTool || Tip: tool || 15 || Text of a brief help or tip on this element. Realized usually as a tool tip, while keeping your mouse cursor over the element.
|-
| tipStatus || Tip: status || 16 ||
Text information on the status of the element or the guide to action over the element. Implemented usually in the form of a message in the status bar while keeping your mouse cursor over the element.
: * Modification the attribute from session of the root page will record the message in the status bar of the visualization window of the session. 
|-
| contextMenu || Context menu || 17 ||
Context menu in the strings list view: "'''{ItName}:{Signal}'''".<br/>
Where:
* "ItName" — name of the item;
* "Signal" — name of the signal, which forming at the selecting: "'''usr_{Signal}'''". 
|-
| evProc || Events processing || - ||
Attribute for storing of the script of the events processing for direct control of the user interface. Script is a list of commands to the visualization interface, generated at the event receipt (attribute '''event'''). Direct events processing to manage pages, in the view: "'''{event}:{evSrc}:{com}:{prm}'''". Where:
* "event" — waiting event;
* "evSrc" — event source;
* "com" — command of the session: open, next, prev;
* "prm" — command parameter, where used:
** ''pg_so'' — direct name of the desired page, with the prefix;
** ''1'' — name of the new page in a general way, without a prefix;
** ''*'' — the page is taken from the previous page name;
** ''$'' — indicates the place relative to which the page opens.<br/>
Examples:
* ws_BtPress:/prev:prev:/pg_so/*/*/$
* ws_BtPress:/next:next:/pg_so/*/*/$
* ws_BtPress:/go_mn:open:/pg_so/*/mn/*
* ws_BtPress:/go_graph:open:/pg_so/*/ggraph
|-
| colspan="4" | ''Additional attributes for items, placed into the project in the role of a page.'' 
|-
| pgOpen || Page: opened || - ||
Sign "The page is opened".
: * Modification from the session provides an immediate opening/closing the page, but for the pages type "Link" you must prefer of [[#UserAPI|the user API]] function uiCmd() using to the pages managing.
|-
| pgNoOpenProc || Page: process not opened || - || Sign "Execute the page, even if it is closed".
|-
| pgOpenSrc || Page: source of the opening || 3 ||
Full address of the page which has opened this one.
: * Writing/clearing the widget address, of the opening initiation, performs an immediate opening/closing the page. In the case of writing the address and on [[#DynLink|certain conditions]], the dynamic linking of the current widget to the initiator performs. But for the pages type "Link" you must prefer of [[#UserAPI|the user API]] function uiCmd() using to the pages managing.
|-
| pgGrp || Page: group || 4 || Group of the pages. EMPTY and the "main" group is meant of using this page as the Root-main page, so such ones will replace other Root-main pages; the "fl" group is meant of using in the "fly" windows which are suitable for multiple open and must not be traced for doubles; all other are meant for including to the containers-boxes or single opening, so they forced in checking for doubles when the last one will be opened and the previous ones be closed.
|-
| colspan="4" | ''Additional attributes of the execution mode — by the session.''<br/>(Virtual attributes are not available in the widget procedure)
|-
| event || Events || - || Special attribute of the collection of events of the widget in the list, which is divided by the new line. Access to the attribute is protected by a critical section in order to avoid loss of the events. The attribute is always available in the widget procedure.
|-
| load || Load || -1 || Virtual command of the group data download. 
|-
| focus || Focus || -2 || Special attribute of the indicating the fact of receiving the focus by an active widget. Attribute of the widget and of the included widgets is available in the widgets procedures.
|-
| perm || Permission || -3 || Virtual attribute of the rights of the active user to view and control the widget.
|}
Translation'''Table.''' The common set of properties/attributes in the widget
{| class="wikitable"
|-
! Identifier !! Name !! Number !! Value
|-
| id || Identifier || - || Identifier of the element. The attribute is read-only, designed to provide information on the ID of the element.
|-
| path || Path || - || Path to the widget. The attribute is read-only and designed to provide full information about the element location.
|-
| parent || Parent || - || Path to the parent widget. The attribute is read-only and designed to provide information about the ancestor location which the widget is inherited from.
|-
| owner || Owner || - || The widget owner and group in the view "'''{owner}:{group[,group1,groupN]}'''", by default the "root:UI". 
|-
| perm || Permission || - ||
Permission to the widget in the view "'''{user}{group}{other}'''" of octal number like to "0664-RWRWR_", plus the inheritance flag enables the inheritance for owner and its permissions from the upper widget.<br/>
Where "'''user'''", "'''group'''" and "'''other'''" is:
* "__" (0) — no access;
* "R_" (4) — read-only;
* "RW" (6) — read and write.<br/>
By default that is in 01000 — inheritance.
|-
| root || Root || 1 || Identifier of the widget-primitive (basic element) which underlies the widget visualization shape.
|-
| name || Name || - || Name of the element. Accessible to modification the element name. 
|-
| dscr || Description || - || Description of the element. Text field of the brief description. 
|-
| en || Enabled || 5 || The state "Enabled" of the element. Disabled element is not shown in the execution mode. 
|-
| active || Active || 6 || The state "Active" of the element. Active element may receive focus in the execution mode, and thus receive keyboard and other events with their subsequent processing.
|-
| geomX || Geometry: x || 7 || Geometry, coordinate 'x' of the element position.
|-
| geomY || Geometry: y || 8 || Geometry, coordinate 'y' of the element position.
|-
| geomW || Geometry: width || 9 || Geometry, the width of the element.
|-
| geomH || Geometry: height || 10 || Geometry, the height of the element.
|-
| geomXsc || Geometry: x scale || 13 || Horizontally scale of the element. 
|-
| geomYsc || Geometry: y scale || 14 || Vertical scale of the element. 
|-
| geomZ || Geometry: z || 11 || Geometry, coordinate 'z' (level) of the element on the frame. Defines also the order to transfer the focus through active elements.
|-
| geomMargin || Geometry: margin || 12 || Geometry, the margins of the element. 
|-
| tipTool || Tip: tool || 15 || Text of a brief help or tip on this element. Realized usually as a tool tip, while keeping your mouse cursor over the element.
|-
| tipStatus || Tip: status || 16 ||
Text information on the status of the element or the guide to action over the element. Implemented usually in the form of a message in the status bar while keeping your mouse cursor over the element.
: * Modification the attribute from session of the root page will record the message in the status bar of the visualization window of the session. 
|-
| contextMenu || Context menu || 17 ||
Context menu in the strings list view: "'''{ItName}:{Signal}'''".<br/>
Where:
* "ItName" — name of the item;
* "Signal" — name of the signal, which forming at the selecting: "'''usr_{Signal}'''". 
|-
| evProc || Events processing || - ||
Attribute for storing of the script of the events processing for direct control of the user interface. Script is a list of commands to the visualization interface, generated at the event receipt (attribute '''event'''). Direct events processing to manage pages, in the view: "'''{event}:{evSrc}:{com}:{prm}'''". Where:
* "event" — waiting event;
* "evSrc" — event source;
* "com" — command of the session: open, next, prev;
* "prm" — command parameter, where used:
** ''pg_so'' — direct name of the desired page, with the prefix;
** ''1'' — name of the new page in a general way, without a prefix;
** ''*'' — the page is taken from the previous page name;
** ''$'' — indicates the place relative to which the page opens.<br/>
Examples:
* ws_BtPress:/prev:prev:/pg_so/*/*/$
* ws_BtPress:/next:next:/pg_so/*/*/$
* ws_BtPress:/go_mn:open:/pg_so/*/mn/*
* ws_BtPress:/go_graph:open:/pg_so/*/ggraph
|-
| colspan="4" | ''Additional attributes for items, placed into the project in the role of a page.'' 
|-
| pgOpen || Page: opened || - ||
Sign "The page is opened".
: * Modification from the session provides an immediate opening/closing the page, but for the pages type "Link" you must prefer of [[#UserAPI|the user API]] function uiCmd() using to the pages managing.
|-
| pgNoOpenProc || Page: process not opened || - || Sign "Execute the page, even if it is closed".
|-
| pgOpenSrc || Page: source of the opening || 3 ||
Full address of the page which has opened this one.
: * Writing/clearing the widget address, of the opening initiation, performs an immediate opening/closing the page. In the case of writing the address and on [[#DynLink|certain conditions]], the dynamic linking of the current widget to the initiator performs. But for the pages type "Link" you must prefer of [[#UserAPI|the user API]] function uiCmd() using to the pages managing.
|-
| pgGrp || Page: group || 4 || Group of the pages. EMPTY and the "main" group is meant of using this page as the Root-main page, so such ones will replace other Root-main pages; the "fl" group is meant of using in the "fly" windows which are suitable for multiple open and must not be traced for doubles; all other are meant for including to the containers-boxes or single opening, so they forced in checking for doubles when the last one will be opened and the previous ones be closed.
|-
| colspan="4" | ''Additional attributes of the execution mode — by the session.''<br/>(Virtual attributes are not available in the widget procedure)
|-
| event || Events || - || Special attribute of the collection of events of the widget in the list, which is divided by the new line. Access to the attribute is protected by a critical section in order to avoid loss of the events. The attribute is always available in the widget procedure.
|-
| load || Load || -1 || Virtual command of the group data download. 
|-
| focus || Focus || -2 || Special attribute of the indicating the fact of receiving the focus by an active widget. Attribute of the widget and of the included widgets is available in the widgets procedures.
|-
| perm || Permission || -3 || Virtual attribute of the rights of the active user to view and control the widget.
|}

Table. The common set of properties/attributes in the widget

Identifier Name Number Value
id Identifier - Identifier of the element. The attribute is read-only, designed to provide information on the ID of the element.
path Path - Path to the widget. The attribute is read-only and designed to provide full information about the element location.
parent Parent - Path to the parent widget. The attribute is read-only and designed to provide information about the ancestor location which the widget is inherited from.
owner Owner - The widget owner and group in the view "{owner}:{group[,group1,groupN]}", by default the "root:UI".
perm Permission -

Permission to the widget in the view "{user}{group}{other}" of octal number like to "0664-RWRWR_", plus the inheritance flag enables the inheritance for owner and its permissions from the upper widget.
Where "user", "group" and "other" is:

  • "__" (0) — no access;
  • "R_" (4) — read-only;
  • "RW" (6) — read and write.

By default that is in 01000 — inheritance.

root Root 1 Identifier of the widget-primitive (basic element) which underlies the widget visualization shape.
name Name - Name of the element. Accessible to modification the element name.
dscr Description - Description of the element. Text field of the brief description.
en Enabled 5 The state "Enabled" of the element. Disabled element is not shown in the execution mode.
active Active 6 The state "Active" of the element. Active element may receive focus in the execution mode, and thus receive keyboard and other events with their subsequent processing.
geomX Geometry: x 7 Geometry, coordinate 'x' of the element position.
geomY Geometry: y 8 Geometry, coordinate 'y' of the element position.
geomW Geometry: width 9 Geometry, the width of the element.
geomH Geometry: height 10 Geometry, the height of the element.
geomXsc Geometry: x scale 13 Horizontally scale of the element.
geomYsc Geometry: y scale 14 Vertical scale of the element.
geomZ Geometry: z 11 Geometry, coordinate 'z' (level) of the element on the frame. Defines also the order to transfer the focus through active elements.
geomMargin Geometry: margin 12 Geometry, the margins of the element.
tipTool Tip: tool 15 Text of a brief help or tip on this element. Realized usually as a tool tip, while keeping your mouse cursor over the element.
tipStatus Tip: status 16

Text information on the status of the element or the guide to action over the element. Implemented usually in the form of a message in the status bar while keeping your mouse cursor over the element.

* Modification the attribute from session of the root page will record the message in the status bar of the visualization window of the session.
contextMenu Context menu 17

Context menu in the strings list view: "{ItName}:{Signal}".
Where:

  • "ItName" — name of the item;
  • "Signal" — name of the signal, which forming at the selecting: "usr_{Signal}".
evProc Events processing -

Attribute for storing of the script of the events processing for direct control of the user interface. Script is a list of commands to the visualization interface, generated at the event receipt (attribute event). Direct events processing to manage pages, in the view: "{event}:{evSrc}:{com}:{prm}". Where:

  • "event" — waiting event;
  • "evSrc" — event source;
  • "com" — command of the session: open, next, prev;
  • "prm" — command parameter, where used:
    • pg_so — direct name of the desired page, with the prefix;
    • 1 — name of the new page in a general way, without a prefix;
    • * — the page is taken from the previous page name;
    • $ — indicates the place relative to which the page opens.

Examples:

  • ws_BtPress:/prev:prev:/pg_so/*/*/$
  • ws_BtPress:/next:next:/pg_so/*/*/$
  • ws_BtPress:/go_mn:open:/pg_so/*/mn/*
  • ws_BtPress:/go_graph:open:/pg_so/*/ggraph
Additional attributes for items, placed into the project in the role of a page.
pgOpen Page: opened -

Sign "The page is opened".

* Modification from the session provides an immediate opening/closing the page, but for the pages type "Link" you must prefer of the user API function uiCmd() using to the pages managing.
pgNoOpenProc Page: process not opened - Sign "Execute the page, even if it is closed".
pgOpenSrc Page: source of the opening 3

Full address of the page which has opened this one.

* Writing/clearing the widget address, of the opening initiation, performs an immediate opening/closing the page. In the case of writing the address and on certain conditions, the dynamic linking of the current widget to the initiator performs. But for the pages type "Link" you must prefer of the user API function uiCmd() using to the pages managing.
pgGrp Page: group 4 Group of the pages. EMPTY and the "main" group is meant of using this page as the Root-main page, so such ones will replace other Root-main pages; the "fl" group is meant of using in the "fly" windows which are suitable for multiple open and must not be traced for doubles; all other are meant for including to the containers-boxes or single opening, so they forced in checking for doubles when the last one will be opened and the previous ones be closed.
Additional attributes of the execution mode — by the session.
(Virtual attributes are not available in the widget procedure)
event Events - Special attribute of the collection of events of the widget in the list, which is divided by the new line. Access to the attribute is protected by a critical section in order to avoid loss of the events. The attribute is always available in the widget procedure.
load Load -1 Virtual command of the group data download.
focus Focus -2 Special attribute of the indicating the fact of receiving the focus by an active widget. Attribute of the widget and of the included widgets is available in the widgets procedures.
perm Permission -3 Virtual attribute of the rights of the active user to view and control the widget.