MSM-Workstation
Appendix A
Glossary

A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z

A

Action logic: the code that is executed when a certain event happens. In other words, the action that the software undertakes when a certain event happens.

B

%%Black: (See also Macro); Described in macro %%Black

%%Blue: (See also Macro); Described in macro %%Blue

Button: (See also Component); Described in chapter "Button"

C

%%Cancel: (See also Macro); Described in macro %%Cancel

change: (See also Event); Low Level Event, described in Chapter change

char: (See also Event); Low Level Event, described in Chapter char

Check: (See also Event); High Level Event, described in Chapter Check

Check Box: (See also Component); Described in Chapter Check Box

Choose: (See also Event); High Level Event, described in Chapter Choose

click: (See also Event); Low Level Event, described in Chapter click

close: (See also Event); Low Level Event, described in Chapter close

Close Button: See Window Buttons

%%CloseWin: (See also Macro); Described in macro %%CloseWin

Combo Box: (See also Component); Described in Chapter Combo Box

CommonCode: Code that can be shared by the action logic for the various events in a window and its gadgets.
Described in Chapter CommonCode

Component: an entity that is used to build a window.

In some contexts, "components" are also called "gadgets" or "controls". The general object is typically called a "component", a specific instance is called a "control". The MWAPI document uses the term "gadget" throughout.

Control: an entity that is used to build a window.

In some contexts, "controls" are also called "gadgets" or "components". The general object is typically called a "component", a specific instance is called a "control". The MWAPI document uses the term "gadget" throughout.

Create: (See also Event); High Level Event, described in Chapter Create

%%CurrCtl: (See also Macro); Described in macro %%CurrCtl

%%CurrWin: (See also Macro); Described in macro %%CurrWin

%%Cyan: (See also Macro); Described in macro %%Cyan

D

%%DarkGray: (See also Macro); Described in macro %%DarkGray

Database: A collection of information, usually structured in a specific format, and described by a data dictionary.

Date: (See also Component); Described in Chapter Date

dblClick: (See also Event); Low Level Event, described in Chapter dblClick

deselect: (See also Event); Low Level Event, described in Chapter deselect

Destroy: (See also Event); High Level Event, described in Chapter Destroy

%%Disable: (See also Macro); Described in macro %%Disable

%%DisplayBackColor: (See also Macro); Described in macro %%DisplayBackColor

%%Do: (See also Macro); Described in macro %%Do

Document: (See also Component); Described in Chapter Document

%%DoWin: (See also Macro); Described in macro %%DoWin

Drag: the action of moving an object to a different location.
A dragging action is performed by:

drop: (See also Event); Low Level Event, described in Chapter drop

Drop Combo Box: (See also Component); Described in Chapter Drop Combo Box

Drop Down List: (See also Component); Described in Chapter Drop Down List

E

%%Enable: (See also Macro); Described in macro %%Enable

%%EnableMenu: (See also Macro); Described in macro %%EnableMenu

Enter: (See also Event); High Level Event, described in Chapter Enter

Error: (See also Event); High Level Event, described in Chapter Error

%%EvChoice: (See also Macro); Described in macro %%EvChoice

%%EvControl: (See also Macro); Described in macro %%EvControl

%%EvElement: (See also Macro); Described in macro %%EvElement

Event: Any instance of an occurrence of a specific activity that warrants a response from software.

%%EvKey: (See also Macro); Described in macro %%EvKey

%%EvNext: (See also Macro); Described in macro %%EvNext

%%EvPrior: (See also Macro); Described in macro %%EvPrior

%%EvPtrButton: (See also Macro); Described in macro %%EvPtrButton

%%EvPtrPos: (See also Macro); Described in macro %%EvPtrPos

%%EvPtrState: (See also Macro); Described in macro %%EvPtrState

%%EvSequence: (See also Macro); Described in macro %%EvSequence

%%EvType: (See also Macro); Described in macro %%EvType

%%EvWindow: (See also Macro); Described in macro %%EvWindow

Exit: (See also Event); High Level Event, described in Chapter Exit

F

File Menu: One of the menu options in most windows.
Typically, this option is the left-most option on a menu bar, and it usually contains sub-options that allow for file selection and creation, printing, and it usually contains the sub-option to exit from the current window and program.

fKeyDown: (See also Event); Low Level Event, described in Chapter fKeyDown

fKeyUp: (See also Event); Low Level Event, described in Chapter fKeyUp

%%Focus: (See also Macro); Described in macro %%Focus

%%FocusCtl: (See also Macro); Described in macro %%FocusCtl

%%FocusWin: (See also Macro); Described in macro %%FocusWin

G

Gadget: (See also Component)

Generic Box: (See also Component); Described in Chapter Generic Box

%%Get: (See also Macro); Described in macro %%Get

%%GetChoice: (See also Macro); Described in macro %%GetChoice

%%GetSel: (See also Macro); Described in macro %%GetSel

%%GetVar: (See also Macro); Described in macro %%GetVar

Go Away Button: See Window Buttons

goBottom: (See also Event); Low Level Event, described in Chapter goBottom

