CDataMiningView Class Reference

Search Toolkit Book for CDataMiningView

CDataMiningView. More...

#include <gui/core/data_mining_view.hpp>

Inheritance diagram for CDataMiningView:

Collaboration diagram for CDataMiningView:

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. More...
void	x_UpdateSelectionScope ()
void	x_UpdateToolCombo (bool update_list)
void	x_UpdateLocation (TConstScopedObjects &cso)
void	x_OnStateChanged (CEvent *)
void	x_OnSelectionEvent (CEvent *)
IView
virtual const CViewTypeDescriptor &	GetTypeDescriptor () const
	return an object providing meta information about thei view type More...
virtual void	SetWorkbench (IWorkbench *workbench)
	connect / disconnect this view with / from Workbench More...
virtual void	CreateViewWindow (wxWindow *parent)
	create Window corresponding to the view More...
virtual void	DestroyViewWindow ()
	destroy Window corresponding to the view More...
IWMClient interface implementation
virtual wxWindow *	GetWindow ()
	returns a pointer to the wxWindow representing the client More...
virtual wxEvtHandler *	GetCommandHandler ()
	returns a pointer to the command handler (for menu commands and updates) More...
virtual string	GetClientLabel (IWMClient::ELabel ltype) const
	returns the client label (name) to be displayed in UI More...
virtual string	GetIconAlias () const
	returns an icon alias that can be used to retrieve the client's icon More...
virtual const CRgbaColor *	GetColor () const
	returns a color associated with the client, n/a if NULL More...
virtual void	SetColor (const CRgbaColor &color)
	returns a color associated with the client More...
virtual const wxMenu *	GetMenu ()
	returns a menu (must be deleted by the caller) menu injections should follow a separator named "Contribs" More...
virtual void	UpdateMenu (wxMenu &root_menu)
virtual CFingerprint	GetFingerprint () const
	returns a fingerprint identifying the client More...
IRegSettings interface implementation
virtual void	SetRegistryPath (const string &reg_path)
virtual void	LoadSettings ()
virtual void	SaveSettings () const
ISelectionClient interface implementation
virtual void	GetSelection (TConstScopedObjects &objects) const
	shall return data objects representing selected things, return one data object for every selected thing. More...
virtual void	SetSelectionService (ISelectionService *service)
virtual string	GetSelClientLabel ()
	returns a string identifying the client in UI More...
virtual void	GetSelection (CSelectionEvent &evt) const
	get selection for broadcasting More...
virtual void	SetSelection (CSelectionEvent &evt)
	set broadcasted selection More...
virtual void	GetMainObject (TConstScopedObjects &objects) const
	Adds the main data objects represented by the client to "objects". More...
virtual void	BroadcastSelection ()
IVisibleRangeClient interface implementation
virtual void	OnVisibleRangeChanged (const CVisibleRange &, IVisibleRangeClient *)
Public Member Functions inherited from CObjectEx
	CObjectEx (void)
virtual	~CObjectEx (void)
Public Member Functions inherited from CObject
	CObject (void)
	Constructor. More...
	CObject (const CObject &src)
	Copy constructor. More...
virtual	~CObject (void)
	Destructor. More...
CObject &	operator= (const CObject &src) THROWS_NONE
	Assignment operator. More...
bool	CanBeDeleted (void) const THROWS_NONE
	Check if object can be deleted. More...
bool	IsAllocatedInPool (void) const THROWS_NONE
	Check if object is allocated in memory pool (not system heap) More...
bool	Referenced (void) const THROWS_NONE
	Check if object is referenced. More...
bool	ReferencedOnlyOnce (void) const THROWS_NONE
	Check if object is referenced only once. More...
void	AddReference (void) const
	Add reference to object. More...
void	RemoveReference (void) const
	Remove reference to object. More...
void	ReleaseReference (void) const
	Remove reference without deleting object. More...
virtual void	DoNotDeleteThisObject (void)
	Mark this object as not allocated in heap – do not delete this object. More...
