Programmer Guide/Shell Items/Dialog/DIALOG Item Attributes: Difference between revisions

From STX Wiki
Jump to navigationJump to search
(initial import)
 
No edit summary
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:{{SUBPAGENAME}}}}
{{DISPLAYTITLE:{{SUBPAGENAME}}}}
==DIALOG Item Attributes==
{{Dialog Item}}
The [[Programmer_Guide/Shell_Items/Dialog|dialog item]] (also know for historical reasons as ''menu item'') has the following attributes, which can be accessed using the following syntax:


The dialog item (also know for historical reasons as 'menu item') has the following attributes, which can be accessed using the following syntax:
#result := $#dialog[!ATTRIBUTE]
 
<code>$#dialog[!ATTRIBUTE]</code>


e.g. if you want to assign the number of controls to a local variable, do the following:
e.g. if you want to assign the number of controls to a local variable, do the following:


<code>#nControls := $#dialog[!CONTROLS]</code>
#nControls := $#dialog[!CONTROLS]
 
;<var>!BACKGROUNDCOLOR</var>
 
:This is not implemented; the value is always set to *
 
;<var>!CONTROLS</var>
 
:The index of first free dialog control, can be used to construct sub-dialogs (pseudo property sheets) (i.e. the number of controls).
 
;<var>!DIALOGMODE</var>
 
:The mode of dialog window (NOWINDOW = not created). One of the following values:
 
:<code>NOWINDOW</code>
 
:<code>HIDDEN</code>
 
:<code>VISIBLE</code>
 
:<code>ENABLED</code>
 
;<var>!DIALOGONLY</var>
 
:Returns <code>1</code> if the display only contains a dialog (i.e. no graphs), otherwise it returns <code>0</code>.
 
;<var>!DISPLAY</var>
 
:The name of the display object which owns the dialog.
 
;<var>!EDITING</var>
 
:<code>#beingEdited := $#dialog[!EDITING,$#controlId]</code>
 
:The <code>!EDITING</code> attribute returns <code>1</code> if the control with the id <code>$#controlId</code> is a listview and is currently being edited.
 
:The attribute returns <code>0</code> if the control with the id <code>$#controlId</code> is a listview and is *not* being edited.
 
:The attribute returns an asterisk (<code>*</code>) if the control <code>$#controlId</code> does not exist, or exists, but is not a listview control.
 
;<var>!FOCUS</var>
 
:Returns the index of the control which has currently the focus in the following format:
 
:<code>index_of_focus_control</code>
 
;<var>!FOREGROUND</var>
 
:The dialog item attribute <code>!FOREGROUND</code> returns <code>1</code> if the dialog window is in the foreground, <code>0</code> if it is not and <code>-1</code> if the command fails in some way.
 
;<var>!MODE</var>
 
:This attribute is read from the display item containing the dialog and not from the dialog item itself. See section "display item attributes" for details.
 
;<var>!NFREE</var>
 
:Returns the number of controls which can be added to the dialog in the following format:
 
:<code>number_of_free:_controls</code>
 
;<var>!PARENT</var>
 
:Not implemented; the value is always set to *
 
;<var>!STYLE</var>


