Search Toolkit Book for CWindowManager

CWindowManager - component controlling windowing of client windows. More...

#include <gui/widgets/wx/window_manager.hpp>

Inheritance diagram for CWindowManager:

Collaboration diagram for CWindowManager:

Public Types
typedef vector< IWMClient * >	TClients

typedef CWindowManagerEvent	TEvent

typedef wxFrame	TFrame

Public Types inherited from CEventHandler
enum	EDispatch { eDispatch_SelfOnly , eDispatch_AllHandlers , eDispatch_FirstHandler , eDispatch_Default = eDispatch_AllHandlers }
	enum controlling dispatching strategies More...

enum	EPoolName { ePool_Default = 0 , ePool_Parent , ePool_Child , ePool_Sibling , ePool_NextAvailable }
	Identifiers for standard pools. More...

typedef vector< CEventHandler * >	TListeners

typedef map< int, TListeners >	TPools

typedef list< AutoPtr< SPostRequest > >	TPostRequests

typedef std::map< CEventHandler *, int >	THandlerToCount

typedef void(*	FOnPostCallback) ()

Public Member Functions
	CWindowManager (wxFrame *frame)

virtual	~CWindowManager ()

virtual bool	Create (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize)

virtual void	SetAdvisor (IWindowManagerAdvisor *advisor)

virtual void	SetMenuListener (IWindowManagerMenuListener *listener)

wxFrame *	GetFrameWindow ()

CDockManager *	GetDockManager ()

void	ApplyLayout (const objects::CUser_object &layout)

void	LoadLayout (const objects::CUser_object &layout, IWMClientFactory &factory)

objects::CUser_object *	SaveLayout ()

bool	HasToolBar (const string &name)

void	AddToolBar (wxAuiToolBar *toolbar)

void	DeleteToolBar (const string &name)

bool	OnCaptionPanelCommand (CDockPanel &panel, TCmdID cmd)

bool	OnCloseClientsRequest (const TClients &clients)

void	OnFocusChanged (wxWindow *new_focus)

string	GetNewFloatingFrameTitle ()

wxFrame *	GetMainWindow ()

virtual void	SetRegistryPath (const string &reg_path)

bool	OnSetClientColor (CDockPanel &panel)

void	OnDockPanelStartDrag (CDockPanel *panel, const wxPoint &pt)
	Called by CDockPanel to delegated DnD handling to Window Manager. More...

virtual const wxMenu *	GetMenu ()

Event handlers
virtual bool	ProcessEvent (wxEvent &event)

virtual bool	Dispatch (CEvent *evt, EDispatch disp_how, int pool)
	Dispatches an event to the listeners (but does not handle it). More...

void	OnPostCommand (CEvent *evt)
	handles an internal command posted to itself More...

void	OnCloseClientsRequestEvent (CEvent *evt)

void	OnMoveToTopLevel (CEvent *evt)

void	OnLeftUp (wxMouseEvent &evt)

void	OnMotion (wxMouseEvent &evt)

void	OnMouseCaptureLost (wxMouseCaptureLostEvent &event)

void	OnActivateWindow (wxCommandEvent &event)

void	OnShowWindowsDlg (wxCommandEvent &event)

void	OnWindowCommand (wxCommandEvent &event)

void	OnUpdateWindowCommand (wxUpdateUIEvent &event)

void	OnUpdateWindowCommand_Client (wxUpdateUIEvent &event, IWMClient *client)

Public Member Functions inherited from CEventHandler
	CEventHandler ()
	CEventHandler. More...

virtual	~CEventHandler ()

virtual void	AddListener (CEventHandler *listener, int pool_name=ePool_Default)
	Add a listener. More...

virtual void	RemoveListener (CEventHandler *listener)
	Remove a listener. More...

virtual void	RemoveAllListeners (void)

virtual bool	HasListener (CEventHandler *listener, int pool_name=ePool_Default) const
	returns "true" if the given listener belongs to the specified pool More...

virtual const TListeners *	GetListeners (int pool_name=ePool_Default) const
	returns a set of listeners fro the specified pool More...

virtual bool	OnEvent (CEvent *evt)
	Processes en event. Returns "true" if event has been processed. More...

virtual bool	Send (CEvent *evt, EDispatch disp_how=eDispatch_Default, int pool_name=ePool_Default)
	Sends an event synchronously. More...

virtual bool	Send (CEvent *evt, int pool_name)

void	Post (CRef< CEvent > evt, EDispatch disp_how=eDispatch_Default, int pool_name=ePool_Default)
	Handles an event asynchronously (process and/or dispatch). More...

Static Public Member Functions
static void	RegisterImageAliases (wxFileArtProvider &provider)
	registers graphical resources used by Window Manager More...

Static Public Member Functions inherited from CEventHandler
static bool	HandlePostRequest ()

static void	ClearPostQueue ()
	erases all events from the queue More...

static void	DestroyPostQueue ()

Protected Types
typedef map< wxWindow , IWMClient >	TWindowToClientMap

typedef map< int, IWMClient * >	TCmdToWindowMap

Protected Member Functions
	DECLARE_EVENT_MAP ()

	DECLARE_EVENT_TABLE ()

bool	x_RegisterClient (IWMClient &client)