virtual void	DoDeleteThisObject (void)
	Mark this object as allocated in heap – object can be deleted. More...
void *	operator new (size_t size)
	Define new operator for memory allocation. More...
void *	operator new[] (size_t size)
	Define new[] operator for 'array' memory allocation. More...
void	operator delete (void *ptr)
	Define delete operator for memory deallocation. More...
void	operator delete[] (void *ptr)
	Define delete[] operator for memory deallocation. More...
void *	operator new (size_t size, void *place)
	Define new operator. More...
void	operator delete (void *ptr, void *place)
	Define delete operator. More...
void *	operator new (size_t size, CObjectMemoryPool *place)
	Define new operator using memory pool. More...
void	operator delete (void *ptr, CObjectMemoryPool *place)
	Define delete operator. More...
virtual void	DebugDump (CDebugDumpContext ddc, unsigned int depth) const
	Define method for dumping debug information. More...
Public Member Functions inherited from CDebugDumpable
	CDebugDumpable (void)
virtual	~CDebugDumpable (void)
void	DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const
void	DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const
void	DumpToConsole (void) const
Public Member Functions inherited from CWeakObject
	CWeakObject (void)
virtual	~CWeakObject (void)
CPtrToObjectProxy *	GetPtrProxy (void) const
	Get pointer to proxy object containing pointer to this object. More...
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	Dispatch (CEvent *evt, EDispatch disp_how=eDispatch_Default, int pool_name=ePool_Default)
	Dispatches an event to the listeners (but does not handle it). 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...
Public Member Functions inherited from IView
virtual	~IView ()
Public Member Functions inherited from IWMClient
virtual void	SetFingerprint (const string &)
virtual bool	IsAForm () const
	returns true if client is a Form - wants to be sized to its client area (like a dialog) More...
virtual bool	IsADialog () const
	returns true if client is a non-modal dioalog More...
virtual	~IWMClient ()
Public Member Functions inherited from IMenuContributor
virtual	~IMenuContributor ()
Public Member Functions inherited from IRegSettings
virtual	~IRegSettings ()
Public Member Functions inherited from ISelectionClient
virtual	~ISelectionClient ()
virtual void	GetActiveObjects (TConstScopedObjects &objects) const
virtual void	GetActiveObjects (vector< TConstScopedObjects > &sel)
	Prioritized active objects. More...
Public Member Functions inherited from IVisibleRangeClient
virtual	~IVisibleRangeClient ()

Protected Attributes
IWorkbench *	m_Workbench
CDataMiningService *	m_DataMiningService
CSelectionService *	m_SelectionService
CRef< objects::CScope >	m_CurrSelScope
objects::CSeq_loc::TRange	m_Range
bool	m_CurrSelScopeDirty
string	m_RegPath
CDataMiningPanel *	m_Panel
Protected Attributes inherited from CEventHandler
TPools	m_Pools

Static Protected Attributes
static CViewTypeDescriptor	m_TypeDescr
Static Protected Attributes inherited from CEventHandler
static const SEvtMap	sm_EvtMap

Private Member Functions
	DECLARE_EVENT_MAP ()

Friends
class	CDataMiningViewFactory

Additional Inherited Members
Public Types inherited from CObject
enum	EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern }
	Control filling of newly allocated memory. More...
typedef CObjectCounterLocker	TLockerType
	Default locker type for CRef. More...
typedef atomic< Uint8 >	TCounter
	Counter type is CAtomiCounter. More...
typedef Uint8	TCount
	Alias for value type of counter. More...
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 Types inherited from IWMClient
enum	ELabel { eContent , eTypeAndContent , eDetailed , eDefault = eDetailed }
	Different flavors of label types for different GUI aspects. More...
Static Public Member Functions inherited from CObject
static NCBI_XNCBI_EXPORT void	ThrowNullPointerException (void)
	Define method to throw null pointer exception. More...