goDown: (See also Event); Low Level Event, described in Chapter goDown

goDownBig: (See also Event); Low Level Event, described in Chapter goDownBig

gotFocus: (See also Event); Low Level Event, described in Chapter gotFocus

goTop: (See also Event); Low Level Event, described in Chapter goTop

goUp: (See also Event); Low Level Event, described in Chapter goUp

goUpBig: (See also Event); Low Level Event, described in Chapter goUpBig

%%Gray: (See also Macro); Described in macro %%Gray

%%Green: (See also Macro); Described in macro %%Green

Gray(ed) Out: Windows may contain many components such as buttons, text fields, check boxes and menus. Some of these components are available for use and some may not be accessible until certain information has been made available through any of the other components. A typical convention is to display such inaccessible components in a somewhat "faded" color. Such "faded" components are called "grayed out".

Group Box: (See also Component); Described in Chapter Group Box

H

help: (See also Event); Low Level Event, described in Chapter help

%%Hide: (See also Macro); Described in macro %%Hide

I

%%IOVar: (See also Macro); Described in macro %%IOVar

%%IsOK: (See also Macro); Described in macro %%IsOK

J

K

keyDown: (See also Event); Low Level Event, described in Chapter keyDown

%%KeyLab: (See also Macro); Described in macro %%KeyLab

keyUp: (See also Event); Low Level Event, described in Chapter keyUp

%%KillCtl: (See also Macro); Described in macro %%KillCtl

%%KillWin: (See also Macro); Described in macro %%KillWin

L

Label: (See also Component); Described in Chapter Label

Left Button: mouse devices for computers exist in many renditions. The traditional "mice" have only one button, current-day "mice" may have any number of buttons. In the context of MSM-Workstation, it is expected that the end-user is working with a mouse with at least two buttons; one of the buttons will be referenced in this documentation as the "left-hand button", the other will be referenced as the "right-hand button". The usage in this documentation will correspond to the default situation for most "mice". Since the actual meaning of the mouse buttons is configurable, it is unpredictable what the actual correspondence is between button position and meaning.

List Box: (See also Component); Described in Chapter List Box

Locally Mounted Database: MSM has two options for mounting databases. A locally mounted database must reside on a file system that is directly accessible from the CPU on which MSM is running, and will only be accessible to the copy of MSM that has it mounted.

A remotely mounted database may reside anywhere in a network and may be accessible to multiple instances of MSM.

Lock: Described in Chapter Lock Long List: (See also Component); Described in Chapter Long List

lostFocus: (See also Event); Low Level Event, described in Chapter lostFocus

M

Macro: A macro is one of the many tools that are used in software development. Basically, a macro is an instruction to a text-pre-processor to replace some text in source code by other text. The definition of a macro is the algorithm that describes how text is intended to be replaced. The parameters, if any, of that macro are the details to be filled in into the "blanks" that are left open in the definition of the macro.

Macros are processed in one of the first stages of a compilation. Compilers typically do not "see" the original source code, but a modified version in which all text-replacement instructions from macros have been applied.

Although, in colloquial language, it is often said that a macro "does something", in fact, a macro never "does anything". It merely causes code to be generated that performs the action in question.

The purpose of macros is in some cases to use a simple abbreviation for a piece of code that is repeated often. In other cases, macros are used to offer a consistent interface to entities that may have to be referenced in different fashions on different platforms.

In the context of MSM-Workstation, the macros all have names that start with two percent-signs.

%%Magenta: (See also Macro); Described in macro %%Magenta

%%MarkMenu: (See also Macro); Described in macro %%MarkMenu

maximize: (See also Event); Low Level Event, described in Chapter maximize

Maximize Button: See Window Buttons

%%MergeCtl: (See also Macro); Described in macro %%MergeCtl

%%MergeWin: (See also Macro); Described in macro %%MergeWin

minimize: (See also Event); Low Level Event, described in Chapter minimize

Minimize Button: See Window Buttons

Modified: (See also Event); High Level Event, described in Chapter Modified

Moniker: a nick-name. In the context of MSM-Workstations, nick-names may be given to databases and to UCIs.

Mount (a database): MSM has two options for mounting databases. A locally mounted database must reside on a file system that is directly accessible from the CPU on which MSM is running, and will only be accessible to the copy of MSM that has it mounted.

A remotely mounted database may reside anywhere in a network and may be accessible to multiple instances of MSM.

move: (See also Event); Low Level Event, described in Chapter move

MoveFirst: (See also Event); High Level Event, described in Chapter MoveFirst

MoveLast: (See also Event); High Level Event, described in Chapter MoveLast

MoveNext: (See also Event); High Level Event, described in Chapter MoveNext

MovePrevious: (See also Event); High Level Event, described in Chapter MovePrevious

MWAPI: M[UMPS] Windowing Application Pprogrammer's Interface. An ANSI standard (ANSI/MDC X11.6-1995) for using window-based technology from the M[UMPS] programming language.

N

New Option (in File Menu): In applications that allow for the creation of new instances of the various objects on which they operate, the sub-option "New" on the "File" menu is usually the option that allows for the creation of such new instances.

