AxViewManager Class Reference

Manages views, documents, and aspects of menu navigation. More...

#include <ax/ax_view.h>

List of all members.

Public Member Functions

 AxViewManager ()
 ~AxViewManager ()
void Init ()
 Initialise member variables.
void AddView (AxView *view)
 Add a view.
AxViewArray & GetViews ()
 Get view array.
AxViewFindView (wxClassInfo *info) const
 Find view.
AxViewFindOrCreateView (wxClassInfo *info)
 Find or create view, and add to view list if necessary.
virtual bool ActivateView (AxView *view, AxDocument *doc)
 Activate the specified view.
virtual bool DeactivateView (AxView *view)
 Deactive the specified view.
virtual bool MakeModal (bool showModal)
 Begin/end modal.
AxViewGetActiveView () const
 Get active view.
void ClearViews ()
 Clear all views.
void Clear ()
 Clear everything.
void SetMenuCtrl (wxWindow *ctrl)
 Set the window to be used as the main menu control.
wxWindow * GetMenuCtrl () const
 Get the window used as the main menu control.
void SetContainerCtrl (AxContainerCtrl *ctrl)
 Set the window to be used as the main container control.
AxContainerCtrlGetContainerCtrl () const
 Get the window used as the main container control.
void SetViewPagerCtrl (AxPagerCtrl *ctrl)
 Set the window to be used as the main view pager control.
AxPagerCtrlGetViewPagerCtrl () const
 Get the window used as the main view pager container control.
void SetTitleCtrl (wxTextCtrl *ctrl)
 Set the window to be used as the main title control.
wxTextCtrl * GetTitleCtrl () const
 Get the window used as the main title control.
void SetDescriptionCtrl (wxTextCtrl *ctrl)
 Set the window to be used as the short description control.
wxTextCtrl * GetDescriptionCtrl () const
 Get the window used as the main description control.
AxMenuControllerGetMenuController ()
 Get the controller object.
void SetMenuController (AxMenuController *controller)
 Set the controller object.
void SetShortcutManager (wxShortcutManager *manager)
 Set shortcut manager.
wxShortcutManagerGetShortcutManager () const
 Get shortcut manager.
bool ShowInitialMenu (AxMenu *menu)
 Show initial top-level menu.
bool ShowMenu (AxMenu *menu, AxMenuItem *parentItem=NULL, AxMenu *childMenu=NULL)
 Show this menu, optionally passing the item it's spawned from.
virtual bool ShowHomeView ()
 Show the home view.
wxString GetHomeDescription () const
 Set the home description text.
void SetHomeDescription (const wxString &descr)
 Gets the home description text.
bool IsModal () const
 Returns true if the menu is modal.
void SetVisualSettings (const AxVisualSettings &settings)
 Get visual settings.
AxVisualSettingsGetVisualSettings ()
const AxVisualSettingsGetVisualSettings () const
AxSpeechGetSpeech ()
 Returns the speech object.
const AxSpeechGetSpeech () const
virtual bool UpdateAppearance (wxWindow *window=NULL, int hints=AxVisualSettingAll)
 Updates the appearance of windows when settings changed.
virtual bool StopSpeech ()
 Stops speaking.
virtual bool CanStopSpeech ()
 Returns true if we can stop speaking.
virtual bool IdleProcessing ()
 Do idle processing.

Static Public Member Functions

static AxViewManagerGet ()
 Get current instance of the view manager.

Protected Attributes

AxViewArray m_views
AxViewm_activeView
wxWindow * m_menuCtrl
AxContainerCtrlm_containerCtrl
AxPagerCtrlm_viewPagerCtrl
wxTextCtrl * m_titleCtrl
wxTextCtrl * m_descriptionCtrl
AxMenuControllerm_menuController
wxString m_homeDescription
int m_modalCount
AxVisualSettings m_visualSettings
AxSpeech m_speech
wxShortcutManagerm_shortcutManager

Static Protected Attributes

static AxViewManagersm_viewManager


Detailed Description

Manages views, documents, and aspects of menu navigation.

AxViewManager also contains speech objects and visual settings, so every AxTk application must store an instance of this class, usually in the application class.


Constructor & Destructor Documentation

AxViewManager::AxViewManager (  )  [inline]

AxViewManager::~AxViewManager (  ) 


Member Function Documentation

void AxViewManager::Init (  ) 

Initialise member variables.

void AxViewManager::AddView ( AxView view  )  [inline]

Add a view.

AxViewArray& AxViewManager::GetViews (  )  [inline]

Get view array.

AxView * AxViewManager::FindView ( wxClassInfo *  info  )  const

Find view.

AxView * AxViewManager::FindOrCreateView ( wxClassInfo *  info  ) 

Find or create view, and add to view list if necessary.

bool AxViewManager::ActivateView ( AxView view,
AxDocument doc 
) [virtual]

Activate the specified view.

bool AxViewManager::DeactivateView ( AxView view  )  [virtual]