static NCBI_XNCBI_EXPORT void	ThrowNullPointerException (const type_info &type)
static EAllocFillMode	GetAllocFillMode (void)
static void	SetAllocFillMode (EAllocFillMode mode)
static void	SetAllocFillMode (const string &value)
	Set mode from configuration parameter value. More...
Static Public Member Functions inherited from CDebugDumpable
static void	EnableDebugDump (bool on)
Static Public Member Functions inherited from CEventHandler
static bool	HandlePostRequest ()
static void	ClearPostQueue ()
	erases all events from the queue More...
static void	DestroyPostQueue ()
Static Public Attributes inherited from CObject
static const TCount	eCounterBitsCanBeDeleted = 1 << 0
	Define possible object states. More...
static const TCount	eCounterBitsInPlainHeap = 1 << 1
	Heap signature was found. More...
static const TCount	eCounterBitsPlaceMask
	Mask for 'in heap' state flags. More...
static const int	eCounterStep = 1 << 2
	Skip over the "in heap" bits. More...
static const TCount	eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2)
	Minimal value for valid objects (reference counter is zero) Must be a single bit value. More...
static const TCount	eCounterStateMask
	Valid object, and object in heap. More...
Protected Member Functions inherited from CObject
virtual void	DeleteThis (void)
	Virtual method "deleting" this object. More...
Protected Member Functions inherited from CWeakObject
void	CleanWeakRefs (void) const
	Method cleaning all CWeakRefs referencing at this moment to the object After calling to this method all existing CWeakRefs referencing to the object will return NULL, so it effectively will be equal to deleting the object. More...
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 Member Functions inherited from IMenuContributor
virtual const SwxMenuItemRec *	GetMenuDef () const
	simpler way to provide a static menu using macros defined earlier in this file More...

Detailed Description

CDataMiningView.

Definition at line 65 of file data_mining_view.hpp.

Constructor & Destructor Documentation

CDataMiningView()

CDataMiningView::CDataMiningView

(

)

~CDataMiningView()

virtual CDataMiningView::~CDataMiningView ( )

virtual

Member Function Documentation

BroadcastSelection()

virtual void CDataMiningView::BroadcastSelection ( )

virtual

Reimplemented from ISelectionClient.

BroadcastVisibleRange()

virtual void CDataMiningView::BroadcastVisibleRange ( )

virtual

CreateViewWindow()

virtual void CDataMiningView::CreateViewWindow ( wxWindow *  parent )

virtual

create Window corresponding to the view

Implements IView.

DECLARE_EVENT_MAP()

CDataMiningView::DECLARE_EVENT_MAP ( )

private

DestroyViewWindow()

virtual void CDataMiningView::DestroyViewWindow ( )

virtual

destroy Window corresponding to the view

Implements IView.

GetClientLabel()

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

virtual

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

Implements IWMClient.

GetColor()

virtual const CRgbaColor* CDataMiningView::GetColor ( ) const

virtual

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

Implements IWMClient.

GetCommandHandler()

virtual wxEvtHandler* CDataMiningView::GetCommandHandler ( )

inlinevirtual

returns a pointer to the command handler (for menu commands and updates)

Implements IWMClient.

Definition at line 91 of file data_mining_view.hpp.

References GetWindow().

GetFingerprint()

virtual CFingerprint CDataMiningView::GetFingerprint ( ) const

virtual

returns a fingerprint identifying the client

Implements IWMClient.

GetIconAlias()

virtual string CDataMiningView::GetIconAlias ( ) const

virtual

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

Implements IWMClient.

GetMainObject()

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.

GetMenu()

virtual const wxMenu* CDataMiningView::GetMenu ( )

virtual

returns a menu (must be deleted by the caller) menu injections should follow a separator named "Contribs"

Reimplemented from IMenuContributor.

GetSelClientLabel()

virtual string CDataMiningView::GetSelClientLabel ( )

virtual

returns a string identifying the client in UI

Implements ISelectionClient.

GetSelection() [1/2]

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

virtual

get selection for broadcasting

Implements ISelectionClient.

GetSelection() [2/2]

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.

GetTypeDescriptor()