bool	x_AddClient (IWMClient &client)

bool	x_CloseClient (IWMClient &client)

void	x_RemoveClient (IWMClient &client)

void	x_UpdateListener (IWMClient &client)

virtual void	x_UpdateActiveClient ()

IWMClient *	x_GetActiveClientByWindow (wxWindow *widget)

void	x_HandlePanelCommand (IWMClient &client, int cmd)

virtual void	x_UpdateWindowsMenu (wxMenu &root_menu)

string	x_GetClientLabelForMenu (IWMClient &client)

virtual void	x_ResetMenuBar ()

virtual void	x_OnBeginDrag (const wxPoint &mouse_pos)

virtual void	x_OnDrag (const wxPoint &mouse_pos)

virtual void	x_OnEndDrag (const wxPoint &mouse_pos, CDockManager::EDragResult result)

Protected Member Functions inherited from CEventHandler
virtual const SEvtMap *	GetEventMap () const

void	x_DeclareDead ()
	Removes itself unavailable for async event delivery. More...

void	x_AddListenerToPool (CEventHandler *listener, int pool_name)

Protected Attributes
IWindowManagerAdvisor *	m_Advisor
	Advisor is an external object that wants to customize the behavior of Window Manager by providing a callback interface. More...

IWindowManagerMenuListener *	m_MenuListener

wxFrame *	m_FrameWindow
	main frame window hosting window manager More...

wxAuiManager	m_AuiManager
	wxAuiManager is required for CNotebook More...

string	m_RegPath

CDockManager *	m_DockManager
	the Docking Manager associated with this Window Manager More...

TClients	m_Clients
	the collection of registered Client More...

TWindowToClientMap	m_WindowToClient
	index wxWindow -> IWMClient More...

IWMClient *	m_ActiveClient
	belonging to focused IWMClient More...

TCmdToWindowMap	m_CmdToWindow

unique_ptr< wxMenu >	m_Menu

CDockPanel *	m_DragDockPanel

wxPoint	m_ClickPoint

bool	m_Canceled

Protected Attributes inherited from CEventHandler
TPools	m_Pools

Static Protected Attributes
static bool	m_IsDragging = false

Static Protected Attributes inherited from CEventHandler
static const SEvtMap	sm_EvtMap

Private Types
typedef wxPanel	TParent

Client manipulation routines
static bool	IsDragging ()

virtual bool	AddClient (IWMClient &client, bool bFloat)
	adds the client to the Main Tabbed Pane More...

void	MoveToMainTab (IWMClient &client)

wxFrame *	MoveToFloatingFrame (IWMClient &client)

void	Minimize (IWMClient &client)

void	Restore (IWMClient &client)

bool	IsInMainTab (IWMClient &client) const

bool	IsFloating (IWMClient &client) const

bool	IsMinimized (IWMClient &client) const

bool	CloseClient (IWMClient &client)

void	CloseClients (const TClients &clients)

void	CloseAllClients ()

bool	IsRegistered (IWMClient &client) const
	checks if the client in registered in the Window Manager More...

void	GetAllClients (TClients &clients)

IWMClient *	GetActiveClient ()

void	ActivateClient (IWMClient &client)

void	ActivateClients (TClients &clients)

void	RegisterActiveClient (IWMClient &client)

void	UnRegisterActiveClient (IWMClient &client)

void	RaiseFloatingWindowsInZOrder ()

void	RaiseFloatingWindowsInZOrder (wxRect r)

void	RefreshClient (IWMClient &client)

Detailed Description

CWindowManager - component controlling windowing of client windows.

CWindowManager provides centralized control over multiple clients (views) associated with an application. Window Manager provides two ways to place clients - in independent top-level frame windows (Floating Frame) or in containers embedded into manager's main window (docked). CWindowManager allows for dynamic creation of hierarchical layouts consisting of containers such as CSplitter and CTabControl and clients. IWMClient interface represents an abstract client window that can be managed by CWindowManager. IWMContainer interface represents an abstract container that can be embedded into CWindowManager. IWMCPosition represents abstract notion of position in IWMContainer.

Definition at line 112 of file window_manager.hpp.

Member Typedef Documentation

◆ TClients

typedef vector<IWMClient*> CWindowManager::TClients

Definition at line 118 of file window_manager.hpp.

◆ TCmdToWindowMap

typedef map<int, IWMClient*> CWindowManager::TCmdToWindowMap

protected

Definition at line 255 of file window_manager.hpp.

◆ TEvent

typedef CWindowManagerEvent CWindowManager::TEvent

Definition at line 119 of file window_manager.hpp.

◆ TFrame

typedef wxFrame CWindowManager::TFrame

Definition at line 120 of file window_manager.hpp.

◆ TParent

typedef wxPanel CWindowManager::TParent

private

Definition at line 116 of file window_manager.hpp.

◆ TWindowToClientMap

typedef map<wxWindow*, IWMClient*> CWindowManager::TWindowToClientMap

protected

Definition at line 254 of file window_manager.hpp.

Constructor & Destructor Documentation

◆ CWindowManager()

CWindowManager::OnUpdateWindowCommand &CWindowManager::OnCloseClientsRequestEvent CWindowManager::CWindowManager ( wxFrame * frame )

