IWMClient Class Reference

Search Toolkit Book for IWMClient

#include <wm_client.hpp>

Inheritance diagram for IWMClient:

[legend]List of all members.

---

Detailed Description

IWClient - abstract Window Manager client.

Definition at line 47 of file wm_client.hpp.

Public Types
enum	ELabel { eContent, eDetailed, eDefault = eDetailed }
	Different flavors of label types for different GUI aspects. More...
Public Member Functions
virtual wxWindow *	GetWindow ()=0
	returns a pointer to the wxWindow representing the client
virtual wxEvtHandler *	GetCommandHandler ()=0
	returns a pointer to the command handler (for menu commands and updates)
virtual string	GetClientLabel (IWMClient::ELabel ltype=IWMClient::eDefault) const =0
	returns the client label (name) to be displayed in UI
virtual string	GetIconAlias () const =0
	returns an icon alias that can be used to retrieve the client's icon
virtual const CRgbaColor *	GetColor () const =0
	returns a color associated with the client, n/a if NULL
virtual void	SetColor (const CRgbaColor &color)=0
	returns a color associated with the client
virtual const wxMenu *	GetMenu ()=0
	returns menu that can be merged with main menu of an application
virtual void	UpdateMenu (wxMenu &root_menu)=0
virtual CFingerprint	GetFingerprint () const =0
	returns a fingerprint identifying the client
virtual	~IWMClient ()
Classes
class	CFingerprint
	CFingerprint identifies an instance of IWMClient and is used for labeling layout positions. More...

---

Member Enumeration Documentation

enum IWMClient::ELabel

Different flavors of label types for different GUI aspects. Enumerator: eContent  Short name with content. eDetailed  Detailed name. eDefault  Definition at line 75 of file wm_client.hpp.

---

Constructor & Destructor Documentation

virtual IWMClient::~IWMClient (   )  [inline, virtual]

Definition at line 108 of file wm_client.hpp.

---

Member Function Documentation

virtual string IWMClient::GetClientLabel (  IWMClient::ELabel  ltype = IWMClient::eDefault  )  const [pure virtual]

returns the client label (name) to be displayed in UI Implemented in CDataMiningView, CProjectTreeView, CProjectViewBase, CSelectionView, CwxGLTestView, CDiagConsoleView, CEventView, CTaskView, CClockPanelWMClient, CTextWMClient, CHTMLWMClient, CTreeWMClient, and CGLTestWMClient. Referenced by CMinPanelContainer::OnContextMenu(), CGBDocument::x_AssignViewIndex(), CWindowManager::x_GetClientLabelForMenu(), CDockNotebook::x_GetPageNameByWindow(), CDockContainer::x_GetPageNameByWindow(), and CAppExplorerService::x_GetViewLabel().

virtual const CRgbaColor* IWMClient::GetColor (   )  const [pure virtual]

returns a color associated with the client, n/a if NULL Implemented in CDataMiningView, CProjectTreeView, CProjectViewBase, CSelectionView, CwxGLTestView, CDiagConsoleView, CEventView, CTaskView, CClockPanelWMClient, CTextWMClient, CHTMLWMClient, CTreeWMClient, and CGLTestWMClient. Referenced by CDockManager::GetDockPanelMenu(), and CWindowManager::OnSetClientColor().

virtual wxEvtHandler* IWMClient::GetCommandHandler (   )  [pure virtual]

returns a pointer to the command handler (for menu commands and updates) Implemented in CDataMiningView, CProjectTreeView, CProjectViewBase, CSelectionView, CwxGLTestView, CDiagConsoleView, CEventView, CTaskView, CSeqTextView, CTextView, CClockPanelWMClient, and CGLTestWMClient. Referenced by CDockPanel::ProcessEvent().

virtual CFingerprint IWMClient::GetFingerprint (   )  const [pure virtual]