virtual const CViewTypeDescriptor& CDataMiningView::GetTypeDescriptor ( ) const

virtual

return an object providing meta information about thei view type

Implements IView.

GetWindow()

virtual wxWindow* CDataMiningView::GetWindow ( )

virtual

returns a pointer to the wxWindow representing the client

Implements IWMClient.

Referenced by GetCommandHandler().

LoadSettings()

virtual void CDataMiningView::LoadSettings ( )

virtual

Implements IRegSettings.

OnVisibleRangeChanged()

virtual void CDataMiningView::OnVisibleRangeChanged ( const CVisibleRange &  , IVisibleRangeClient *    )

inlinevirtual

Implements IVisibleRangeClient.

Definition at line 125 of file data_mining_view.hpp.

OnWidgetSelChanged()

void CDataMiningView::OnWidgetSelChanged

(

CEvent *

evt

)

TODO these mehods must be protected.

SaveSettings()

virtual void CDataMiningView::SaveSettings ( ) const

virtual

Implements IRegSettings.

SelectToolByName()

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

virtual

Referenced by CNetBLASTUIDataSource::OnExplore().

SetColor()

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

virtual

returns a color associated with the client

Implements IWMClient.

SetRegistryPath()

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

virtual

Implements IRegSettings.

SetSelection()

virtual void CDataMiningView::SetSelection ( CSelectionEvent &  evt )

virtual

set broadcasted selection

Implements ISelectionClient.

SetSelectionService()

virtual void CDataMiningView::SetSelectionService ( ISelectionService *  service )

virtual

Implements ISelectionClient.

SetWorkbench()

virtual void CDataMiningView::SetWorkbench ( IWorkbench *  workbench )

virtual

connect / disconnect this view with / from Workbench

Implements IView.

UpdateMenu()

virtual void CDataMiningView::UpdateMenu ( wxMenu &  root_menu )

virtual

x_OnSelectionEvent()

void CDataMiningView::x_OnSelectionEvent

(

CEvent *

)

x_OnStateChanged()

void CDataMiningView::x_OnStateChanged

(

CEvent *

)

x_UpdateLocation()

void CDataMiningView::x_UpdateLocation

(

TConstScopedObjects &

cso

)

x_UpdateSelectionScope()

void CDataMiningView::x_UpdateSelectionScope

(

)

x_UpdateToolCombo()

void CDataMiningView::x_UpdateToolCombo

(

bool

update_list

)

Friends And Related Function Documentation

CDataMiningViewFactory

friend class CDataMiningViewFactory

friend

Definition at line 74 of file data_mining_view.hpp.

Member Data Documentation

m_CurrSelScope

CRef<objects::CScope> CDataMiningView::m_CurrSelScope

protected

Definition at line 149 of file data_mining_view.hpp.

m_CurrSelScopeDirty

bool CDataMiningView::m_CurrSelScopeDirty

protected

Definition at line 152 of file data_mining_view.hpp.

m_DataMiningService

CDataMiningService* CDataMiningView::m_DataMiningService

protected

Definition at line 146 of file data_mining_view.hpp.

m_Panel

CDataMiningPanel* CDataMiningView::m_Panel

protected

Definition at line 156 of file data_mining_view.hpp.

m_Range

objects::CSeq_loc::TRange CDataMiningView::m_Range

protected

Definition at line 150 of file data_mining_view.hpp.

m_RegPath

string CDataMiningView::m_RegPath

protected

Definition at line 154 of file data_mining_view.hpp.

m_SelectionService

CSelectionService* CDataMiningView::m_SelectionService

protected

Definition at line 147 of file data_mining_view.hpp.

m_TypeDescr

CViewTypeDescriptor CDataMiningView::m_TypeDescr

staticprotected

Definition at line 143 of file data_mining_view.hpp.

m_Workbench

IWorkbench* CDataMiningView::m_Workbench

protected

Definition at line 145 of file data_mining_view.hpp.

---

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

• include/gui/core/data_mining_view.hpp