CDataMiningView Class Reference

Search Toolkit Book for CDataMiningView

#include <data_mining_view.hpp>

Inheritance diagram for CDataMiningView:

[legend]Collaboration diagram for CDataMiningView:

[legend]List of all members.

---

Detailed Description

CDataMiningView.

Definition at line 68 of file data_mining_view.hpp.

Public Member Functions
	CDataMiningView ()
virtual	~CDataMiningView ()
virtual void	BroadcastVisibleRange ()
virtual void	SelectToolByName (const string &name)
void	OnWidgetSelChanged (CEvent *evt)
	TODO these mehods must be protected.
void	x_UpdateSelectionScope ()
void	x_UpdateToolCombo (bool update_list)
void	x_UpdateLocation (TConstScopedObjects &cso)
IView
virtual const CViewTypeDescriptor &	GetTypeDescriptor () const
	return an object providing meta information about thei view type
virtual void	SetWorkbench (IWorkbench *workbench)
	connect / disconnect this view with / from Workbench
virtual void	CreateViewWindow (wxWindow *parent)
	create Window corresponding to the view
virtual void	DestroyViewWindow ()
	destroy Window corresponding to the view
IWMClient interface implementation
virtual wxWindow *	GetWindow ()
	returns a pointer to the wxWindow representing the client
virtual wxEvtHandler *	GetCommandHandler ()
	returns a pointer to the command handler (for menu commands and updates)
virtual string	GetClientLabel (IWMClient::ELabel ltype) const
	returns the client label (name) to be displayed in UI
virtual string	GetIconAlias () const
	returns an icon alias that can be used to retrieve the client's icon
virtual const CRgbaColor *	GetColor () const
	returns a color associated with the client, n/a if NULL
virtual void	SetColor (const CRgbaColor &color)
	returns a color associated with the client
virtual const wxMenu *	GetMenu ()
	returns menu that can be merged with main menu of an application
virtual void	UpdateMenu (wxMenu &root_menu)
virtual CFingerprint	GetFingerprint () const
	returns a fingerprint identifying the client
IRegSettings interface implementation
virtual void	SetRegistryPath (const string &reg_path)
virtual void	LoadSettings ()
virtual void	SaveSettings () const
IObserver interface implementation
virtual void	OnUpdate (IObserverUpdate &update)
ISelectionClient interface implementation
virtual void	GetSelection (TConstScopedObjects &objects) const
	shall return data objects representing selected things, return one data object for every selected thing.
virtual void	SetSelectionService (ISelectionService *service)
virtual string	GetSelClientLabel ()
	returns a string identifying the client in UI
virtual void	GetSelection (CSelectionEvent &evt) const
	get selection for broadcasting
virtual void	SetSelection (CSelectionEvent &evt)
	set broadcasted selection
virtual void	GetMainObject (TConstScopedObjects &objects) const
	Adds the main data objects represented by the client to "objects".
virtual CRef< objects::CScope >	GetScope () const
	if all selected elements belong to the same scope - return it, otherwise return NULL
IVisibleRangeClient interface implementation
virtual void	OnVisibleRangeChanged (const CVisibleRange &vrange, IVisibleRangeClient *source)
Protected Attributes
IWorkbench *	m_Workbench
CDataMiningService *	m_Service
CSelectionService *	m_Selection
CProjectService *	m_Project
CRef< objects::CScope >	m_CurrSelScope
objects::CSeq_loc::TRange	m_Range
bool	m_CurrSelScopeDirty
string	m_RegPath
bool	m_Broadcasting
CDataMiningPanel *	m_Panel
Static Protected Attributes
static CViewTypeDescriptor	m_TypeDescr
Private Member Functions
	DECLARE_EVENT_MAP ()
Friends
class	CDataMiningViewFactory

---

Constructor & Destructor Documentation

CDataMiningView::CDataMiningView (   )

virtual CDataMiningView::~CDataMiningView (   )  [virtual]

---

Member Function Documentation

virtual void CDataMiningView::BroadcastVisibleRange (   )  [virtual]

virtual void CDataMiningView::CreateViewWindow (  wxWindow *  parent  )  [virtual]

create Window corresponding to the view Implements IView.

CDataMiningView::DECLARE_EVENT_MAP (   )  [private]

virtual void CDataMiningView::DestroyViewWindow (   )  [virtual]

destroy Window corresponding to the view Implements IView.

virtual string CDataMiningView::GetClientLabel (  IWMClient::ELabel  ltype  )  const [virtual]

returns the client label (name) to be displayed in UI Implements IWMClient.

virtual const CRgbaColor* CDataMiningView::GetColor (   )  const [virtual]

returns a color associated with the client, n/a if NULL Implements IWMClient.

virtual wxEvtHandler* CDataMiningView::GetCommandHandler (   )  [inline, virtual]

returns a pointer to the command handler (for menu commands and updates) Implements IWMClient. Definition at line 95 of file data_mining_view.hpp. References GetWindow().

virtual CFingerprint CDataMiningView::GetFingerprint (   )  const [virtual]

