NCBI C++ ToolKit
Public Types | Public Member Functions | Protected Member Functions | List of all members
IWindowManagerAdvisor Class Referenceabstract

Search Toolkit Book for IWindowManagerAdvisor

IWindowManagerAdvisor. More...

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

+ Inheritance diagram for IWindowManagerAdvisor:

Public Types

typedef vector< IWMClient * > TClients
 

Public Member Functions

virtual void OnCloseClientsRequest (const TClients &clients)=0
 indicates that user requested closing the following clients (by pressing a "close" button, selecting a command etc.) Advisor must take necessary actions to close the clients (if needed). More...
 
virtual void OnClientAboutToClose (IWMClient &client)=0
 called before removing the client More...
 
virtual void OnClientClosed (IWMClient &client)=0
 called after the client has been removed More...
 
virtual void OnActiveClientChanged (IWMClient *new_active)=0
 called when Active Client is changed (i.e. focus goes into another client) More...
 
virtual string GetFloatingFrameTitle (int index)=0
 returns the title for the floating frames created by the Window Manager More...
 

Protected Member Functions

virtual ~IWindowManagerAdvisor ()
 

Detailed Description

IWindowManagerAdvisor.

This interface represents the context in which Window Manager operates, Window Manager delegates some of the functions / decisions to the Advisor. These functions should be implemented by the application to allow the application components to control the life cycle of IWMClients managed by Window Manager.

Definition at line 71 of file window_manager.hpp.

Member Typedef Documentation

◆ TClients

Definition at line 74 of file window_manager.hpp.

Constructor & Destructor Documentation

◆ ~IWindowManagerAdvisor()

virtual IWindowManagerAdvisor::~IWindowManagerAdvisor ( )
inlineprotectedvirtual

Definition at line 94 of file window_manager.hpp.

Member Function Documentation

◆ GetFloatingFrameTitle()

virtual string IWindowManagerAdvisor::GetFloatingFrameTitle ( int  index)
pure virtual

returns the title for the floating frames created by the Window Manager

Implemented in CFrameworkDemoGUI.

Referenced by CWindowManager::GetNewFloatingFrameTitle().

◆ OnActiveClientChanged()

virtual void IWindowManagerAdvisor::OnActiveClientChanged ( IWMClient new_active)
pure virtual

called when Active Client is changed (i.e. focus goes into another client)

Implemented in CFrameworkDemoGUI.

Referenced by CWindowManager::OnFocusChanged(), and CWindowManager::UnRegisterActiveClient().

◆ OnClientAboutToClose()

virtual void IWindowManagerAdvisor::OnClientAboutToClose ( IWMClient client)
pure virtual

called before removing the client

Implemented in CFrameworkDemoGUI.

Referenced by CWindowManager::x_CloseClient().

◆ OnClientClosed()

virtual void IWindowManagerAdvisor::OnClientClosed ( IWMClient client)
pure virtual

called after the client has been removed

Implemented in CFrameworkDemoGUI.

Referenced by CWindowManager::x_CloseClient().

◆ OnCloseClientsRequest()

virtual void IWindowManagerAdvisor::OnCloseClientsRequest ( const TClients clients)
pure virtual

indicates that user requested closing the following clients (by pressing a "close" button, selecting a command etc.) Advisor must take necessary actions to close the clients (if needed).

Implemented in CFrameworkDemoGUI.

Referenced by CWindowManager::OnCaptionPanelCommand(), CWindowManager::OnCloseClientsRequestEvent(), and CWindowManager::x_HandlePanelCommand().


The documentation for this class was generated from the following file:
Modified on Sun Jun 16 04:37:51 2024 by modify_doxy.py rev. 669887