MUI Developer's Guide
MUI Interfaces | MUI Methods | MUI Types and Misc API
Interface ID: IID_IMuiDialog
Class ID: CLSID_IMui
Pointer type: PIMuiDialog
Inheritance: IMoaUnknown
Header file: mui.h
Description
- This interface, implemented in the Mui Xtra by the CMui class,
provides platform-independent dialog boxes for use by Xtras. For
more information on using this interface, see the MUI Developer's Guide.
Methods
- Initialize()
Run()
Stop()
SetCallback()
WindowOp()
ItemUpdate()
GetWindowGC()
SetWindowParent()
Syntax
- GetWindowGC(PMoaMmNativeGCInfo pWindowInfo)
Parameters
- pWindowInfo
- PMoaMmNativeGCInfo for the dialog window
Returns
- MoaError
Description
- This method is useful on Windows for getting the graphics context of the dialog window.
Syntax
- Initialize(PTMuiWindow PWindow, MoaLong iInputArraySize, TMuiItem PInputStrucArray[])
Parameters
- PWindow
- PTMuiWindow structure containing information specifying window attributes
- iInputArraySize
- MoaLong
- PInputStrucArray[]
- TMuiItem array containing specifications for each widget presented by the dialog
Returns
- MoaError
Description
- Initializes the dialog box by specifying attributes of the
window and the widgets displayed in the window.
Syntax
- ItemUpdate(MoaLong iItemIndex, PTMuiItem PItemInitStructure)
Parameters
- iItemIndex
- MoaLong
- PItemInitStructure
- Handle to a TMuiItem structure containing the updated information for the widget
Returns
- MoaError
Description
- Call this method from within your Xtra's IMoaNotificationClient::Notify() method to update items in the dialog in response to user events.
Syntax
- Run()
Parameters
Returns
- MoaError
Description
- Displays the dialog box to the user and begins sending events
to the user. If the dialog is modal, this method returns only
when the user closes the dialog. If non-modal, this method returns
immediately, and its up to you to close the dialog as necessary
by calling IMoaDialog::Stop() from your notification
client's Notify() method.
Syntax
- SetCallback(PIMoaNotificationClient notifyInterface, PMoaVoid clientDataReference)
Parameters
- notifyInterface
- IMoaNotificationClient interface implemented
by an Xtra to handle events from a dialog box.
- clientDataReference
- PMoaVoid
Returns
- MoaError
Description
- Registers your Xtra's notification client with the dialog
Xtra, enabling the Xtra to send you events as the use manipulates
the dialog box.
Syntax
- SetWindowParent(MoaMmWinHdl32 window)
Parameters
- window
- MoaMmWinHdl32
Returns
- MoaError
Description
- Useful on Windows for setting the parent window of a particular
dialog box.
Syntax
- Stop(MoaError statusCode )
Parameters
- statusCode
- MoaError
Returns
- MoaError
Description
- Stops a non-modal dialog.
Syntax
- WindowOp(MoaLong iWindowOp)
Parameters
- iWindowOp
- MoaLong
Returns
- MoaError
Description
- This method controls the presentation of non-modal dialogs.
Values passed to the iWindowOp parameter determine the status
of a non-modal dialog. These values can be:
kMui_WindowOp_Hide |
Hide the dialog |
kMui_WindowOp_Show |
Show the dialog |
kMui_WindowOp_Center |
Center the dialog |
Copyright © 1995-2008 Adobe Macromedia Software LLC, Inc.