Definition at line 199 of file window_manager.cpp.

◆ ~CWindowManager()

CWindowManager::~CWindowManager ( )

virtual

Definition at line 268 of file window_manager.cpp.

References CloseAllClients(), m_AuiManager, m_DockManager, and NULL.

Member Function Documentation

◆ ActivateClient()

void CWindowManager::ActivateClient ( IWMClient & client )

Definition at line 529 of file window_manager.cpp.

References ActivateClients(), and client.

Referenced by CWindowManagerService::ActivateClient(), and OnActivateWindow().

◆ ActivateClients()

void CWindowManager::ActivateClients ( TClients & clients )

Definition at line 539 of file window_manager.cpp.

References CDockManager::ActivateClients(), and m_DockManager.

Referenced by ActivateClient(), CWindowManagerService::ActivateClients(), and CWindowsDlg::OnActivateClick().

◆ AddClient()

bool CWindowManager::AddClient	(	IWMClient &	client,
		bool	bFloat
	)

virtual

adds the client to the Main Tabbed Pane

Definition at line 302 of file window_manager.cpp.

References CDockManager::AddToDefaultLocation(), client, m_DockManager, OnFocusChanged(), RefreshClient(), x_RegisterClient(), and x_ResetMenuBar().

Referenced by CWindowManagerService::AddClient(), and CDockManager::LoadLayout().

◆ AddToolBar()

void CWindowManager::AddToolBar ( wxAuiToolBar * toolbar )

Definition at line 588 of file window_manager.cpp.

References _ASSERT, and m_AuiManager.

Referenced by CWindowManagerService::x_ShowToolBar().

◆ ApplyLayout()

void CWindowManager::ApplyLayout ( const objects::CUser_object & layout )

Definition at line 1057 of file window_manager.cpp.

References CDockManager::ApplyLayout(), m_DockManager, and x_ResetMenuBar().

Referenced by CWindowManagerService::ApplyLayout().

◆ CloseAllClients()

void CWindowManager::CloseAllClients ( )

Definition at line 477 of file window_manager.cpp.

References client, m_Clients, x_CloseClient(), and x_ResetMenuBar().

Referenced by CWindowManagerService::CloseAllClients(), CWindowManagerService::ShutDownService(), and ~CWindowManager().

◆ CloseClient()

bool CWindowManager::CloseClient ( IWMClient & client )

Definition at line 457 of file window_manager.cpp.

References client, x_CloseClient(), and x_ResetMenuBar().

Referenced by CWindowManagerService::CloseClient().

◆ CloseClients()

void CWindowManager::CloseClients ( const TClients & clients )

Definition at line 467 of file window_manager.cpp.

References client, i, x_CloseClient(), and x_ResetMenuBar().

Referenced by CWindowManagerService::CloseClients().

◆ Create()

bool CWindowManager::Create	(	wxWindow *	parent,
		wxWindowID	id,
		const wxPoint &	pos = `wxDefaultPosition`,
		const wxSize &	size = `wxDefaultSize`
	)

virtual

Definition at line 238 of file window_manager.cpp.

References CDockManager::GetMainContainer(), CDockManager::GetMinPanelContainer(), info, m_AuiManager, m_DockManager, m_FrameWindow, CDockManager::SetKeyboardHook(), ncbi::grid::netcache::search::fields::size, and wxT.

Referenced by CWindowManagerService::InitService().

◆ DECLARE_EVENT_MAP()

CWindowManager::DECLARE_EVENT_MAP ( )

protected

◆ DECLARE_EVENT_TABLE()

CWindowManager::DECLARE_EVENT_TABLE ( )

protected

◆ DeleteToolBar()

void CWindowManager::DeleteToolBar ( const string & name )

Definition at line 612 of file window_manager.cpp.

References m_AuiManager, and ToWxString().

Referenced by CWindowManagerService::x_ShowToolBar().

◆ Dispatch()

bool CWindowManager::Dispatch	(	CEvent *	evt,
		EDispatch	disp_how,
		int	pool_name
	)

virtual

Dispatches an event to the listeners (but does not handle it).

Returns "true" if event has been dispatched and handled by a listener.

Reimplemented from CEventHandler.

Definition at line 999 of file window_manager.cpp.

References client, CEventHandler::Dispatch(), CEventHandler::eDispatch_FirstHandler, GetActiveClient(), CEventHandler::HasListener(), and CEventHandler::Send().

◆ GetActiveClient()

IWMClient * CWindowManager::GetActiveClient ( )

Definition at line 623 of file window_manager.cpp.

References m_ActiveClient.

Referenced by CWindowsDlg::CreateControls(), Dispatch(), CWindowManagerService::GetActiveClient(), OnUpdateWindowCommand(), OnWindowCommand(), and ProcessEvent().

◆ GetAllClients()

void CWindowManager::GetAllClients ( TClients & clients )

Definition at line 516 of file window_manager.cpp.

References m_Clients.

Referenced by CWindowsDlg::CreateControls(), CWindowManagerService::GetAllClients(), and CWindowsDlg::OnCloseClick().

◆ GetDockManager()

CDockManager * CWindowManager::GetDockManager ( )

