MaxCustomControls::MaxForm Class Reference
Detailed Description
This class is an augmented Form designed for use with the Max platform.
Clients planning on implementing managed dialogs in the application should make use of and derive from MaxForm instead of from Form directly. This class is aware of certain application-specific behaviour, such as Custom User Interface (CUI) changes, and supplies a mechanism for doing modeless dialogs that doesn't interfere with the application's hotkey system. In fact, the standard Form may not even receive any keyboard input when launched on top of the native application.
Public Member Functions |
|
| MaxForm () | |
| Default Constructor. |
|
| virtual void | UpdateColors () |
| Updates the form's colors according to the
current CUI settings. |
|
| virtual void | ShowModeless () |
| Displays this form modelessly sets the main
application's window as the parent. |
|
| virtual DialogResult | ShowModal () |
| Displays this form as a modal dialog and
sets the main application's window as the parent. |
|
| virtual DialogResult | ShowModal (Form aForm) |
| Displays this form as a modal dialog and
sets the passed in Form as the parent. |
|
| virtual ICustomizationState | SaveState () |
| Save the states of
MaxForm such as form size. |
|
| virtual bool | LoadState (ICustomizationState stateToLoad) |
| Load the form states such as size from the
"stateToLoad" object. |
|
Protected Member Functions |
|
| virtual FormCustomizationState | CreateState () |
| A factory method for creating the state
object that represents this form. |
|
| override void | Dispose (bool disposing) |
| Clean up any resources being used. |
|
Constructor & Destructor Documentation
| MaxCustomControls::MaxForm::MaxForm | ( | ) | [inline] |
Default Constructor.
Member Function Documentation
| virtual void MaxCustomControls::MaxForm::UpdateColors | ( | ) | [inline, virtual] |
Updates the form's colors according to the current CUI settings.
Implementation of CuiUpdatable interface.
Implements MaxCustomControls::CuiUpdatable.
Reimplemented in MaxCustomControls::RenameInstanceDialog.
| virtual void MaxCustomControls::MaxForm::ShowModeless | ( | ) | [inline, virtual] |
Displays this form modelessly sets the main application's window as the parent.
| virtual DialogResult MaxCustomControls::MaxForm::ShowModal | ( | ) | [inline, virtual] |
Displays this form as a modal dialog and sets the main application's window as the parent.
- Returns:
- The result of this modal interaction. The return value is the same as Form.ShowDialog(IWin32Window)
| virtual DialogResult MaxCustomControls::MaxForm::ShowModal | ( | Form | aForm | ) | [inline, virtual] |
Displays this form as a modal dialog and sets the passed in Form as the parent.
- Parameters:
-
aForm A form to be used as a parent of this modal Form
- Returns:
- The result of this modal interaction. The return value is the same as Form.ShowDialog(Form)
| virtual ICustomizationState MaxCustomControls::MaxForm::SaveState | ( | ) | [inline, virtual] |
Save the states of MaxForm such as form size.
- Returns:
- A CustomizationState object containing MaxForm's states.
Implements MaxCustomControls::ISerializable.
Reimplemented in MaxCustomControls::MaterialBrowserControls::BaseMaterialBrowserContainer, and MaxCustomControls::MaterialExplorerControls::MaterialExplorerDialog.
| virtual bool MaxCustomControls::MaxForm::LoadState | ( | ICustomizationState | stateToLoad | ) | [inline, virtual] |
Load the form states such as size from the "stateToLoad" object.
- Parameters:
-
stateToLoad The object which contains the states of the form.
- Returns:
- Return true if load successfully, false otherwise
Implements MaxCustomControls::ISerializable.
Reimplemented in MaxCustomControls::MaterialBrowserControls::BaseMaterialBrowserContainer, and MaxCustomControls::MaterialExplorerControls::MaterialExplorerDialog.
| virtual FormCustomizationState MaxCustomControls::MaxForm::CreateState | ( | ) | [inline, protected, virtual] |
A factory method for creating the state object that represents this form.
Clients deriving from this class should override this method and return their own derived State object.
- Returns:
- An empty State object that is used to persist and serialize the state of this object.
Reimplemented in MaxCustomControls::MaterialBrowserControls::BaseMaterialBrowserContainer, and MaxCustomControls::MaterialExplorerControls::MaterialExplorerDialog.
| override void MaxCustomControls::MaxForm::Dispose | ( | bool | disposing | ) | [inline, protected] |
Clean up any resources being used.
- Parameters:
-
disposing true if managed resources should be disposed; otherwise, false.
Reimplemented in MaxCustomControls::AdvancedSearch::SearchForm, MaxCustomControls::MaterialBrowserControls::ModalMaterialBrowser, MaxCustomControls::MaterialBrowserControls::ModelessMaterialBrowser, MaxCustomControls::MaterialExplorerControls::MaterialExplorerDialog, MaxCustomControls::ProgressDialog, MaxCustomControls::RenameInstanceDialog, MaxCustomControls::SceneExplorerControls::ManageSceneExplorerForm, and MaxCustomControls::SceneExplorerControls::ModalSceneExplorerDialog.