returns a fingerprint identifying the client Implements IWMClient.

virtual string CDataMiningView::GetIconAlias (   )  const [virtual]

returns an icon alias that can be used to retrieve the client's icon Implements IWMClient.

virtual void CDataMiningView::GetMainObject (  TConstScopedObjects &  objects  )  const [virtual]

Adds the main data objects represented by the client to "objects". Implementation shall not clear the container as it can be used for accumulating objects. Implements ISelectionClient.

virtual const wxMenu* CDataMiningView::GetMenu (   )  [virtual]

returns menu that can be merged with main menu of an application Implements IWMClient.

virtual CRef<objects::CScope> CDataMiningView::GetScope (   )  const [virtual]

if all selected elements belong to the same scope - return it, otherwise return NULL Implements ISelectionClient.

virtual string CDataMiningView::GetSelClientLabel (   )  [virtual]

returns a string identifying the client in UI Implements ISelectionClient.

virtual void CDataMiningView::GetSelection (  CSelectionEvent &  evt  )  const [virtual]

get selection for broadcasting Implements ISelectionClient.

virtual void CDataMiningView::GetSelection (  TConstScopedObjects &  objects  )  const [virtual]

shall return data objects representing selected things, return one data object for every selected thing. Implementation shall not clear the container as it can be used for accumulating objects. Implements ISelectionClient.

virtual const CViewTypeDescriptor& CDataMiningView::GetTypeDescriptor (   )  const [virtual]

return an object providing meta information about thei view type Implements IView.

virtual wxWindow* CDataMiningView::GetWindow (   )  [virtual]

returns a pointer to the wxWindow representing the client Implements IWMClient. Referenced by GetCommandHandler().

virtual void CDataMiningView::LoadSettings (   )  [virtual]

Implements IRegSettings.

virtual void CDataMiningView::OnUpdate (  IObserverUpdate &  update  )  [virtual]

Implements IObserver.

virtual void CDataMiningView::OnVisibleRangeChanged (  const CVisibleRange &  vrange, IVisibleRangeClient *  source )  [virtual]

Implements IVisibleRangeClient.

void CDataMiningView::OnWidgetSelChanged (  CEvent *  evt  )

TODO these mehods must be protected.

virtual void CDataMiningView::SaveSettings (   )  const [virtual]

Implements IRegSettings.

virtual void CDataMiningView::SelectToolByName (  const string &  name  )  [virtual]

Referenced by CNetBLASTUIDataSource::OnExplore().

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

returns a color associated with the client Implements IWMClient.

virtual void CDataMiningView::SetRegistryPath (  const string &  reg_path  )  [virtual]

Implements IRegSettings.

virtual void CDataMiningView::SetSelection (  CSelectionEvent &  evt  )  [virtual]

set broadcasted selection Implements ISelectionClient.

virtual void CDataMiningView::SetSelectionService (  ISelectionService *  service  )  [virtual]

Implements ISelectionClient.

virtual void CDataMiningView::SetWorkbench (  IWorkbench *  workbench  )  [virtual]

connect / disconnect this view with / from Workbench Implements IView.

virtual void CDataMiningView::UpdateMenu (  wxMenu &  root_menu  )  [virtual]

Implements IWMClient.

void CDataMiningView::x_UpdateLocation (  TConstScopedObjects &  cso  )

void CDataMiningView::x_UpdateSelectionScope (   )

void CDataMiningView::x_UpdateToolCombo (  bool  update_list  )

---

Friends And Related Function Documentation

friend class CDataMiningViewFactory [friend]

Definition at line 78 of file data_mining_view.hpp.

---

Member Data Documentation

bool CDataMiningView::m_Broadcasting [protected]

Definition at line 164 of file data_mining_view.hpp.

CRef<objects::CScope> CDataMiningView::m_CurrSelScope [protected]

Definition at line 157 of file data_mining_view.hpp.

bool CDataMiningView::m_CurrSelScopeDirty [protected]

Definition at line 160 of file data_mining_view.hpp.

CDataMiningPanel* CDataMiningView::m_Panel [protected]

Definition at line 166 of file data_mining_view.hpp.

CProjectService* CDataMiningView::m_Project [protected]

Definition at line 155 of file data_mining_view.hpp.

objects::CSeq_loc::TRange CDataMiningView::m_Range [protected]

Definition at line 158 of file data_mining_view.hpp.

string CDataMiningView::m_RegPath [protected]

Definition at line 162 of file data_mining_view.hpp.

CSelectionService* CDataMiningView::m_Selection [protected]

Definition at line 154 of file data_mining_view.hpp.

CDataMiningService* CDataMiningView::m_Service [protected]

Definition at line 153 of file data_mining_view.hpp.

CViewTypeDescriptor CDataMiningView::m_TypeDescr [static, protected]

Definition at line 150 of file data_mining_view.hpp.

IWorkbench* CDataMiningView::m_Workbench [protected]

Definition at line 152 of file data_mining_view.hpp.

---

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

• include/gui/core/data_mining_view.hpp

---