%%NotOK: (See also Macro); Described in macro %%NotOK

O

%%OK: (See also Macro); Described in macro %%OK

%%OpenWin: (See also Macro); Described in macro %%OpenWin

P

%%Perform: (See also Macro); Described in macro %%Perform

Picture: (See also Component); Described in Chapter Picture

%%PopMenu: (See also Macro); Described in macro %%PopMenu

%%Prop: (See also Macro); Described in macro %%Prop

ptrDown: (See also Event); Low Level Event, described in Chapter ptrDown

ptrDrag: (See also Event); Low Level Event, described in Chapter ptrDrag

ptrMove: (See also Event); Low Level Event, described in Chapter ptrMove

ptrUp: (See also Event); Low Level Event, described in Chapter ptrUp

Push: (See also Event); High Level Event, described in Chapter Push

Q

R

Radio Button: (See also Component); Described in Chapter Radio Button

Read-Only: A type of access that prohibits any (over)writing activity.

Read/Write: A type of access that allows both read and (over)write activity.

%%Red: (See also Macro); Described in macro %%Red

%%Refresh: (See also Macro); Described in macro %%Refresh

Registry: The operating systems Microsoft Windows '95 and Microsoft Windows NT contain a special file that is intended to contains all settings that are used by all programs. This file is called "the Registry".

Remotely Mounted Database: MSM has two options for mounting databases. A locally mounted database must reside on a file system that is directly accessible from the CPU on which MSM is running, and will only be accessible to the copy of MSM that has it mounted.

A remotely mounted database may reside anywhere in a network and may be accessible to multiple instances of MSM.

%%RemoveVars: (See also Macro); Described in macro %%RemoveVars

%%Reset: (See also Macro); Described in macro %%Reset

%%ResetChoice: (See also Macro); Described in macro %%ResetChoice

%%ResetSel: (See also Macro); Described in macro %%ResetSel

%%ResetVar: (See also Macro); Described in macro %%ResetVar

resize: (See also Event); Low Level Event, described in Chapter resize

restore: (See also Event); Low Level Event, described in Chapter restore

Restore Button: See Window Buttons

%%RetCancel: (See also Macro); Described in macro %%RetCancel

%%RetCode: (See also Macro); Described in macro %%RetCode

%%RetNormal: (See also Macro); Described in macro %%RetNormal

%%Return: (See also Macro); Described in macro %%Return

Right Button: mouse devices for computers exist in many renditions. The traditional "mice" have only one button, current-day "mice" may have any number of buttons. In the context of MSM-Workstation, it is expected that the end-user is working with a mouse with at least two buttons; one of the buttons will be referenced in this documentation as the "left-hand button", the other will be referenced as the "right-hand button". The usage in this documentation will correspond to the default situation for most "mice". Since the actual meaning of the mouse buttons is configurable, it is unpredictable what the actual correspondence is between button position and meaning.

S

%%SaveVars: (See also Macro); Described in macro %%SaveVars

%%Scram: (See also Macro); Described in macro %%Scram

Scroll: (See also Event); High Level Event, described in Chapter Scroll

Scroll Bar: (See also Component); Described in Chapter Scroll Bar

select: (See also Event); Low Level Event, described in Chapter select

%%Set: (See also Macro); Described in macro %%Set

%%SetChoice: (See also Macro); Described in macro %%SetChoice

%%SetFocus: (See also Macro); Described in macro %%SetFocus

%%SetSel: (See also Macro); Described in macro %%SetSel

%%Settings: (See also Macro); Described in macro %%Settings

%%SetVar: (See also Macro); Described in macro %%SetVar

%%Show: (See also Macro); Described in macro %%Show

Spin Button: (See also Component); Described in Chapter Spin Button

SQL: Described in Chapter SQL

T

Tabbed Group: (See also Component); Described in Chapter Tabbed Group

Text Box: (See also Component); Described in Chapter Text Box

timer: (See also Event); Low Level Event, described in Chapter timer

Timer: (See also Component); Described in Chapter Timer

%%Trigger: (See also Macro); Described in macro %%Trigger

U

UpdateControls: (See also Event); High Level Event, described in Chapter UpdateControls

UpdateRecord: (See also Event); High Level Event, described in Chapter UpdateRecord

V

W

%%White: (See also Macro); Described in macro %%White

Window: A unit on a display that contains a number of components, all shown within the confines of the (usually rectangular) border of that unit.
On the top of a window, optionally a bar appears that contains the title of the window, and a button that may be used to "close" the window (i.e. make the window disappear).

Window Buttons: In the right upper corner of all windows, a number of buttons will appear. Depending on the features that are enabled for the window, one or more of these buttons may be present. Most typically, however, the following three buttons are shown:
The functions of these buttons are
: Minimize
: Maximize
: Close or ("go-away")
If the window is maximized, the "maximize" button will be replaced by its counterpart (: restore to previous size)

Writable: A type of access that allows (over)write activity.

X

Y

%%Yellow: (See also Macro); Described in macro %%Yellow

Z