The PlainUserDialog class subclasses from PlainBaseDialog class and provides all the methods that normally are required to execute a dialog that is either created dynamically or loaded from a resource script (.RC). In other words it is a limited version of UserDialog Class. Use ::requires "OODPLAIN.CLS" in your script to get access to the PlainUserDialog class.
Note: If you use ::requires "OODWIN32.CLS" you do not need to specify the ::requires "OODIALOG.CLS" directive because OODIALOG.CLS is included from OODWIN32.CLS.
Note: If you use ::requires "OODIALOG.CLS" you do not need to specify the ::requires "OODPLAIN.CLS" directive because OODPLAIN.CLS is included from OODIALOG.CLS.
UserDialog includes all the methods PlainUserDialog does plus all the methods defined in the DialogExtensions class. These are more specific methods that cover asynchronous dialog execution, scroll bar support, resizing and repositioning, bitmaps, graphics (device context related methods), scrolling text, and menus (action bars).
The reason for splitting the functionality into two classes is to provide a smaller package which requires less system resources for ordinary user interfaces like the standard dialogs.
The following table lists all the methods that are provided by the PlainUserDialog class. The individual methods are documented in BaseDialog Class or UserDialog Class.
Instances of the PlainUserDialog class have the following attributes:
Automatic data field detection on (=1, default) or off (=0). For the UserDialog subclass the default is off and Connect... methods or a resource script are usually used.
A queue containing the methods that are started concurrently before the execution of the dialog
A directory string storing the numerical values assigned to symbolic IDs (#define-statements in the resource script)
Protected attribute to store connections between dialog items and the attributes of the dialog instance
A handle to the dialog
0 if dialog is executing, 1 if terminated with OK, and 2 if canceled
After the Init method has finished executing the value of the attribtute is 0 if no errors were detected during initialization, otherwise its value is non-zero. After instantiating a new dialog object, the InitCode attribute should be checked. If its value is not 0 then there was some problem initializing the object. The programmer should treat this as an error condition and not expect that the underlying Windows dialog can be created successfully.
After the dialog is finished, the attribute will be 1 if the user terminated the dialog with the Ok button. Its value will be 2 if the user canceled the dialog.
Protected attribute that is true (=1) if a stem variable was passed to init
Instances of the PlainUserDialog class implement the methods listed in PlainUserDialog and PlainBaseDialog Class Methods table.
Table 7-1. PlainUserDialog and PlainBaseDialog Class Methods
Method... | ...on page |
---|---|
AddAttribute | AddAttribute |
AddBitmapButton | AddBitmapButton |
AddBlackFrame | AddBlackFrame |
AddBlackRect | AddBlackRect |
AddButton | AddButton |
AddButtonGroup | AddButtonGroup |
AddCheckBox | AddCheckBox |
AddCheckBoxStem | AddCheckBoxStem |
AddCheckGroup | AddCheckGroup |
AddComboBox | AddComboBox |
AddComboEntry | AddComboEntry |
AddComboInput | AddComboInput |
AddEntryLine | AddEntryLine |
AddGrayFrame | AddGreyFrame |
AddGrayRect | AddGrayRect |
AddGroupBox | AddGroupBox |
AddIcon | AddIcon |
AddInput | AddInput |
AddInputGroup | AddInputGroup |
AddInputStem | AddInputStem |
AddListBox | AddListBox |
AddListEntry | AddListEntry |
AddMenuItem | AddMenuItem |
AddMenuSeparator | AddMenuSeparator |
AddOkCancelLeftBottom | AddOkCancelLeftBottom |
AddOkCancelLeftTop | AddOkCancelLeftTop |
AddOkCancelRightBottom | AddOkCancelRightBottom |
AddOkCancelRightTop | AddOkCancelRightTop |
AddPasswordLine | AddPasswordLine |
AddPopupMenu | AddPopupMenu |
AddRadioButton | AddRadioButton |
AddRadioGroup | AddRadioGroup |
AddRadioStem | AddRadioStem |
AddScrollBar | AddScrollBar |
AddText | AddText |
AddUserMsg | AddUserMsg |
AddWhiteFrame | AddWhiteFrame |
AddWhiteRect | AddWhiteRect |
AssignWindow | AssignWindow |
AutoDetection | AutoDetection |
Cancel | Cancel |
Center | Center |
ChangeComboEntry | ChangeComboEntry |
ChangeListEntry | ChangeListEntry |
ClearMessages | ClearMessages |
ComboAddDirectory | ComboAddDirectory |
ComboDrop | ComboDrop |
ConnectButton | ConnectButton |
ConnectCheckBox | ConnectCheckBox |
ConnectComboBox | ConnectComboBox |
ConnectControl | ConnectControl |
ConnectEntryLine | ConnectEntryLine |
ConnectList | ConnectList |
ConnectListBox | ConnectListBox |
ConnectListLeftDoubleClick | ConnectListLeftDoubleClick |
ConnectMultiListBox | ConnectMultiListBox |
ConnectRadioButton | ConnectRadioButton |
Create | Create |
CreateCenter | CreateCenter |
CreateMenu | CreateMenu |
DefineDialog | DefineDialog |
DeInstall | DeInstall |
DeleteComboEntry | DeleteComboEntry |
DeleteListEntry | DeleteListEntry |
Disable | Disable |
DisableItem | DisableItem |
Enable | Enable |
EnableItem | EnableItem |
Execute | Execute |
FindComboEntry | FindComboEntry |
FindListEntry | FindListEntry |
FocusItem | FocusItem |
Get | Get |
GetAttrib | GetAttrib |
GetButtonRect | GetButtonRect |
GetCheckBox | GetCheckBox |
GetComboEntry | GetComboEntry |
GetComboItems | GetComboItems |
GetComboLine | GetComboLine |
GetCurrentComboIndex | GetCurrentComboIndex |
GetCurrentListIndex | GetCurrentListIndex |
GetData | GetData |
GetDataStem | GetDataStem |
GetEntryLine | GetEntryLine |
GetID | GetID |
GetItem | GetItem |
GetListEntry | GetListEntry |
GetListItems | GetListItems |
GetListLine | GetListLine |
GetMultiList | GetMultiList |
GetPos | GetPos |
GetRadioButton | GetRadioButton |
GetSize | GetSize |
GetTextSize | GetTextSize |
GetValue | GetValue |
HandleMessages | HandleMessages |
Help | Help |
Hide | Hide |
HideItem | HideItem |
HideWindow | HideWindow |
Init | Init |
InitAutoDetection | InitAutoDetection |
InitDialog | InitDialog |
InsertComboEntry | InsertComboEntry |
InsertListEntry | InsertListEntry |
IsDialogActive | IsDialogActive |
ItemTitle | ItemTitle |
Leaving | Leaving |
ListAddDirectory | ListAddDirectory |
ListDrop | ListDrop |
Load | Load |
LoadFrame | LoadFrame |
LoadItems | LoadItems |
LoadMenu | LoadMenu |
Move | Move |
NoAutoDetection | NoAutoDetection |
OK | OK |
Resize | Resize |
Run | Run |
SetAttrib | SetAttrib |
SetCheckBox | SetCheckBox |
SetComboLine | SetComboLine |
SetCurrentComboIndex | SetCurrentComboIndex |
SetCurrentListIndex | SetCurrentListIndex |
SetData | SetData |
SetDataStem | SetDataStem |
SetEntryLine | SetEntryLine |
SetListLine | SetListLine |
SetListTabulators | SetListTabulators |
SetMenu | SetMenu |
SetMultiList | SetMultiList |
SetRadioButton | SetRadioButton |
SetStaticText | SetStaticText |
SetTitle | SetTitle |
SetValue | SetValue |
SetWindowTitle | SetWindowTitle |
Show | Show |
ShowItem | ShowItem |
ShowWindow | ShowWindow |
StartIt | StartIt |
StopIt | StopIt |
Title | Title |
Title= | Title= |
Update | Update |
Validate | Validate |