ArborX

wdbmi

Longname: w indow d ialogue b ox m odeless i nterface   Open the Documentation Legend
Released: 7.61a 
Created: 7.61a 

Summary
 In order to allow modeless dialogues and advanced dialogue scripting methods to interact flexibly with the 3B2 system, the "wdbmi" macro has been implemented.
Example (n/a)
 No example is available for this feature.

Syntax (7.61a)
wdbmi option:s  <dialogue info>
where
<dialogue info> ::= (  x:n  y:n?  ) | (  class:t  ) | (  x:n  property:t+  )
option:s
f  Switches input focus to dialogue ID x (x being the ID previously assigned to a dialogue). Will not switch focus to a disabled dialogue (if disabled using wdbmi "d").
fd  Switches input focus to current document. Will not switch focus if the current document is disabled (if disabled using wdbmi "dd").
u  Forces update commands for dialogue ID x to run.
ul  Same as "u" above, but forces all dialogue lists to rebuild also.
c  Closes dialogue ID x, emulating an exit/apply code of y.
h  Hides dialogue ID x.
s  Shows dialogue ID x, which was previously hidden.
d  Disables dialogue ID x, dialogue is still visible but greyed out and inactive.
e  Enables dialogue ID x, which was previously disabled.
dd  Disables main Arbortext APP window.
ed  Enables main Arbortext APP window.
g  Returns property y of dialogue ID x. Return value is stored in user-space variable wdbmi
flush 
Version specific information7.71  Flushes (removes) stored dialogue positions and sizes from the Windows registry. If a class name is specified, then only the specified dialogue class is flushed.
getparms 
Version specific information7.71  Gets the specified parameter of the dialogue with ID x. Return value is stored in user-space variable wdbmi. For more information on parameters, refer to Technote 0070; Resizable Dialogues; 7.71a.
setparms 
Version specific information7.71  Sets the value of the specified parameter of the dialogue with ID x. Note that the parameter "instances" is meaningless in this context. For more information on parameters, refer to Technote 0070; Resizable Dialogues; 7.71a. (added v7.71a).
class:t

Class of dialogue, used with 'flush'.
params:
class  "string"; Sets the dialogue’s class to the specified string. Class names are used to uniquely identify the type of dialogue.
pos  expr,expr "string"; Sets the dialogue’s position to the specified offset (x,y), relative to the upper left corner of the main window frame. If a string value is specified, then a combination of the following characters can be used: "t" top, "b" bottom, "l" left, "r" right.
abpos  expr,expr; Sets the dialogue’s position to the specified offset (x,y), relative to the upper left corner of the screen.
size  expr,expr; Resizes the dialogue to the specifiedwidth and height. Only applicable to resizable dialogues.
resize  expr; Flags the dialogue as resizable.
store  expr; Flags whether the dialogue’s size and position should be stored in theWindows registry. This setting will override any user preference.
bgcol  expr; Sets the background colour for the dialogue box to the specified colour value. Uses the same colour values as dialogue groups.
parentwh  expr; Allows only the specified number of instances of this dialogue class to be created. The current dialogue will not open if it would exceed this limit. Avalue of -1 indicates unlimited, any other positive 32-bit signed integer value is valid.
maxsize  expr, expr; Sets the maximum dimensions (width, height) of the dialogue. Avalue of -1 indicates infinite size, a value of 0 indicates the minimum size for that axis of growth (eg. no growth along that axis), any other value is interpreted literally as a number of pixels. Only applicable to resizable dialogues.
controls  expr; Sets which dialogue controls are available. All dialogues now contain the "close" control button, you may specify 3 to this parameter, whichwill give you an additional "rollup" control button. The "rollup" button will shrink the dialogue to just the title bar height when clicked. It may then be rolled down again. The controls are rendered in system colours 202 and 203.
shrunk  read only; This parameter can only be read using awdbmi "getparms" macro call. Returns 1 if the dialogue is shrunken and embedded in a toolbar, 0 otherwise.
title  "string"; This parameter can be used to set or read the title of the given dialogue. The title that is returned is the currently displayed title (if the title was too long and letters have been truncated, then that is what is returned). When setting the title, note that alignment characters (|,||) are not available and the current alignment is kept from the originally specified title. Added v7.82a.
x:n dialogue id
y:n return value of the option specified.
0  return current active dialogue ID (x is ignored). Return value of 0 indicates the document window is active.
1  return total number of dialogues (including those which are invisible or disabled; x is ignored). Return value of 0 indicates no dialogues.
2  return title of dialogue ID x (if x=0, then current active dialogue). Return value is blank if specified dialogue does not exist, or has no title.
3  get next dialogue ID. If x=0, the topmost (in terms of z-order) dialogue ID is returned. For each subsequent call where x<>0 the next dialogue ID is returned, until the bottom (ID 0) is reached. When another call is made past ID 0, the dialogue pointer resets to the topmost dialogue. This is a good way to process every dialogue in the system.
Below are some important points to note about dialogue parameters:

— The string "_dbt_" as the first five characters of a class name is reserved.

— Class names are case sensitive.

Document created on 03-Mar-2004, last reviewed on 01-Nov-2004 (revision 1)