Deactive the specified view.

bool AxViewManager::MakeModal ( bool  showModal  )  [virtual]

Begin/end modal.

AxView* AxViewManager::GetActiveView (  )  const [inline]

Get active view.

void AxViewManager::ClearViews (  ) 

Clear all views.

void AxViewManager::Clear (  ) 

Clear everything.

void AxViewManager::SetMenuCtrl ( wxWindow *  ctrl  )  [inline]

Set the window to be used as the main menu control.

wxWindow* AxViewManager::GetMenuCtrl (  )  const [inline]

Get the window used as the main menu control.

void AxViewManager::SetContainerCtrl ( AxContainerCtrl ctrl  )  [inline]

Set the window to be used as the main container control.

AxContainerCtrl* AxViewManager::GetContainerCtrl (  )  const [inline]

Get the window used as the main container control.

void AxViewManager::SetViewPagerCtrl ( AxPagerCtrl ctrl  )  [inline]

Set the window to be used as the main view pager control.

AxPagerCtrl* AxViewManager::GetViewPagerCtrl (  )  const [inline]

Get the window used as the main view pager container control.

void AxViewManager::SetTitleCtrl ( wxTextCtrl *  ctrl  )  [inline]

Set the window to be used as the main title control.

wxTextCtrl* AxViewManager::GetTitleCtrl (  )  const [inline]

Get the window used as the main title control.

void AxViewManager::SetDescriptionCtrl ( wxTextCtrl *  ctrl  )  [inline]

Set the window to be used as the short description control.

wxTextCtrl* AxViewManager::GetDescriptionCtrl (  )  const [inline]

Get the window used as the main description control.

AxMenuController* AxViewManager::GetMenuController (  )  [inline]

Get the controller object.

void AxViewManager::SetMenuController ( AxMenuController controller  ) 

Set the controller object.

void AxViewManager::SetShortcutManager ( wxShortcutManager manager  )  [inline]

Set shortcut manager.

wxShortcutManager* AxViewManager::GetShortcutManager (  )  const [inline]

Get shortcut manager.

bool AxViewManager::ShowInitialMenu ( AxMenu menu  ) 

Show initial top-level menu.

bool AxViewManager::ShowMenu ( AxMenu menu,
AxMenuItem parentItem = NULL,
AxMenu childMenu = NULL 
)

Show this 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). For example, this might be necessary when showing a file selector with a default selection that is a descendant of the file selection menu.

bool AxViewManager::ShowHomeView (  )  [virtual]

Show the home view.

wxString AxViewManager::GetHomeDescription (  )  const [inline]

Set the home description text.

void AxViewManager::SetHomeDescription ( const wxString &  descr  )  [inline]

Gets the home description text.

bool AxViewManager::IsModal (  )  const [inline]

Returns true if the menu is modal.

void AxViewManager::SetVisualSettings ( const AxVisualSettings settings  )  [inline]

Get visual settings.

AxVisualSettings& AxViewManager::GetVisualSettings (  )  [inline]

const AxVisualSettings& AxViewManager::GetVisualSettings (  )  const [inline]

AxSpeech& AxViewManager::GetSpeech (  )  [inline]

Returns the speech object.

const AxSpeech& AxViewManager::GetSpeech (  )  const [inline]

bool AxViewManager::UpdateAppearance ( wxWindow *  window = NULL,
int  hints = AxVisualSettingAll 
) [virtual]

Updates the appearance of windows when settings changed.

bool AxViewManager::StopSpeech (  )  [virtual]

Stops speaking.

bool AxViewManager::CanStopSpeech (  )  [virtual]

Returns true if we can stop speaking.

bool AxViewManager::IdleProcessing (  )  [virtual]

Do idle processing.

This is actually implemented in the menu controller in order to strictly control the order of idle processing (speech idle processing must come last).

static AxViewManager* AxViewManager::Get (  )  [inline, static]

Get current instance of the view manager.


Member Data Documentation

AxViewArray AxViewManager::m_views [protected]

AxView* AxViewManager::m_activeView [protected]

wxWindow* AxViewManager::m_menuCtrl [protected]

AxContainerCtrl* AxViewManager::m_containerCtrl [protected]

AxPagerCtrl* AxViewManager::m_viewPagerCtrl [protected]

wxTextCtrl* AxViewManager::m_titleCtrl [protected]

wxTextCtrl* AxViewManager::m_descriptionCtrl [protected]

AxMenuController* AxViewManager::m_menuController [protected]

wxString AxViewManager::m_homeDescription [protected]

int AxViewManager::m_modalCount [protected]

AxVisualSettings AxViewManager::m_visualSettings [protected]

AxSpeech AxViewManager::m_speech [protected]

AxViewManager * AxViewManager::sm_viewManager [static, protected]

wxShortcutManager* AxViewManager::m_shortcutManager [protected]


The documentation for this class was generated from the following files:
Generated on Wed May 6 19:20:22 2009 for AxTk by  doxygen 1.5.1