returns a fingerprint identifying the client Implemented in CDataMiningView, CProjectTreeView, CProjectViewBase, CSelectionView, CwxGLTestView, CDiagConsoleView, CEventView, CTaskView, CClockPanelWMClient, CTextWMClient, CHTMLWMClient, CTreeWMClient, and CGLTestWMClient. Referenced by CDockContainer::AddClientToDefaultLocation(), CDockManager::AddToDefaultLocation(), FNodeHasFingerprint::operator()(), FCountWindowsWithFingerprint::operator()(), FNodeFingerprintEquals::operator()(), CDockContainer::x_DestroyNode(), CDockContainer::x_Full_RemoveNode(), and CDockContainer::x_ToUserObject().

virtual string IWMClient::GetIconAlias (   )  const [pure virtual]

returns an icon alias that can be used to retrieve the client's icon Implemented in CDataMiningView, CProjectTreeView, CProjectViewBase, CSelectionView, CwxGLTestView, CDiagConsoleView, CEventView, CTaskView, CClockPanelWMClient, and CGLTestWMClient. Referenced by CDockPanel::x_DrawClientElements(), CMinPanelContainer::x_DrawItem(), and CMinPanelContainer::x_MeasureItem().

virtual const wxMenu* IWMClient::GetMenu (   )  [pure virtual]

returns menu that can be merged with main menu of an application Implemented in CDataMiningView, CProjectTreeView, CProjectViewBase, CSelectionView, CwxGLTestView, CDiagConsoleView, CEventView, CTaskView, CViewGraphic, CClockPanelWMClient, CTextWMClient, CHTMLWMClient, CTreeWMClient, and CGLTestWMClient.

virtual wxWindow* IWMClient::GetWindow (   )  [pure virtual]

returns a pointer to the wxWindow representing the client Implemented in CDataMiningView, CProjectTreeView, CProjectViewBase, CSelectionView, CwxGLTestView, CDiagConsoleView, CEventView, CTaskView, CAlignSpanView, CAnnotCompareView, CCrossAlignView, CDotMatrixView, CMPCrossAlignView, CMultiAlignView, CPhyTreeView, CSeqTextView, CTextView, CFeatTableView, CViewGraphic, CSnpTableView, CClockPanelWMClient, CTextWMClient, CHTMLWMClient, CTreeWMClient, and CGLTestWMClient. Referenced by CWindowManager::AddClientInTab(), CDockContainer::AddClientToCentralPane(), CDockContainer::AddClientToDefaultLocation(), CDockManager::Minimize(), CDockManager::MoveToFloatingFrame(), CDockManager::MoveToMainTab(), CDockPanel::OnLeftDown(), CWindowManager::RefreshClient(), CDockManager::Remove(), CDockPanel::RemoveClient(), CDockManager::Restore(), CDockContainer::x_AddClientToHiddenPos(), CDockContainer::x_DockPanelForClient(), CDockManager::x_GetDockPanel(), CDockPanel::x_SetClient(), and CWindowManager::x_UnRegisterClient().

virtual void IWMClient::SetColor (  const CRgbaColor &  color  )  [pure virtual]

returns a color associated with the client Implemented in CDataMiningView, CProjectTreeView, CProjectViewBase, CSelectionView, CwxGLTestView, CDiagConsoleView, CEventView, CTaskView, CClockPanelWMClient, CTextWMClient, CHTMLWMClient, CTreeWMClient, and CGLTestWMClient. Referenced by CWindowManager::OnSetClientColor().

virtual void IWMClient::UpdateMenu (  wxMenu &  root_menu  )  [pure virtual]

Implemented in CDataMiningView, CProjectTreeView, CProjectViewBase, CSelectionView, CwxGLTestView, CDiagConsoleView, CEventView, CTaskView, CClockPanelWMClient, CTextWMClient, CHTMLWMClient, CTreeWMClient, and CGLTestWMClient.

---

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

• include/gui/widgets/wx/wm_client.hpp

---