Definition at line 296 of file window_manager.cpp.

References m_DockManager.

Referenced by CWindowManagerService::InitService().

◆ GetFrameWindow()

wxFrame * CWindowManager::GetFrameWindow ( )

Definition at line 291 of file window_manager.cpp.

References m_FrameWindow.

Referenced by CWindowManagerService::x_ShowToolBar().

◆ GetMainWindow()

wxFrame* CWindowManager::GetMainWindow ( )

inline

Definition at line 213 of file window_manager.hpp.

References m_FrameWindow.

Referenced by CDockManager::ApplyLayout(), CDockManager::LoadLayout(), and CDockManager::SaveLayout().

◆ GetMenu()

const wxMenu * CWindowManager::GetMenu ( )

virtual

Definition at line 682 of file window_manager.cpp.

References _ASSERT, CUICommandRegistry::CreateMenu(), CUICommandRegistry::GetInstance(), and Merge().

Referenced by CWindowManagerService::GetMenu().

◆ GetNewFloatingFrameTitle()

string CWindowManager::GetNewFloatingFrameTitle ( )

Definition at line 964 of file window_manager.cpp.

References IWindowManagerAdvisor::GetFloatingFrameTitle(), kEmptyStr, and m_Advisor.

Referenced by CDockManager::x_CreateFrameAndContainer().

◆ HasToolBar()

bool CWindowManager::HasToolBar ( const string & name )

Definition at line 580 of file window_manager.cpp.

References m_AuiManager, and ToWxString().

Referenced by CWindowManagerService::x_ShowToolBar().

◆ IsDragging()

bool CWindowManager::IsDragging ( void )

static

Definition at line 575 of file window_manager.cpp.

References m_IsDragging.

Referenced by CWindowManagerService::IsDragging().

◆ IsFloating()

bool CWindowManager::IsFloating ( IWMClient & client ) const

Definition at line 354 of file window_manager.cpp.

References client, CDockManager::IsFloating(), and m_DockManager.

Referenced by CWindowsDlg::OnFloatClick(), and CWindowsDlg::x_UpdateButtons().

◆ IsInMainTab()

bool CWindowManager::IsInMainTab ( IWMClient & client ) const

Definition at line 348 of file window_manager.cpp.

References client, CDockManager::IsInMainTab(), and m_DockManager.

Referenced by CWindowsDlg::OnRecoverClick(), and CWindowsDlg::x_UpdateButtons().

◆ IsMinimized()

bool CWindowManager::IsMinimized ( IWMClient & client ) const

Definition at line 360 of file window_manager.cpp.

References client, CDockManager::IsMinimized(), and m_DockManager.

Referenced by CWindowsDlg::OnMinimizeClick(), CWindowsDlg::OnRestoreClick(), and CWindowsDlg::x_UpdateButtons().

◆ IsRegistered()

bool CWindowManager::IsRegistered ( IWMClient & client ) const

checks if the client in registered in the Window Manager

Definition at line 522 of file window_manager.cpp.

References client, and m_Clients.

Referenced by RefreshClient(), and x_RegisterClient().

◆ LoadLayout()

void CWindowManager::LoadLayout	(	const objects::CUser_object &	layout,
		IWMClientFactory &	factory
	)

Definition at line 1065 of file window_manager.cpp.

References CDockManager::LoadLayout(), m_DockManager, and x_ResetMenuBar().

Referenced by CWindowManagerService::LoadLayout().

◆ Minimize()

void CWindowManager::Minimize ( IWMClient & client )

Definition at line 336 of file window_manager.cpp.

References client, m_DockManager, and CDockManager::Minimize().

Referenced by CWindowsDlg::OnMinimizeClick().

◆ MoveToFloatingFrame()

wxFrame * CWindowManager::MoveToFloatingFrame ( IWMClient & client )

Definition at line 330 of file window_manager.cpp.

References client, m_DockManager, and CDockManager::MoveToFloatingFrame().

Referenced by CWindowManagerService::MoveToFloatingFrame(), and CWindowsDlg::OnFloatClick().

◆ MoveToMainTab()

void CWindowManager::MoveToMainTab ( IWMClient & client )

Definition at line 324 of file window_manager.cpp.

References client, m_DockManager, and CDockManager::MoveToMainTab().

Referenced by CWindowsDlg::OnRecoverClick().

◆ OnActivateWindow()

void CWindowManager::OnActivateWindow ( wxCommandEvent & event )

Definition at line 822 of file window_manager.cpp.

References ActivateClient(), client, cmd, and m_CmdToWindow.

◆ OnCaptionPanelCommand()

bool CWindowManager::OnCaptionPanelCommand	(	CDockPanel &	panel,
		TCmdID	cmd
	)

Definition at line 381 of file window_manager.cpp.

References _ASSERT, cmd, eCmdCloseDockPanel, eCmdMoveToMainTab, eCmdSetClientColor, eCmdWindowFloat, eCmdWindowMinimize, eCmdWindowRestore, CEventHandler::eDispatch_SelfOnly, CDockPanel::GetClient(), m_Advisor, m_DockManager, CDockManager::Minimize(), IWindowManagerAdvisor::OnCloseClientsRequest(), OnSetClientColor(), and CEventHandler::Post().

