AxMenuController Class Reference
[Basic AxTk UI classes]

This class coordinates activity between the AxMenu, the control used to display it, and the view manager. More...

#include <ax/ax_menu.h>

Inheritance diagram for AxMenuController:

AxStandardMenuController

List of all members.

Public Member Functions

 AxMenuController ()
 ~AxMenuController ()
void Init ()
void SetViewManager (AxViewManager *manager)
 Set/get view manager.
AxViewManagerGetViewManager () const
AxMenuGetMenu () const
 Get the main menu.
void SetMenu (AxMenu *menu)
 Set the main menu.
AxMenuGetCurrentMenu () const
 Get current menu (either the top-level menu, or a submenu).
void SetCurrentMenu (AxMenu *menu)
 Set current menu (either the top-level menu, or a submenu).
virtual bool ShowInitialMenu (AxMenu *menu)
 Show initial top-level menu.
virtual bool Activate (AxMenuItem *item)
 Called by the menu control when the user has interacted with it.
virtual bool Select (AxMenuItem *item)
virtual bool Describe (AxMenuItem *item, int describeAtVerbosity=5)
virtual bool DescribeCurrentContext (int describeAtVerbosity=3)
virtual bool DescribeCurrentItem (int describeAtVerbosity=5)
virtual bool GoUp ()
virtual bool GoHome ()
virtual bool ShowMenu (AxMenu *menu, AxMenuItem *parentItem=NULL, AxMenu *childMenu=NULL, AxNavigationHint hint=AxNavigationHintNone)
 Show menu, optionally passing the item it's spawned from.
virtual bool UpdateUI (AxMenu *menu)
 Update the current menu UI.
virtual bool CanGoUp () const
 Returns true if the user can go up a menu.
virtual bool CanGoHome () const
 Returns true if the user can go to the home menu.
virtual bool RefreshMenu (AxMenu *menu, AxNavigationHint hint)=0
 Called when the menu must be refreshed - implement for a specific control.
virtual bool SetMenuSelection (AxMenuItem *menuItem)=0
 Called when a menu item should be selected - implement for a specific control.
virtual bool UpdateMenuItem (AxMenuItem *item)=0
 Called when a menu item must be updated.
virtual AxMenuItemGetMenuSelection () const =0
 Called when we need to get the currently selected menu item - implement for a specific control.
virtual bool BeginModal ()=0
 Called when the menu becomes modal.
virtual bool EndModal ()=0
 Called when the menu stops being modal.
virtual bool SetTitle (const wxString &title)=0
 Called when the current view title should be changed - implement for a specific title control.
virtual bool SetMenuFocus ()=0
 Called when the menu should get the focus.
virtual bool OnChangeMenuPre (AxMenu *currentMenu, AxMenu *newMenu)
 Override if something needs to be done before the menu context changes, e.g.
virtual bool OnChangeMenuPost (AxMenu *newMenu)
 Override if something needs to be done before the menu context changes, e.g.
virtual bool OnBeforeDisplay (AxMenu *newMenu)
 Override to do something just before the menu is refreshed.
virtual bool UpdateAppearance (int hints)=0
 Override to update the appearance when settings change.
bool EmitSpeech (AxSpeechEvent &event)
 Emit speech.
bool EmitSpeech (const wxString &speechEventType, const wxString &text=wxEmptyString, AxNavigationHint hint=AxNavigationHintNone, int flags=0)
 Emit speech.
bool EmitSpeech (const wxString &speechEventType, AxNavigationHint hint, int flags=0)
 Emit speech.
virtual bool DoEmitSpeech (AxSpeechEvent &event)
 Speech emission implementation.
virtual bool IdleProcessing ()
 Perform idle processing.

Protected Attributes

AxMenum_menu
AxMenum_currentMenu
AxViewManagerm_viewManager


Detailed Description

This class coordinates activity between the AxMenu, the control used to display it, and the view manager.

Derive from this class and override functions that indicate when the menu should change. Also, call functions in this object to indicate activation, etc.


Constructor & Destructor Documentation

AxMenuController::AxMenuController (  )  [inline]

AxMenuController::~AxMenuController (  ) 


Member Function Documentation

bool AxMenuController::Activate ( AxMenuItem item  )  [virtual]

Called by the menu control when the user has interacted with it.

virtual bool AxMenuController::BeginModal (  )  [pure virtual]

Called when the menu becomes modal.

Implemented in AxStandardMenuController.

bool AxMenuController::CanGoHome (  )  const [virtual]

Returns true if the user can go to the home menu.

bool AxMenuController::CanGoUp (  )  const [virtual]

Returns true if the user can go up a menu.

bool AxMenuController::Describe ( AxMenuItem item,
int  describeAtVerbosity = 5 
) [virtual]

