AxModalMenu Class Reference
[Basic AxTk UI classes]
A class to show a menu 'modally', that is, interrupting program flow and not allowing the user to make other selections.
More...
#include <ax/ax_menu_modal.h>
Inheritance diagram for AxModalMenu:
Public Member Functions | |
| AxModalMenu () | |
| AxModalMenu (AxMenuController *controller, AxMenuItem *item=NULL) | |
| ~AxModalMenu () | |
| void | Init () |
| virtual wxString | ShowModal (AxMenu *childMenu=NULL) |
| Starts showing the menu modally. | |
| virtual bool | EndModal (const wxString &returnCode) |
| Terminates the modal loop. | |
| virtual bool | Hide () |
| 'Hides' the menu (restores previous) | |
| AxMenuItem * | GetMenuItem () const |
| void | SetMenuItem (AxMenuItem *item) |
| AxMenuController * | GetController () const |
| void | SetController (AxMenuController *controller) |
| const wxString & | GetReturnCode () const |
| void | SetReturnCode (const wxString &code) |
| bool | IsModal () const |
| void | SetModal (bool modal) |
| void | SetPreviousMenu (AxMenu *menu) |
| AxMenu * | GetPreviousMenu () const |
| void | SetMenu (AxMenu *menu) |
| AxMenu * | GetMenu () const |
| bool | RestorePreviousMenu () |
Protected Attributes | |
| AxMenuItem * | m_menuItem |
| AxMenuController * | m_controller |
| wxString | m_returnCode |
| wxEventLoop * | m_eventLoop |
| bool | m_modalShowing |
| AxMenu * | m_menu |
| AxMenu * | m_previousMenu |
Detailed Description
A class to show a menu 'modally', that is, interrupting program flow and not allowing the user to make other selections.Constructor & Destructor Documentation
| AxModalMenu::AxModalMenu | ( | ) | [inline] |
| AxModalMenu::AxModalMenu | ( | AxMenuController * | controller, | |
| AxMenuItem * | item = NULL | |||
| ) |
| AxModalMenu::~AxModalMenu | ( | ) |
Member Function Documentation
| bool AxModalMenu::EndModal | ( | const wxString & | returnCode | ) | [virtual] |
Terminates the modal loop.
| AxMenuController* AxModalMenu::GetController | ( | ) | const [inline] |
| AxMenu* AxModalMenu::GetMenu | ( | ) | const [inline] |
| AxMenuItem* AxModalMenu::GetMenuItem | ( | ) | const [inline] |
| AxMenu* AxModalMenu::GetPreviousMenu | ( | ) | const [inline] |
| const wxString& AxModalMenu::GetReturnCode | ( | ) | const [inline] |
| bool AxModalMenu::Hide | ( | ) | [virtual] |
'Hides' the menu (restores previous)
| void AxModalMenu::Init | ( | ) |
Reimplemented in AxModalAlertMenu, AxModalChoiceMenu, and AxModalFolderMenu.
| bool AxModalMenu::IsModal | ( | ) | const [inline] |
| bool AxModalMenu::RestorePreviousMenu | ( | ) |
| void AxModalMenu::SetController | ( | AxMenuController * | controller | ) | [inline] |
| void AxModalMenu::SetMenu | ( | AxMenu * | menu | ) | [inline] |
| void AxModalMenu::SetMenuItem | ( | AxMenuItem * | item | ) | [inline] |
| void AxModalMenu::SetModal | ( | bool | modal | ) | [inline] |
| void AxModalMenu::SetPreviousMenu | ( | AxMenu * | menu | ) | [inline] |
| void AxModalMenu::SetReturnCode | ( | const wxString & | code | ) | [inline] |
| wxString AxModalMenu::ShowModal | ( | AxMenu * | childMenu = NULL |
) | [virtual] |
Starts showing the menu modally.
If childMenu is specified, it will be shown immediately instead of the top-level menu.
Member Data Documentation
AxMenuController* AxModalMenu::m_controller [protected] |
wxEventLoop* AxModalMenu::m_eventLoop [protected] |
AxMenu* AxModalMenu::m_menu [protected] |
AxMenuItem* AxModalMenu::m_menuItem [protected] |
bool AxModalMenu::m_modalShowing [protected] |
AxMenu* AxModalMenu::m_previousMenu [protected] |
wxString AxModalMenu::m_returnCode [protected] |
The documentation for this class was generated from the following files:
- include/ax/ax_menu_modal.h
- src/ax/ax_menu_modal.cpp