Referenced by CDockManager::OnCloseDockable(), and CDockManager::OnDockPanelCommand().

◆ OnCloseClientsRequest()

bool CWindowManager::OnCloseClientsRequest ( const TClients & clients )

Definition at line 435 of file window_manager.cpp.

References CWindowManagerEvent::eCloseClientsRequest, CEventHandler::eDispatch_SelfOnly, and CEventHandler::Post().

Referenced by CWindowsDlg::OnCloseClick(), CDockManager::OnFrameClosePressed(), and CDockManager::OnTabClosePressed().

◆ OnCloseClientsRequestEvent()

void CWindowManager::OnCloseClientsRequestEvent ( CEvent * evt )

Definition at line 939 of file window_manager.cpp.

References _ASSERT, CWindowManagerEvent::GetClients(), m_Advisor, and IWindowManagerAdvisor::OnCloseClientsRequest().

◆ OnDockPanelStartDrag()

void CWindowManager::OnDockPanelStartDrag	(	CDockPanel *	panel,
		const wxPoint &	pt
	)

Called by CDockPanel to delegated DnD handling to Window Manager.

Definition at line 1088 of file window_manager.cpp.

References m_ClickPoint, m_DragDockPanel, m_IsDragging, and x_OnBeginDrag().

Referenced by CDockPanel::OnMotion().

◆ OnFocusChanged()

void CWindowManager::OnFocusChanged ( wxWindow * new_focus )

Definition at line 781 of file window_manager.cpp.

References client, IWMClient::GetWindow(), m_ActiveClient, m_Advisor, NULL, IWindowManagerAdvisor::OnActiveClientChanged(), x_GetActiveClientByWindow(), and x_ResetMenuBar().

Referenced by AddClient(), CDockPanel::OnChildFocus(), and x_UpdateActiveClient().

◆ OnLeftUp()

void CWindowManager::OnLeftUp ( wxMouseEvent & evt )

Definition at line 1120 of file window_manager.cpp.

References CDockManager::eDrop, m_IsDragging, and x_OnEndDrag().

◆ OnMotion()

void CWindowManager::OnMotion ( wxMouseEvent & evt )

Definition at line 1105 of file window_manager.cpp.

References CDockManager::eDrop, m_IsDragging, x_OnDrag(), and x_OnEndDrag().

◆ OnMouseCaptureLost()

void CWindowManager::OnMouseCaptureLost ( wxMouseCaptureLostEvent & event )

Definition at line 1136 of file window_manager.cpp.

References CDockManager::eCancel, m_IsDragging, and x_OnEndDrag().

◆ OnMoveToTopLevel()

void CWindowManager::OnMoveToTopLevel ( CEvent * evt )

◆ OnPostCommand()

void CWindowManager::OnPostCommand ( CEvent * evt )

handles an internal command posted to itself

Definition at line 831 of file window_manager.cpp.

References _ASSERT, client, cmd, eCmdCloseDockPanel, eCmdMoveToMainTab, eCmdWindowFloat, eCmdWindowMinimize, eCmdWindowRestore, CWindowManagerEvent::GetClient(), CWindowManagerEvent::GetCmd(), and x_HandlePanelCommand().

◆ OnSetClientColor()

bool CWindowManager::OnSetClientColor ( CDockPanel & panel )

Definition at line 417 of file window_manager.cpp.

References client, color, CDockPanel::GetClient(), and NcbiChooseColor().

Referenced by OnCaptionPanelCommand().

◆ OnShowWindowsDlg()

void CWindowManager::OnShowWindowsDlg ( wxCommandEvent & event )

Definition at line 629 of file window_manager.cpp.

References CWindowsDlg::Create(), m_RegPath, CGuiRegistryUtil::MakeKey(), CDialog::SetRegistryPath(), and CWindowsDlg::SetWindowManager().

Referenced by CMinPanelContainer::OnShowWindowsDlg().

◆ OnUpdateWindowCommand()

void CWindowManager::OnUpdateWindowCommand ( wxUpdateUIEvent & event )

Definition at line 864 of file window_manager.cpp.

References client, GetActiveClient(), and OnUpdateWindowCommand_Client().

◆ OnUpdateWindowCommand_Client()

void CWindowManager::OnUpdateWindowCommand_Client	(	wxUpdateUIEvent &	event,
		IWMClient *	client
	)

Definition at line 871 of file window_manager.cpp.

References _ASSERT, client, eCmdCloseDockPanel, eCmdMoveToMainTab, eCmdWindowFloat, eCmdWindowMinimize, eCmdWindowRestore, CDockManager::IsFloating(), CDockManager::IsInMainTab(), CDockManager::IsMinimized(), and m_DockManager.

Referenced by CMinPanelContainer::OnUpdateWindowCommand(), and OnUpdateWindowCommand().

◆ OnWindowCommand()

void CWindowManager::OnWindowCommand ( wxCommandEvent & event )

Definition at line 855 of file window_manager.cpp.

References client, GetActiveClient(), and x_HandlePanelCommand().

◆ ProcessEvent()

bool CWindowManager::ProcessEvent ( wxEvent & event )

virtual

Definition at line 1016 of file window_manager.cpp.