bool AxMenuController::DescribeCurrentContext ( int  describeAtVerbosity = 3  )  [virtual]

bool AxMenuController::DescribeCurrentItem ( int  describeAtVerbosity = 5  )  [virtual]

bool AxMenuController::DoEmitSpeech ( AxSpeechEvent event  )  [virtual]

Speech emission implementation.

bool AxMenuController::EmitSpeech ( const wxString &  speechEventType,
AxNavigationHint  hint,
int  flags = 0 
)

Emit speech.

bool AxMenuController::EmitSpeech ( const wxString &  speechEventType,
const wxString &  text = wxEmptyString,
AxNavigationHint  hint = AxNavigationHintNone,
int  flags = 0 
)

Emit speech.

bool AxMenuController::EmitSpeech ( AxSpeechEvent event  )  [inline]

Emit speech.

virtual bool AxMenuController::EndModal (  )  [pure virtual]

Called when the menu stops being modal.

Implemented in AxStandardMenuController.

AxMenu* AxMenuController::GetCurrentMenu (  )  const [inline]

Get current menu (either the top-level menu, or a submenu).

AxMenu* AxMenuController::GetMenu (  )  const [inline]

Get the main menu.

virtual AxMenuItem* AxMenuController::GetMenuSelection (  )  const [pure virtual]

Called when we need to get the currently selected menu item - implement for a specific control.

Implemented in AxStandardMenuController.

AxViewManager* AxMenuController::GetViewManager (  )  const [inline]

bool AxMenuController::GoHome (  )  [virtual]

bool AxMenuController::GoUp (  )  [virtual]

bool AxMenuController::IdleProcessing (  )  [virtual]

Perform idle processing.

Reimplemented in AxStandardMenuController.

void AxMenuController::Init (  ) 

Reimplemented in AxStandardMenuController.

bool AxMenuController::OnBeforeDisplay ( AxMenu newMenu  )  [virtual]

Override to do something just before the menu is refreshed.

virtual bool AxMenuController::OnChangeMenuPost ( AxMenu newMenu  )  [virtual]

Override if something needs to be done before the menu context changes, e.g.

saving an edit. If this returns false, it vetoes the menu change.

bool AxMenuController::OnChangeMenuPre ( AxMenu currentMenu,
AxMenu newMenu 
) [virtual]

Override if something needs to be done before the menu context changes, e.g.

saving an edit. If this returns false, it vetoes the menu change.

virtual bool AxMenuController::RefreshMenu ( AxMenu menu,
AxNavigationHint  hint 
) [pure virtual]

Called when the menu must be refreshed - implement for a specific control.

Implemented in AxStandardMenuController.

bool AxMenuController::Select ( AxMenuItem item  )  [virtual]

void AxMenuController::SetCurrentMenu ( AxMenu menu  )  [inline]

Set current menu (either the top-level menu, or a submenu).

void AxMenuController::SetMenu ( AxMenu menu  ) 

Set the main menu.

virtual bool AxMenuController::SetMenuFocus (  )  [pure virtual]

Called when the menu should get the focus.

Implemented in AxStandardMenuController.

virtual bool AxMenuController::SetMenuSelection ( AxMenuItem menuItem  )  [pure virtual]

Called when a menu item should be selected - implement for a specific control.

Implemented in AxStandardMenuController.

virtual bool AxMenuController::SetTitle ( const wxString &  title  )  [pure virtual]

Called when the current view title should be changed - implement for a specific title control.

Implemented in AxStandardMenuController.

void AxMenuController::SetViewManager ( AxViewManager manager  )  [inline]

Set/get view manager.

bool AxMenuController::ShowInitialMenu ( AxMenu menu  )  [virtual]

Show initial top-level menu.

bool AxMenuController::ShowMenu ( AxMenu menu,
AxMenuItem parentItem = NULL,
AxMenu childMenu = NULL,
AxNavigationHint  hint = AxNavigationHintNone 
) [virtual]

Show menu, optionally passing the item it's spawned from.

If childMenu is specified, link 'menu' but then show the child menu immediately (i.e., a child of the menu we're showing).

virtual bool AxMenuController::UpdateAppearance ( int  hints  )  [pure virtual]

Override to update the appearance when settings change.

Implemented in AxStandardMenuController.

virtual bool AxMenuController::UpdateMenuItem ( AxMenuItem item  )  [pure virtual]

Called when a menu item must be updated.

Implemented in AxStandardMenuController.

bool AxMenuController::UpdateUI ( AxMenu menu  )  [virtual]

Update the current menu UI.


Member Data Documentation


The documentation for this class was generated from the following files:

Generated on Wed May 6 19:22:07 2009 for AxTk by  doxygen 1.5.8