MUI Developer's Guide
MUI Interfaces | MUI Methods
This document contains the following sections:
Defined in: muiinit.t
typedef MoaLong TMuiAlertButtonType
Passed to IMuiAlert::Alert(), specifies the buttons in an alert. The following constants define the button types:
| Constant | Buttons |
| kMuiAlertButtons_Ok | 1: OK |
| kMuiAlertButtons_OkCancel | 2: OK, Cancel |
| kMuiAlertButtons_AbortRetryIgnore | 3: Abort, Retry, Ignore |
| kMuiAlertButtons_YesNoCancel | 3: Yes, No, Cancel |
| kMuiAlertButtons_YesNo | 2: Yes, No |
| kMuiAlertButtons_RetryCancel | 2: Retry, Cancel |
Defined in: muiinit.t
typedef MoaLong TMuiAlertIcon
Passed to IMuiAlert::Alert(), specifies the icon in an alert box. The following constants define the alert icons:
| kMuiAlertIcon_None | |
| kMuiAlertIcon_Stop | |
| kMuiAlertIcon_Note | |
| kMuiAlertIcon_Caution | |
| kMuiAlertIcon_Question | |
| kMuiAlertIcon_Error |
Defined in: mui.h
typedef MoaLong TMuiDialogEvent
Value passed to IMoaNotificationClient::Notify() to enable event handling for a dialog box. The following constants define the types of events:
| Constant | itemHit | Data in refCon |
| kMuiDialogItemChanged | item changed | - |
| kMuiDialogItemClicked | item clicked | - |
| kMuiDialogWindowOpening | - | - |
| kMuiDialogWindowClosed | - | - |
| kMuiDialogWindowResize | - | PMoaRect |
| kMuiDialogWindowZoom | - | PMoaRect |
| kMuiDialogItemEnteringFocus | item about to get focus | - |
| kMuiDialogItemLosingFocus | item about to lose focus | - |
| kMuiDialogListSelChanged added in D11 |
item whose selection changed | int* of selected items |
| kMuiDialogListDoubleClicked added in D11 |
item which was double clicked | int* of selected items |
Defined in: mui.h
typedef struct
{
MoaLong itemHit;
TMuiDialogEvent event;
PIMuiDialog pDialog;
MoaLong reserved;
} TMuiEventRecord;
Structure passed by a dialog to the IMoaNotificationClient::Notify() method to communicate user events to an Xtra.
Defined in: muiinit.t
typedef struct
{
MoaLong iStructSize;
MoaMmValue vValue;
TMuiWidgetType iType;
MoaMmValue vAttributeList;
ConstPMoaChar pTitle;
ConstPMoaChar pToolTip;
MoaLong iXPosition;
MoaLong iYPosition;
MoaLong iWidth;
MoaLong iHeight;
MoaBool bEnabled;
} TMuiItem, * PTMuiItem;
Structure passed in an array to IMuiDialog::Initialize() to indicate parameters of the widgets to be created. Fields in the structure are used as follows:
| Field | Type | Description |
| iStructSize | MoaLong | Determine version of struct, = sizeof(TMuiWindow) |
| vValue | MoaMmValue | initial value/data to be modified |
| iType | TMuiWidgetType | contextual: if data driven, a widget TIMui_WidgetType; if DU driven, a widget TIMui_WidgetType; if Pixel driven, a widget TIMui_WidgetType; if resource driven, a resource ID |
| vAttributeList | MoaMmValue | contextual: if enum list of valid values; if int/float list with min 1st, and optionally, max 2nd; if a label, a list with #center, #right, and #left for justification. |
| pTitle | ConstPMoaChar | widget title, NULL no title |
| pToolTip | ConstPMoaChar | string with tool tip to display when floating over, NULL = not tip |
| iXPosition | MoaLong | position of upper left of item, from upper left of dialog |
| iYPosition | MoaLong | position of upper left of item, from upper left of dialog |
| iWidth | MoaLong | pixel width of item, NULL = automatic |
| iHeight | MoaLong | pixel height of item, NULL = automatic |
| bEnabled | MoaBool | the UI information related to value |
Defined in: muiinit.t
typedef MoaLong TMuiLayoutType;
Field of the TMuiWindow structure, specifies the layout type of a dialog window.
| kMuiLayout_Dynamic | Layout provided automatically, use TMuiWidgetTypes to specify layout groupings |
| kMuiLayout_DialogUnit | Layout coordinates defined in dialog units |
| kMuiLayout_Pixel | Layout coordinates defined in pixel units |
| kMuiLayout_Resource | Layout provided by resource |
Defined in: muiinit.t
typedef MoaLong TMuiWidgetType
Field of the TMuiItem structure, used to specify the type of items displayed in a dialog box. The following values are defined for the widget type:
| Widget type | Title | Attributes |
| kMuiWidgetType_None | No | none |
| kMuiWidgetType_Void_VDivider | No | none |
| kMuiWidgetType_Void_HDivider | No | none |
| kMuiWidgetType_Bitmap | No | <bitmapStyle> |
| kMuiWidgetType_Actor | ? | ? |
| kMuiWidgetType_Boolean_Checkbox | Yes | <textSize> |
| kMuiWidgetType_Boolean_RadioButton | Yes | <textSize> |
| kMuiWidgetType_Enum_PopupList | No | <popupStyle><valueList> |
| kMuiWidgetType_Char_EditText | No | <textSize><justification><editStyle> |
| kMuiWidgetType_Label_Normal | No | <textSize><justification><editStyle> |
| kMuiWidgetType_Long_HSlider | No | <sliderStyle><valueRange> |
| kMuiWidgetType_Float_HSlider | No | <sliderStyle><valueRange> |
| kMuiWidgetType_Button_DefaultPushButton | Yes | <textSize> |
| kMuiWidgetType_Button_PushButton | Yes | <textSize> |
| kMuiWidgetType_Button_CancelButton | Yes | <textSize> |
| kMuiWidgetType_Button_Toggle | Yes | <textSize> |
| kMuiWidgetType_RGB_ColorPicker | none | |
| kMuiWidgetType_Index_ColorPicker | none |
| Layout grouping type | Purpose |
| kMuiWidgetType_Group_WindowBegin | First entry in the pInputStructArray |
| kMuiWidgetType_Group_WindowEnd | Last entry in the pInputStructArray |
| kMuiWidgetType_Group_HBegin | Entry preceding a group of widgets arranged horizontally |
| kMuiWidgetType_Group_HEnd | Entry following a group of widgets arranged horizontally |
| kMuiWidgetType_Group_VBegin | Entry preceding a group of widgets arranged vertically |
| kMuiWidgetType_Group_VEnd | Entry following a group of widgets arranged vertically |
Defined in: muiinit.t
typedef struct
{
MoaLong iStructSize
TMuiWindowType iType;
ConstPMoaChar pTitle;
TMuiLayoutType iLayout;
TMuiWindowPosition iPosition;
MoaLong iXPosition;
MoaLong iYPosition;
MoaLong iWidth;
MoaLong iHeight;
MoaBool bModal;
MoaBool bToolTipsOn;
MoaBool bHasCloseBox;
MoaBool bCanZoom;
} TMuiWindow, * PTMuiWindow;
Structure passed to IMuiDialog::Initialize() to indicate parameters of the window to be created. Fields in the structure are used as follows:
| Field | Type | Description |
| iStructSize | MoaLong | use to determine version of struct, = sizeof(TMuiWindow) |
| iType | TMuiWindowType | window type (one of kMuiWindowType_None, kMuiWindowType_Palette, kMuiWindowType_Standard, or kMuiWindowType_NonMovable) |
| pTitle | ConstPMoaChar | name of window, set to NULL for none |
| iLayout | TMuiLayoutType | how to layout the widgets (one of kMuiLayout_Dynamic, kMuiLayout_DialogUnit, kMuiLayout_Pixel, kMuiLayout_Resource, or kMuiLayout_MAX) |
| iPosition | TMuiWindowPosition | if this set, the iXPosition and iYPosition fields may be ignored (one of kMuiWindowPosition_Alert, kMuiWindowPosition_Centered) |
| iXPosition | MoaLong | position of upper left of window, from upper left of dialog, NULL = Center |
| iYPosition | MoaLong | position of upper left of window, from upper left of dialog, NULL = Center |
| iWidth | MoaLong | pixel width of window, NULL = automatic |
| iHeight | MoaLong | pixel height of window, NULL = automatic |
| bModal | MoaBool | TRUE if modal |
| bToolTipsOn | MoaBool | TRUE if dialog should display tool tips initially |
| bHasCloseBox | MoaBool | TRUE if dialog has close box |
| bCanZoom | MoaBool | TRUE if window zooms |
Defined in: muiinit.t
typedef MoaLong TMuiWindowType;
Field of the TMuiWindow structure, specifies the type of a dialog window.
| kMuiWindowType_Standard | |
| kMuiWindowType_NonMovable |
Defined in: muiinit.t
typedef MoaLong TMuiWindowPosition
Field of the TMuiWindow structure, specifies the position of a dialog window. The following values are defined for the window position:
| kMuiWindowPosition_Alert | |
| kMuiWindowPosition_Centered |
The following constants are defined as parameters to the IMuiDialog::WindowOp() method:
|
|
|
|
|
|
kMuiErr_DialogCanceledWithCloseBox
kMuiErr_DialogCanceledWithESC
These errors are returned from the IMuiDialog::Run() method when the user cancels a modal dialog.