References _ASSERT, client, GetActiveClient(), and wxEVT_COMMAND_MENU_SELECTED.

Referenced by CWindowManagerService::OnCommandEvent().

◆ RaiseFloatingWindowsInZOrder() [1/2]

void CWindowManager::RaiseFloatingWindowsInZOrder ( )

Definition at line 563 of file window_manager.cpp.

References m_DockManager, and CDockManager::RaiseFloatingInZOrder().

Referenced by CWindowManagerService::RaiseFloatingWindowsInZOrder().

◆ RaiseFloatingWindowsInZOrder() [2/2]

void CWindowManager::RaiseFloatingWindowsInZOrder ( wxRect r )

Definition at line 568 of file window_manager.cpp.

References m_DockManager, r(), and CDockManager::RaiseFloatingInZOrder().

◆ RefreshClient()

void CWindowManager::RefreshClient ( IWMClient & client )

Definition at line 975 of file window_manager.cpp.

References client, IsRegistered(), CDockNotebook::RefreshPageByWindow(), and CDockPanel::UpdateCaption().

Referenced by AddClient(), and CWindowManagerService::RefreshClient().

◆ RegisterActiveClient()

void CWindowManager::RegisterActiveClient ( IWMClient & client )

Definition at line 544 of file window_manager.cpp.

References client, and m_WindowToClient.

Referenced by CWindowManagerService::RegisterActiveClient(), and x_RegisterClient().

◆ RegisterImageAliases()

void CWindowManager::RegisterImageAliases ( wxFileArtProvider & provider )

static

registers graphical resources used by Window Manager

Definition at line 216 of file window_manager.cpp.

References wxFileArtProvider::RegisterFileAlias(), and wxT.

Referenced by CWindowManagerService::InitService().

◆ Restore()

void CWindowManager::Restore ( IWMClient & client )

Definition at line 342 of file window_manager.cpp.

References client, m_DockManager, and CDockManager::Restore().

Referenced by CWindowsDlg::OnRestoreClick().

◆ SaveLayout()

objects::CUser_object * CWindowManager::SaveLayout ( )

Definition at line 1050 of file window_manager.cpp.

References m_DockManager, and CDockManager::SaveLayout().

Referenced by CWindowManagerService::SaveLayout().

◆ SetAdvisor()

void CWindowManager::SetAdvisor ( IWindowManagerAdvisor * advisor )

virtual

Definition at line 279 of file window_manager.cpp.

References m_Advisor.

Referenced by CWindowManagerService::SetAdvisor().

◆ SetMenuListener()

void CWindowManager::SetMenuListener ( IWindowManagerMenuListener * listener )

virtual

Definition at line 285 of file window_manager.cpp.

References m_MenuListener.

Referenced by CWindowManagerService::InitService(), CWindowManagerService::ShutDownService(), and CWindowManagerService::~CWindowManagerService().

◆ SetRegistryPath()

void CWindowManager::SetRegistryPath ( const string & reg_path )

virtual

Definition at line 232 of file window_manager.cpp.

References m_RegPath.

Referenced by CWindowManagerService::InitService().

◆ UnRegisterActiveClient()

void CWindowManager::UnRegisterActiveClient ( IWMClient & client )

Definition at line 549 of file window_manager.cpp.

References client, map_checker< Container >::erase(), m_ActiveClient, m_Advisor, m_WindowToClient, NULL, IWindowManagerAdvisor::OnActiveClientChanged(), and x_ResetMenuBar().

Referenced by CWindowManagerService::UnRegisterActiveClient(), and x_CloseClient().

◆ x_AddClient()

bool CWindowManager::x_AddClient ( IWMClient & client )

protected

◆ x_CloseClient()

bool CWindowManager::x_CloseClient ( IWMClient & client )

protected

Definition at line 488 of file window_manager.cpp.

References _ASSERT, client, ERR_POST, m_Advisor, m_Clients, IWindowManagerAdvisor::OnClientAboutToClose(), IWindowManagerAdvisor::OnClientClosed(), UnRegisterActiveClient(), and x_RemoveClient().

Referenced by CloseAllClients(), CloseClient(), and CloseClients().

◆ x_GetActiveClientByWindow()

IWMClient * CWindowManager::x_GetActiveClientByWindow ( wxWindow * widget )

protected

Definition at line 953 of file window_manager.cpp.

References map_checker< Container >::end(), map_checker< Container >::find(), CDockPanel::GetClient(), m_WindowToClient, and NULL.

Referenced by OnFocusChanged().

◆ x_GetClientLabelForMenu()

string CWindowManager::x_GetClientLabelForMenu ( IWMClient & client )

protected

Definition at line 369 of file window_manager.cpp.

References client, kMaxClientLabel, and label.

Referenced by x_UpdateWindowsMenu().

◆ x_HandlePanelCommand()

void CWindowManager::x_HandlePanelCommand	(	IWMClient &	client,
		int	cmd
	)

protected

Definition at line 905 of file window_manager.cpp.

References _ASSERT, client, cmd, eCmdCloseDockPanel, eCmdMoveToMainTab, eCmdWindowFloat, eCmdWindowMinimize, eCmdWindowRestore, m_Advisor, m_DockManager, CDockManager::Minimize(), CDockManager::MoveToFloatingFrame(), CDockManager::MoveToMainTab(), IWindowManagerAdvisor::OnCloseClientsRequest(), and CDockManager::Restore().

