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 client of Window Manager.

Definition at line 45 of file wm_client.hpp.

Public Member Functions
virtual	~IWMClient ()
virtual string	GetClientLabel ()=0
	returns a label that represents the client in UI
virtual const CRgbaColor *	GetColor () const =0
	returns a color associated with the client, NULL is n/a
virtual void	SetColor (const CRgbaColor &color)=0
	returns a color associated with the client
virtual CFLTKImageHandle	GetIcon () const =0
virtual const CMenuItem *	GetMenu ()=0
	returns menu that can be merged with main menu of an application
virtual void	UpdateMenu (CMenuItem &root)=0
virtual Fl_Widget *	GetWidget ()=0
	return pointer to widget hosting IWMClient

---

Constructor & Destructor Documentation

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

Definition at line 48 of file wm_client.hpp.

---

Member Function Documentation

virtual string IWMClient::GetClientLabel (   )  [pure virtual]

returns a label that represents the client in UI Implemented in IView, CViewBase, CDataMiningView, CWMLogConsole, CHomePageView, CSelectionView, CGBenchToolMonitor, CProjectTree, CFLTestClient, and CGLTestClient. Referenced by CWMCaptionPanel::x_DrawTitle(), CWindowManager::x_GetClientLabelForMenu(), CWindowManager::x_InsertClient(), and CWindowManager::x_PutClientInFrame().

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

returns a color associated with the client, NULL is n/a Implemented in IView, CViewBase, CSystemView, CFLTestClient, and CGLTestClient. Referenced by CWindowManager::OnCaptionPanelUpdateCommand(), CWindowManager::OnSetClientColor(), CWMCaptionPanel::x_DrawColorBox(), and CWMCaptionPanel::x_IsColorBoxVisible().

virtual CFLTKImageHandle IWMClient::GetIcon (   )  const [pure virtual]

Implemented in IView, CViewBase, CDataMiningView, CWMLogConsole, CHomePageView, CSelectionView, CGBenchToolMonitor, CProjectTree, CFLTestClient, and CGLTestClient. Referenced by CWMCaptionPanel::draw(), and CWMTabControl::Insert().

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

returns menu that can be merged with main menu of an application Implemented in IView, CViewBase, CDataMiningView, CWMLogConsole, CHomePageView, CSelectionView, CGBenchToolMonitor, CProjectTree, CViewAlnSpanTable, CViewCrossAlign, CHitMatrixView, CAlnMultiView, CViewGraphic, CViewPhyloTree, CSnpTablePlugin, CViewFeatTable, CViewSeqTable, CViewSeqText, CFLTestClient, and CGLTestClient. Referenced by CWindowManager::GetMenu().

virtual Fl_Widget* IWMClient::GetWidget (   )  [pure virtual]

return pointer to widget hosting IWMClient Implemented in IView, CViewBase, CDataMiningView, CWMLogConsole, CHomePageView, CSelectionView, CGBenchToolMonitor, CProjectTree, CFLTestClient, and CGLTestClient. Referenced by CWindowManager::ActivateClients(), CWMDockContainer::IsDocked(), CWMCaptionPanel::SetClient(), CWindowManager::x_AddClient(), CWMCaptionPanel::x_DrawClient(), CWindowManager::x_GetCaptionPanelByClient(), CWMCaptionPanel::x_Layout(), CWindowManager::x_MoveInContainer(), CWMCaptionPanel::x_OnMousePushRelease(), CWindowManager::x_PutClientInFrame(), CWindowManager::x_RegisterClient(), and CWindowManager::x_UnRegisterClient().

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

returns a color associated with the client Implemented in IView, CViewBase, CSystemView, CFLTestClient, and CGLTestClient. Referenced by CWindowManager::OnSetClientColor().

virtual void IWMClient::UpdateMenu (  CMenuItem &  root  )  [pure virtual]

Implemented in CViewBase, CDataMiningView, CWMLogConsole, CHomePageView, CSelectionView, CGBenchToolMonitor, CProjectTree, CFLTestClient, and CGLTestClient. Referenced by CWindowManager::UpdateMenu().

---

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

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

---