:This attribute is read from the display item containing the dialog and not from the dialog item itself. See section "display item attributes" for details.
{| class="einrahmen"
! attribute
! description
|-
| <var>!BACKGROUNDCOLOR</var>
| This is not implemented; the value is always set to <code>*</code>
|-
| <var>!CONTROLS</var>
| The index of first free dialog control, can be used to construct sub-dialogs (pseudo property sheets) (i.e. the number of controls).
|-
| <var>!DIALOGMODE</var>
| The mode of dialog window (<code>NOWINDOW</code> &hellip; not created). One of the following values: <code>NOWINDOW</code>, <code>HIDDEN</code>, <code>VISIBLE</code> and <code>ENABLED</code>
|-
| <var>!DIALOGONLY</var>
| Returns <code>1</code> if the display only contains a dialog (i.e. no graphs), otherwise it returns <code>0</code>.
|-
| <var>!DISPLAY</var>
| The name of the display object which owns the dialog.
|-
| <var>!EDITING</var>
|
#beingEdited := $#dialog[!EDITING,$#controlId]


;<var>!TITLE</var>
The <code>!EDITING</code> attribute returns <code>1</code> if the control with the id <code>$#controlId</code> is a listview and is currently being edited.


:This attribute is read from the display item containing the dialog and not from the dialog item itself. See section "display item attributes" for details.
The attribute returns <code>0</code> if the control with the id <code>$#controlId</code> is a listview and is *not* being edited.


;<var>!WINDOW</var>
The attribute returns an asterisk (<code>*</code>) if the control <code>$#controlId</code> does not exist, or exists, but is not a listview control.
|-
| <var>!FOCUS</var>
| Returns the index of the control which has currently the focus.
|-
| <var>!FOREGROUND</var>
| The dialog item attribute <code>!FOREGROUND</code> returns <code>1</code> if the dialog window is in the foreground, <code>0</code> if it is not and <code>-1</code> if the command fails in some way.
|-
| <var>!MODE</var>
| This attribute is read from the display item containing the dialog and not from the dialog item itself. See section [[Programmer_Guide/Shell_Items/Display/DISPLAY_Item_Attributes|display item attributes]] for details.
|-
| <var>!NFREE</var>
| Returns the number of controls which can be added to the dialog in the following format:


:This attribute is read from the display item containing the dialog and not from the dialog item itself. See section "display item attributes" for details.
<code>number_of_free:_controls</code>
|-
| <var>!PARENT</var>
| Not implemented; the value is always set to *
|-
| <var>!STYLE</var>
| This attribute is read from the display item containing the dialog and not from the dialog item itself. See section [[Programmer_Guide/Shell_Items/Display/DISPLAY_Item_Attributes|display item attributes]] for details.
|-
| <var>!TITLE</var>
| This attribute is read from the display item containing the dialog and not from the dialog item itself. See section [[Programmer_Guide/Shell_Items/Display/DISPLAY_Item_Attributes|display item attributes]] for details.
|-
| <var>!WINDOW</var>
| This attribute is read from the display item containing the dialog and not from the dialog item itself. See section [[Programmer_Guide/Shell_Items/Display/DISPLAY_Item_Attributes|display item attributes]] for details.
|}

Latest revision as of 07:58, 22 April 2015

Dialog Item
NEW SET CONTROLS ATTRIBUTES MESSAGES EXAMPLES

The dialog item (also know for historical reasons as menu item) has the following attributes, which can be accessed using the following syntax: 

#result := $#dialog[!ATTRIBUTE]

e.g. if you want to assign the number of controls to a local variable, do the following: 

#nControls := $#dialog[!CONTROLS]
attribute description
!BACKGROUNDCOLOR This is not implemented; the value is always set to *
!CONTROLS The index of first free dialog control, can be used to construct sub-dialogs (pseudo property sheets) (i.e. the number of controls).
!DIALOGMODE The mode of dialog window (NOWINDOW … not created). One of the following values: NOWINDOW, HIDDEN, VISIBLE and ENABLED
!DIALOGONLY Returns 1 if the display only contains a dialog (i.e. no graphs), otherwise it returns 0.
!DISPLAY The name of the display object which owns the dialog.
!EDITING 
#beingEdited := $#dialog[!EDITING,$#controlId]

The !EDITING attribute returns 1 if the control with the id $#controlId is a listview and is currently being edited.

The attribute returns 0 if the control with the id $#controlId is a listview and is *not* being edited.

The attribute returns an asterisk (*) if the control $#controlId does not exist, or exists, but is not a listview control.

!FOCUS Returns the index of the control which has currently the focus.
!FOREGROUND The dialog item attribute !FOREGROUND returns 1 if the dialog window is in the foreground, 0 if it is not and -1 if the command fails in some way.
!MODE This attribute is read from the display item containing the dialog and not from the dialog item itself. See section display item attributes for details.
!NFREE Returns the number of controls which can be added to the dialog in the following format: 
number_of_free:_controls
!PARENT Not implemented; the value is always set to *
!STYLE This attribute is read from the display item containing the dialog and not from the dialog item itself. See section display item attributes for details.
!TITLE This attribute is read from the display item containing the dialog and not from the dialog item itself. See section display item attributes for details.
!WINDOW This attribute is read from the display item containing the dialog and not from the dialog item itself. See section display item attributes for details.
Retrieved from "https://mediawiki.kfs.oeaw.ac.at/stx/docs/wiki/index.php?title=Programmer_Guide/Shell_Items/Dialog/DIALOG_Item_Attributes&oldid=7351"

Navigation menu

Personal tools