Referenced by OnPostCommand(), and OnWindowCommand().

◆ x_OnBeginDrag()

void CWindowManager::x_OnBeginDrag ( const wxPoint & mouse_pos )

protectedvirtual

Definition at line 1146 of file window_manager.cpp.

References m_DockManager, m_DragDockPanel, m_IsDragging, and CDockManager::OnBeginDrag().

Referenced by OnDockPanelStartDrag().

◆ x_OnDrag()

void CWindowManager::x_OnDrag ( const wxPoint & mouse_pos )

protectedvirtual

Definition at line 1156 of file window_manager.cpp.

References CDockPanel::FinishDrag(), m_Canceled, m_DockManager, m_DragDockPanel, m_IsDragging, ok, and CDockManager::OnDrag().

Referenced by OnMotion().

◆ x_OnEndDrag()

void CWindowManager::x_OnEndDrag	(	const wxPoint &	mouse_pos,
		CDockManager::EDragResult	result
	)

protectedvirtual

Definition at line 1178 of file window_manager.cpp.

References CDockPanel::FinishDrag(), m_DockManager, m_DragDockPanel, m_IsDragging, CDockManager::OnEndDrag(), and result.

Referenced by OnLeftUp(), OnMotion(), and OnMouseCaptureLost().

◆ x_RegisterClient()

bool CWindowManager::x_RegisterClient ( IWMClient & client )

protected

Definition at line 644 of file window_manager.cpp.

References _ASSERT, client, IsRegistered(), m_Clients, and RegisterActiveClient().

Referenced by AddClient().

◆ x_RemoveClient()

void CWindowManager::x_RemoveClient ( IWMClient & client )

protected

Definition at line 443 of file window_manager.cpp.

References client, m_DockManager, CDockManager::Remove(), and CEventHandler::RemoveListener().

Referenced by x_CloseClient().

◆ x_ResetMenuBar()

void CWindowManager::x_ResetMenuBar ( )

protectedvirtual

Definition at line 1078 of file window_manager.cpp.

References m_Menu, m_MenuListener, and IWindowManagerMenuListener::UpdateMenuBar().

Referenced by AddClient(), ApplyLayout(), CloseAllClients(), CloseClient(), CloseClients(), LoadLayout(), OnFocusChanged(), and UnRegisterActiveClient().

◆ x_UpdateActiveClient()

void CWindowManager::x_UpdateActiveClient ( )

protectedvirtual

Definition at line 817 of file window_manager.cpp.

References OnFocusChanged().

◆ x_UpdateListener()

void CWindowManager::x_UpdateListener ( IWMClient & client )

protected

Definition at line 658 of file window_manager.cpp.

References client, CWindowManagerEvent::eClientChanged, and CEventHandler::Send().

◆ x_UpdateWindowsMenu()

void CWindowManager::x_UpdateWindowsMenu ( wxMenu & root_menu )

protectedvirtual

Definition at line 732 of file window_manager.cpp.

References map_checker< Container >::clear(), client, cmd, eCmdWindowLast, eCmdWindowXXXX, FindSubItem(), GenerateWinItemPrefix(), ITERATE, kMaxRecentItems, m_Clients, m_CmdToWindow, NULL, ToWxString(), wxID_ANY, wxT, and x_GetClientLabelForMenu().

Member Data Documentation

◆ m_ActiveClient

IWMClient* CWindowManager::m_ActiveClient

protected

belonging to focused IWMClient

Definition at line 283 of file window_manager.hpp.

Referenced by GetActiveClient(), OnFocusChanged(), and UnRegisterActiveClient().

◆ m_Advisor

IWindowManagerAdvisor* CWindowManager::m_Advisor

protected

Advisor is an external object that wants to customize the behavior of Window Manager by providing a callback interface.

Definition at line 260 of file window_manager.hpp.

Referenced by GetNewFloatingFrameTitle(), OnCaptionPanelCommand(), OnCloseClientsRequestEvent(), OnFocusChanged(), SetAdvisor(), UnRegisterActiveClient(), x_CloseClient(), and x_HandlePanelCommand().

◆ m_AuiManager

wxAuiManager CWindowManager::m_AuiManager

protected

wxAuiManager is required for CNotebook

Definition at line 268 of file window_manager.hpp.

Referenced by AddToolBar(), Create(), DeleteToolBar(), HasToolBar(), and ~CWindowManager().

◆ m_Canceled

bool CWindowManager::m_Canceled

protected

Definition at line 294 of file window_manager.hpp.

Referenced by x_OnDrag().

◆ m_ClickPoint

wxPoint CWindowManager::m_ClickPoint

protected

Definition at line 293 of file window_manager.hpp.

Referenced by OnDockPanelStartDrag().

◆ m_Clients

TClients CWindowManager::m_Clients

protected

the collection of registered Client

Definition at line 277 of file window_manager.hpp.

Referenced by CloseAllClients(), GetAllClients(), IsRegistered(), x_CloseClient(), x_RegisterClient(), and x_UpdateWindowsMenu().

◆ m_CmdToWindow

TCmdToWindowMap CWindowManager::m_CmdToWindow

protected

Definition at line 286 of file window_manager.hpp.

Referenced by OnActivateWindow(), and x_UpdateWindowsMenu().

◆ m_DockManager

CDockManager* CWindowManager::m_DockManager

protected

the Docking Manager associated with this Window Manager

Definition at line 274 of file window_manager.hpp.

Referenced by ActivateClients(), AddClient(), ApplyLayout(), Create(), GetDockManager(), IsFloating(), IsInMainTab(), IsMinimized(), LoadLayout(), Minimize(), MoveToFloatingFrame(), MoveToMainTab(), OnCaptionPanelCommand(), OnUpdateWindowCommand_Client(), RaiseFloatingWindowsInZOrder(), Restore(), SaveLayout(), x_HandlePanelCommand(), x_OnBeginDrag(), x_OnDrag(), x_OnEndDrag(), x_RemoveClient(), and ~CWindowManager().

◆ m_DragDockPanel

CDockPanel* CWindowManager::m_DragDockPanel

protected

Definition at line 292 of file window_manager.hpp.

Referenced by OnDockPanelStartDrag(), x_OnBeginDrag(), x_OnDrag(), and x_OnEndDrag().

◆ m_FrameWindow

wxFrame* CWindowManager::m_FrameWindow

protected

main frame window hosting window manager

Definition at line 265 of file window_manager.hpp.

Referenced by Create(), GetFrameWindow(), and GetMainWindow().

◆ m_IsDragging

bool CWindowManager::m_IsDragging = false

staticprotected

Definition at line 296 of file window_manager.hpp.

Referenced by IsDragging(), OnDockPanelStartDrag(), OnLeftUp(), OnMotion(), OnMouseCaptureLost(), x_OnBeginDrag(), x_OnDrag(), and x_OnEndDrag().

◆ m_Menu

unique_ptr<wxMenu> CWindowManager::m_Menu

protected

Definition at line 289 of file window_manager.hpp.

Referenced by x_ResetMenuBar().

◆ m_MenuListener

IWindowManagerMenuListener* CWindowManager::m_MenuListener

protected

Definition at line 262 of file window_manager.hpp.

Referenced by SetMenuListener(), and x_ResetMenuBar().

◆ m_RegPath

string CWindowManager::m_RegPath

protected

Definition at line 271 of file window_manager.hpp.

Referenced by OnShowWindowsDlg(), and SetRegistryPath().

◆ m_WindowToClient

TWindowToClientMap CWindowManager::m_WindowToClient

protected

index wxWindow -> IWMClient

Definition at line 280 of file window_manager.hpp.

Referenced by RegisterActiveClient(), UnRegisterActiveClient(), and x_GetActiveClientByWindow().

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

include/gui/widgets/wx/window_manager.hpp
src/gui/widgets/wx/window_manager.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Types

Client manipulation routines

Detailed Description

Member Typedef Documentation

◆ TClients

◆ TCmdToWindowMap

◆ TEvent

◆ TFrame

◆ TParent

◆ TWindowToClientMap

Constructor & Destructor Documentation

◆ CWindowManager()

◆ ~CWindowManager()

Member Function Documentation

◆ ActivateClient()

◆ ActivateClients()

◆ AddClient()

◆ AddToolBar()

◆ ApplyLayout()

◆ CloseAllClients()

◆ CloseClient()

◆ CloseClients()

◆ Create()

◆ DECLARE_EVENT_MAP()

◆ DECLARE_EVENT_TABLE()

◆ DeleteToolBar()

◆ Dispatch()

◆ GetActiveClient()

◆ GetAllClients()

◆ GetDockManager()

◆ GetFrameWindow()

◆ GetMainWindow()

◆ GetMenu()

◆ GetNewFloatingFrameTitle()

◆ HasToolBar()

◆ IsDragging()

◆ IsFloating()

◆ IsInMainTab()

◆ IsMinimized()

◆ IsRegistered()

◆ LoadLayout()

◆ Minimize()

◆ MoveToFloatingFrame()

◆ MoveToMainTab()

◆ OnActivateWindow()

◆ OnCaptionPanelCommand()

◆ OnCloseClientsRequest()

◆ OnCloseClientsRequestEvent()

◆ OnDockPanelStartDrag()

◆ OnFocusChanged()

◆ OnLeftUp()

◆ OnMotion()

◆ OnMouseCaptureLost()

◆ OnMoveToTopLevel()

◆ OnPostCommand()

◆ OnSetClientColor()

◆ OnShowWindowsDlg()

◆ OnUpdateWindowCommand()

◆ OnUpdateWindowCommand_Client()

◆ OnWindowCommand()

◆ ProcessEvent()

◆ RaiseFloatingWindowsInZOrder() [1/2]

◆ RaiseFloatingWindowsInZOrder() [2/2]

◆ RefreshClient()

◆ RegisterActiveClient()

◆ RegisterImageAliases()

◆ Restore()

◆ SaveLayout()

◆ SetAdvisor()

◆ SetMenuListener()

◆ SetRegistryPath()

◆ UnRegisterActiveClient()

◆ x_AddClient()