Search Toolkit Book for CProjectViewBase

CProjectViewBase - default implementation of IProjectView, the base class for CProjectView and CProjectViewComposite. More...

#include <gui/core/project_view_base_impl.hpp>

Inheritance diagram for CProjectViewBase:

Collaboration diagram for CProjectViewBase:

Public Member Functions
	CProjectViewBase ()

virtual	~CProjectViewBase ()

virtual void	RefreshViewWindow ()

virtual string	GetContentLabel () const
	overloadable hook for derived classes to customize the content aspect of a view's title. More...

IProjectView implementation
virtual void	DestroyView ()
	disconnects view from the project and associated data More...

virtual void	InitialLayout ()
	called when view creation is completed and view size is known More...

virtual void	Destroy ()

TId	GetId () const
	retrieve a unique ID for this view More...

virtual TProjectId	GetProjectId () const

virtual string	GetLabel (ELabelType type) const
	returns name of the plug-in created this view (view class name) More...

virtual IServiceLocator *	GetServiceLocator () const

virtual CRef< objects::CScope >	GetScope () const

IWMClient implementation
virtual wxWindow *	GetWindow ()=0
	returns a pointer to the wxWindow representing the client More...

virtual wxEvtHandler *	GetCommandHandler ()
	IWMClient implementation. More...

virtual string	GetClientLabel (IWMClient::ELabel ltype=IWMClient::eDefault) 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 CFingerprint	GetFingerprint () const
	returns a fingerprint identifying the client More...

virtual void	SetFingerprint (const string &fp)

IView implementation
virtual const CViewTypeDescriptor &	GetTypeDescriptor () const =0
	return an object providing meta information about thei view type More...

virtual void	SetWorkbench (IWorkbench *workbench)
	IView implementation. More...

virtual void	CreateViewWindow (wxWindow *parent)=0
	create Window corresponding to the view More...

virtual void	DestroyViewWindow ()=0
	destroy Window corresponding to the view More...

virtual void	SetAsyncDestroy (bool reset_hist_async)
	Set async destruction mode. More...

ISelectionClient implementation (partial)
virtual string	GetSelClientLabel ()
	returns a string identifying the client in UI More...

IToolBarContext implementation
virtual void	GetCompatibleToolBars (vector< string > &names)
	returns the names of toolbars compatible with this class (toolbars that are relevant and useful in the context of this class) More...

Event Handling
virtual void	OnSelectionChanged (const TConstScopedObjects &sels)

virtual void	OnProjectChanged ()

virtual void	OnProjectChanged (CProjectViewEvent &evt)

virtual void	OnViewAttached (IView &view)

virtual void	OnViewReleased (IView &view)

virtual void	OnPrint ()

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 IProjectView
virtual bool	InitView (TConstScopedObjects &objects, const objects::CUser_object *params)=0
	initialize view with data, inside this function the view must call CProjectService::AttachView to connect to a project More...

virtual void	SetOrigObject (SConstScopedObject &obj)

virtual	~IProjectView ()

Public Member Functions inherited from IView
virtual	~IView ()

Public Member Functions inherited from IWMClient
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 ISelectionClient
virtual	~ISelectionClient ()

virtual void	GetSelection (TConstScopedObjects &objects) const =0
	shall return data objects representing selected things, return one data object for every selected thing. More...

virtual void	SetSelectionService (ISelectionService *service)=0

virtual void	GetSelection (CSelectionEvent &evt) const =0
	get selection for broadcasting More...

virtual void	SetSelection (CSelectionEvent &evt)=0
	set broadcasted selection More...

virtual void	GetMainObject (TConstScopedObjects &objects) const =0
	Adds the main data objects represented by the client to "objects". More...

virtual void	GetActiveObjects (TConstScopedObjects &objects) const

virtual void	GetActiveObjects (vector< TConstScopedObjects > &sel)
	Prioritized active objects. More...

virtual void	BroadcastSelection ()

Public Member Functions inherited from IToolBarContext
virtual	~IToolBarContext ()

Static Public Member Functions
static void	SetLabelGenerator (IProjectViewLabel *labelGenerator)

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 ()

Protected Member Functions
virtual objects::CScope *	x_GetScope () const

virtual const CObject *	x_GetOrigObject () const

virtual bool	x_HasProject () const

virtual void	x_UpdateContentLabel ()

virtual void	x_AttachToProject (CGBDocument &doc)

virtual void	x_DetachFromProject ()

virtual void	x_ReportInvalidInputData (TConstScopedObjects &objects)
	use this function to report incompatible data in InitView() More...

virtual void	x_CreateMenuBarMenu ()
	initializes m_MenuBarMenu; override in derived classes More...

void	eh_OnProjectChanged (CEvent *event)
	private, non-virtual event handlers. More...

void	eh_OnViewAttached (CEvent *event)

void	eh_OnViewReleased (CEvent *event)

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...

Protected Attributes
const size_t	m_ViewId

IWorkbench *	m_Workbench

unique_ptr< const wxMenu >	m_MenuBarMenu

TProjectId	m_ProjectId

CRef< objects::CScope >	m_Scope

string	m_ProjectName

string	m_ContentLabel

ISelectionService *	m_SelectionService

CRgbaColor	m_Color
	the selection service we speak to More...

bool	m_VisibleRangeChangeAllowed
	this view's private color More...

bool	m_ResetHistAsync

string	m_Fingerprint

Protected Attributes inherited from CEventHandler
TPools	m_Pools

Static Protected Attributes
static CIRef< IProjectViewLabel >	m_LabelGenerator

Static Protected Attributes inherited from CEventHandler
static const SEvtMap	sm_EvtMap

Private Member Functions
	DECLARE_EVENT_MAP ()

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 IProjectView
enum	ELabelType { eType , eContent , eTypeAndContent , eId , eProject , eDefault = eTypeAndContent }
	Retrieve a label for this view. The label has several different. More...

using	TProjectId = objects::CGBProjectHandle::TId

typedef size_t	TId

Public Types inherited from IWMClient
enum	ELabel { eContent , eTypeAndContent , eDetailed , eDefault = eDetailed }
	Different flavors of label types for different GUI aspects. More...

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...

Detailed Description

CProjectViewBase - default implementation of IProjectView, the base class for CProjectView and CProjectViewComposite.

Definition at line 63 of file project_view_base_impl.hpp.

Constructor & Destructor Documentation

◆ CProjectViewBase()

CProjectViewBase::CProjectViewBase ( )

◆ ~CProjectViewBase()

CProjectViewBase::~CProjectViewBase ( void )

virtual

Definition at line 163 of file project_view_base_impl.cpp.

Member Function Documentation

◆ CreateViewWindow()

virtual void CProjectViewBase::CreateViewWindow ( wxWindow * parent )

pure virtual

create Window corresponding to the view

Implements IView.

Implemented in CVcfTableView, CTextView, CAlnSummaryView, CSequinDesktopView, CViewGraphic, CFeatTableView, CSeqTextView, CPhyTreeView, CMultiAlignView, CMPCrossAlignView, CDotMatrixView, CCrossAlignView, CAnnotCompareView, CAlignSpanView, CTableView, and CSimpleProjectView.

Referenced by CMPCrossAlignView::InitView().

◆ DECLARE_EVENT_MAP()

CProjectViewBase::DECLARE_EVENT_MAP ( )

private

◆ Destroy()

void CProjectViewBase::Destroy ( void )

virtual

Implements IProjectView.

Definition at line 290 of file project_view_base_impl.cpp.

Referenced by CTableViewWithTextViewNav::DestroyViewWindow().

◆ DestroyView()

void CProjectViewBase::DestroyView ( )

virtual

disconnects view from the project and associated data

Implements IProjectView.

Reimplemented in CMPCrossAlignView.

Definition at line 263 of file project_view_base_impl.cpp.

References CProjectService::GetGBWorkspace(), IServiceLocator::GetServiceByType(), m_ProjectId, m_Workbench, IViewSettingsAtProject::SaveSettingsAtProject(), x_DetachFromProject(), and x_HasProject().

Referenced by CMPCrossAlignView::DestroyView().

◆ DestroyViewWindow()

virtual void CProjectViewBase::DestroyViewWindow ( )

pure virtual

destroy Window corresponding to the view

Implements IView.

Implemented in CTableViewWithTextViewNav, CVcfTableView, CTextView, CSequinDesktopView, CViewGraphic, CFeatTableView, CSeqTextView, CPhyTreeView, CMultiAlignView, CMPCrossAlignView, CDotMatrixView, CCrossAlignView, CAnnotCompareView, CAlignSpanView, CTableView, and CSimpleProjectView.

◆ eh_OnProjectChanged()

void CProjectViewBase::eh_OnProjectChanged ( CEvent * event )

protected

private, non-virtual event handlers.

These functions are the primary direct handlers for the event handling mechanism and will forward event requests to public virtual functions on receipt

Definition at line 534 of file project_view_base_impl.cpp.

References _ASSERT, CProjectService::GetGBWorkspace(), CProjectViewEvent::GetProjectId(), IServiceLocator::GetServiceByType(), m_ProjectId, m_ProjectName, m_Workbench, OnProjectChanged(), RefreshViewWindow(), and x_UpdateContentLabel().

◆ eh_OnViewAttached()

void CProjectViewBase::eh_OnViewAttached ( CEvent * event )

protected

Definition at line 560 of file project_view_base_impl.cpp.

References CProjectViewEvent::GetProjectView(), and OnViewAttached().

◆ eh_OnViewReleased()

void CProjectViewBase::eh_OnViewReleased ( CEvent * event )

protected

Definition at line 568 of file project_view_base_impl.cpp.

References CProjectViewEvent::GetProjectView(), and OnViewReleased().

◆ GetClientLabel()

string CProjectViewBase::GetClientLabel ( IWMClient::ELabel ltype = IWMClient::eDefault ) const

virtual

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

Implements IWMClient.

Definition at line 410 of file project_view_base_impl.cpp.

References IProjectView::eContent, IWMClient::eContent, IProjectView::eId, IProjectView::eProject, IProjectView::eType, IProjectView::eTypeAndContent, IWMClient::eTypeAndContent, GetLabel(), sAbbreviate(), sContentCleanup(), str(), and x_HasProject().

Referenced by CViewGraphic::GetDMContextName(), GetFingerprint(), GetSelClientLabel(), and CSimpleProjectView::InitView().

◆ GetColor()

const CRgbaColor * CProjectViewBase::GetColor ( ) const

virtual

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

Implements IWMClient.

Definition at line 448 of file project_view_base_impl.cpp.

References m_Color.

Referenced by CProjectView::GetReflectionInfo().

◆ GetCommandHandler()

wxEvtHandler * CProjectViewBase::GetCommandHandler ( )

virtual

IWMClient implementation.

Implements IWMClient.

Reimplemented in CTableViewWithTextViewNav, CVcfTableView, CTextView, CSequinDesktopView, CSeqTextView, and CTableView.

Definition at line 356 of file project_view_base_impl.cpp.

References _ASSERT, GetWindow(), and NULL.

◆ GetCompatibleToolBars()

void CProjectViewBase::GetCompatibleToolBars ( vector< string > & names )

virtual

returns the names of toolbars compatible with this class (toolbars that are relevant and useful in the context of this class)

Implements IToolBarContext.

Reimplemented in CTableViewWithTextViewNav, CVcfTableView, CTextView, CSequinDesktopView, CViewGraphic, CFeatTableView, and CTableView.

Definition at line 625 of file project_view_base_impl.cpp.

References names, CProjectViewToolBatFactory::sm_NavTBName, and CProjectViewToolBatFactory::sm_SelTBName.

◆ GetContentLabel()

string CProjectViewBase::GetContentLabel ( ) const

virtual

overloadable hook for derived classes to customize the content aspect of a view's title.

This function is called from GetLabel() to present the content portion of the label; derived classes can specialize this function to provide a view-specific content label.

Definition at line 673 of file project_view_base_impl.cpp.

References m_ContentLabel.

Referenced by GetLabel().

◆ GetFingerprint()

IWMClient::CFingerprint CProjectViewBase::GetFingerprint ( ) const

virtual

returns a fingerprint identifying the client

Implements IWMClient.

Definition at line 475 of file project_view_base_impl.cpp.

References client, GetClientLabel(), m_Fingerprint, and NStr::PtrToString().

◆ GetIconAlias()

string CProjectViewBase::GetIconAlias ( ) const

virtual

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

Implements IWMClient.

Definition at line 442 of file project_view_base_impl.cpp.

References CUIObject::GetIconAlias(), and GetTypeDescriptor().

◆ GetId()

size_t CProjectViewBase::GetId ( ) const

virtual

retrieve a unique ID for this view

Implements IProjectView.

Definition at line 300 of file project_view_base_impl.cpp.

References m_ViewId.

Referenced by GetLabel(), CViewGraphic::OnViewReleased(), and CViewGraphic::x_UpdateVisRangeLayout().

◆ GetLabel()

string CProjectViewBase::GetLabel ( ELabelType type ) const

virtual

returns name of the plug-in created this view (view class name)

Implements IProjectView.

Definition at line 632 of file project_view_base_impl.cpp.

References IProjectView::eContent, IProjectView::eId, IProjectView::eProject, IProjectView::eType, IProjectView::eTypeAndContent, GetContentLabel(), GetId(), CUIObject::GetLabel(), GetTypeDescriptor(), m_LabelGenerator, m_ProjectName, and str().

Referenced by GetClientLabel(), CProjectView::GetReflectionInfo(), and x_DetachFromProject().

◆ GetMenu()

const wxMenu * CProjectViewBase::GetMenu ( )

virtual

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

Reimplemented from IMenuContributor.

Reimplemented in CTextView, CSequinDesktopView, and CViewGraphic.

Definition at line 460 of file project_view_base_impl.cpp.

References IMenuContributor::GetMenu(), IMenuContributor::GetMenuDef(), m_MenuBarMenu, and x_CreateMenuBarMenu().

◆ GetProjectId()

CProjectViewBase::TProjectId CProjectViewBase::GetProjectId ( ) const

virtual

Implements IProjectView.

Definition at line 295 of file project_view_base_impl.cpp.

References m_ProjectId.

◆ GetScope()

CRef< CScope > CProjectViewBase::GetScope ( void ) const

virtual

Implements IProjectView.

Definition at line 619 of file project_view_base_impl.cpp.

References m_Scope.

Referenced by CProjectView::BroadcastSelection(), CProjectView::GetMainObject(), CProjectView::GetReflectionInfo(), CProjectView::GetSelection(), CAlignSpanView::GetSelection(), x_GetScope(), CAlignSpanView::x_InitWidget(), CDotMatrixView::x_InitWidget(), CCrossAlignView::x_PostAttachToProject(), and x_UpdateContentLabel().

◆ GetSelClientLabel()

string CProjectViewBase::GetSelClientLabel ( )

virtual

returns a string identifying the client in UI

Implements ISelectionClient.

Definition at line 613 of file project_view_base_impl.cpp.

References GetClientLabel().

◆ GetServiceLocator()

IServiceLocator * CProjectViewBase::GetServiceLocator ( ) const

virtual

Implements IProjectView.

Definition at line 335 of file project_view_base_impl.cpp.

References m_Workbench.

◆ GetTypeDescriptor()

virtual const CViewTypeDescriptor& CProjectViewBase::GetTypeDescriptor ( ) const

pure virtual

return an object providing meta information about thei view type

Implements IView.

Implemented in CVcfTableView, CTextView, CAlnSummaryView, CProjectTableView, CSequinDesktopView, CViewGraphic, CFeatTableView, CSeqTextView, CPhyTreeView, CMultiAlignView, CMPCrossAlignView, CDotMatrixView, CCrossAlignView, CAnnotCompareView, CAlignSpanView, CTableView, and CSimpleProjectView.

Referenced by GetIconAlias(), GetLabel(), and x_ReportInvalidInputData().

◆ GetWindow()

virtual wxWindow* CProjectViewBase::GetWindow ( )

pure virtual

returns a pointer to the wxWindow representing the client

Implements IWMClient.

Implemented in CTableViewWithTextViewNav, CVcfTableView, CTextView, CSequinDesktopView, CViewGraphic, CFeatTableView, CSeqTextView, CPhyTreeView, CMultiAlignView, CMPCrossAlignView, CDotMatrixView, CCrossAlignView, CAnnotCompareView, CAlignSpanView, CTableView, and CSimpleProjectView.

Referenced by GetCommandHandler(), CProjectView::GetMainObject(), CMPCrossAlignView::InitView(), CProjectView::OnBroadcastVisibleRange(), and CProjectView::SetWorkbench().

◆ InitialLayout()

void CProjectViewBase::InitialLayout ( )

virtual

called when view creation is completed and view size is known

Implements IProjectView.

Definition at line 285 of file project_view_base_impl.cpp.

◆ OnPrint()

void CProjectViewBase::OnPrint ( )

virtual

Implements IProjectView.

Definition at line 608 of file project_view_base_impl.cpp.

◆ OnProjectChanged() [1/2]

void CProjectViewBase::OnProjectChanged ( )

virtual

Reimplemented in CFeatTableView, CMultiAlignView, and CMPCrossAlignView.

Definition at line 585 of file project_view_base_impl.cpp.

Referenced by eh_OnProjectChanged(), CPhyTreeView::InitView(), CSeqTextView::InitView(), and OnProjectChanged().

◆ OnProjectChanged() [2/2]

void CProjectViewBase::OnProjectChanged ( CProjectViewEvent & evt )

virtual

Implements IProjectView.

Reimplemented in CTableViewWithTextViewNav, CVcfTableView, CTextView, CProjectTableView, CSequinDesktopView, CViewGraphic, CFeatTableView, CPhyTreeView, CMultiAlignView, CDotMatrixView, CCrossAlignView, CAnnotCompareView, CAlignSpanView, CTableView, and CSimpleProjectView.

Definition at line 577 of file project_view_base_impl.cpp.

References _TRACE, and OnProjectChanged().

◆ OnSelectionChanged()

void CProjectViewBase::OnSelectionChanged ( const TConstScopedObjects & sels )

virtual

Implements IProjectView.

Definition at line 591 of file project_view_base_impl.cpp.

◆ OnViewAttached()

void CProjectViewBase::OnViewAttached ( IView & view )

virtual

Reimplemented in CViewGraphic.

Definition at line 603 of file project_view_base_impl.cpp.

Referenced by eh_OnViewAttached().

◆ OnViewReleased()

void CProjectViewBase::OnViewReleased ( IView & view )

virtual

Implements IProjectView.

Reimplemented in CViewGraphic.

Definition at line 597 of file project_view_base_impl.cpp.

Referenced by eh_OnViewReleased().

◆ RefreshViewWindow()

void CProjectViewBase::RefreshViewWindow ( )

virtual

Definition at line 347 of file project_view_base_impl.cpp.

References IWorkbench::GetWindowManagerService(), m_Workbench, and IWindowManagerService::RefreshClient().

Referenced by CProjectService::AddProjectView(), CSimpleProjectView::CreateView(), eh_OnProjectChanged(), and CViewGraphic::SetOrigObject().

◆ SetAsyncDestroy()

virtual void CProjectViewBase::SetAsyncDestroy ( bool reset_hist_async )

inlinevirtual

Set async destruction mode.

Implements IProjectView.

Definition at line 111 of file project_view_base_impl.hpp.

◆ SetColor()

void CProjectViewBase::SetColor ( const CRgbaColor & color )

virtual

returns a color associated with the client

Implements IWMClient.

Definition at line 454 of file project_view_base_impl.cpp.

References color, and m_Color.

◆ SetFingerprint()

void CProjectViewBase::SetFingerprint ( const string & fp )

virtual

Reimplemented from IWMClient.

Definition at line 485 of file project_view_base_impl.cpp.

References fp, and m_Fingerprint.

◆ SetLabelGenerator()

void CProjectViewBase::SetLabelGenerator ( IProjectViewLabel * labelGenerator )

static

Definition at line 342 of file project_view_base_impl.cpp.

References m_LabelGenerator, and CRef< C, Locker >::Reset().

◆ SetWorkbench()

void CProjectViewBase::SetWorkbench ( IWorkbench * workbench )

virtual

IView implementation.

Implements IView.

Reimplemented in CViewGraphic, CMPCrossAlignView, and CProjectView.

Definition at line 308 of file project_view_base_impl.cpp.

References IToolBarService::AddToolBarContext(), IServiceLocator::GetServiceByType(), IWorkbench::GetToolBarService(), m_Workbench, and IToolBarService::RemoveToolBarContext().

Referenced by CProjectView::SetWorkbench(), and CMPCrossAlignView::SetWorkbench().

◆ x_AttachToProject()

void CProjectViewBase::x_AttachToProject ( CGBDocument & doc )

protectedvirtual

◆ x_CreateMenuBarMenu()

void CProjectViewBase::x_CreateMenuBarMenu ( )

protectedvirtual

initializes m_MenuBarMenu; override in derived classes

Reimplemented in CFeatTableView, CPhyTreeView, CMultiAlignView, CMPCrossAlignView, CDotMatrixView, CCrossAlignView, CAnnotCompareView, and CAlignSpanView.

Definition at line 528 of file project_view_base_impl.cpp.

References _TRACE.

Referenced by GetMenu().

◆ x_DetachFromProject()

void CProjectViewBase::x_DetachFromProject ( )

protectedvirtual

◆ x_GetOrigObject()

const CObject * CProjectViewBase::x_GetOrigObject ( ) const

protectedvirtual

Reimplemented in CTableViewWithTextViewNav, CVcfTableView, CTextView, CSequinDesktopView, CViewGraphic, CFeatTableView, CSeqTextView, CPhyTreeView, CMultiAlignView, CMPCrossAlignView, CDotMatrixView, CCrossAlignView, CAnnotCompareView, CAlignSpanView, CTableView, and CSimpleProjectView.

Definition at line 504 of file project_view_base_impl.cpp.

References _ASSERT, and NULL.

Referenced by CProjectView::GetMainObject(), and x_UpdateContentLabel().

◆ x_GetScope()

CScope * CProjectViewBase::x_GetScope ( ) const

protectedvirtual

Definition at line 496 of file project_view_base_impl.cpp.

References CRef< C, Locker >::GetPointer(), and GetScope().

◆ x_HasProject()

bool CProjectViewBase::x_HasProject ( ) const

protectedvirtual

Definition at line 490 of file project_view_base_impl.cpp.

References m_ProjectId, and CGBProjectHandle::sm_NullId.

◆ x_ReportInvalidInputData()

void CProjectViewBase::x_ReportInvalidInputData ( TConstScopedObjects & objects )

protectedvirtual

use this function to report incompatible data in InitView()

Definition at line 510 of file project_view_base_impl.cpp.

References CLabel::eContent, CUIObject::GetLabel(), CLabel::GetLabel(), GetTypeDescriptor(), NON_CONST_ITERATE, and ToWxString().

Referenced by CProjectView::InitView(), CSimpleProjectView::InitView(), CTableView::InitView(), CMPCrossAlignView::InitView(), CMultiAlignView::InitView(), CPhyTreeView::InitView(), CSeqTextView::InitView(), CViewGraphic::InitView(), CSequinDesktopView::InitView(), CTextView::InitView(), CVcfTableView::InitView(), and CTableViewWithTextViewNav::InitView().

◆ x_UpdateContentLabel()

void CProjectViewBase::x_UpdateContentLabel ( )

protectedvirtual

Definition at line 708 of file project_view_base_impl.cpp.

References _ASSERT, CLabel::eDefault, CProjectService::GetGBWorkspace(), CLabel::GetLabel(), CRef< C, Locker >::GetPointer(), GetScope(), IServiceLocator::GetServiceByType(), m_ContentLabel, m_ProjectId, m_Workbench, s_CollidedIds(), CGBDocument::ViewLabelChanged(), x_GetOrigObject(), and x_HasProject().

Member Data Documentation

◆ m_Color

CRgbaColor CProjectViewBase::m_Color

protected

the selection service we speak to

Definition at line 190 of file project_view_base_impl.hpp.

Referenced by GetColor(), and SetColor().

◆ m_ContentLabel

string CProjectViewBase::m_ContentLabel

protected

Definition at line 186 of file project_view_base_impl.hpp.

Referenced by GetContentLabel(), and x_UpdateContentLabel().

◆ m_Fingerprint

string CProjectViewBase::m_Fingerprint

protected

Definition at line 195 of file project_view_base_impl.hpp.

Referenced by GetFingerprint(), and SetFingerprint().

◆ m_LabelGenerator

CIRef< IProjectViewLabel > CProjectViewBase::m_LabelGenerator

staticprotected

Definition at line 197 of file project_view_base_impl.hpp.

Referenced by GetLabel(), and SetLabelGenerator().

◆ m_MenuBarMenu

unique_ptr<const wxMenu> CProjectViewBase::m_MenuBarMenu

protected

Definition at line 176 of file project_view_base_impl.hpp.

Referenced by GetMenu(), CAlignSpanView::x_CreateMenuBarMenu(), CAnnotCompareView::x_CreateMenuBarMenu(), CCrossAlignView::x_CreateMenuBarMenu(), CDotMatrixView::x_CreateMenuBarMenu(), and CPhyTreeView::x_CreateMenuBarMenu().

◆ m_ProjectId

TProjectId CProjectViewBase::m_ProjectId

protected

Definition at line 180 of file project_view_base_impl.hpp.

Referenced by DestroyView(), eh_OnProjectChanged(), GetProjectId(), CPhyTreeView::OnCreateSelectedSubtree(), x_AttachToProject(), x_DetachFromProject(), CProjectView::x_GetUndoManager(), x_HasProject(), and x_UpdateContentLabel().

◆ m_ProjectName

string CProjectViewBase::m_ProjectName

protected

Definition at line 185 of file project_view_base_impl.hpp.

Referenced by eh_OnProjectChanged(), GetLabel(), and x_AttachToProject().

◆ m_ResetHistAsync

bool CProjectViewBase::m_ResetHistAsync

protected

Definition at line 194 of file project_view_base_impl.hpp.

Referenced by x_DetachFromProject().

◆ m_Scope

CRef<objects::CScope> CProjectViewBase::m_Scope

protected

Definition at line 181 of file project_view_base_impl.hpp.

Referenced by GetScope(), CViewGraphic::GetSearchScope(), x_AttachToProject(), and x_DetachFromProject().

◆ m_SelectionService

ISelectionService* CProjectViewBase::m_SelectionService

protected

Definition at line 188 of file project_view_base_impl.hpp.

Referenced by CProjectView::BroadcastSelection(), CMultiAlignView::OnAlnWidgetSelChanged(), CVcfTableView::OnWidgetSelChanged(), CProjectView::SetSelectionService(), CTextView::WidgetSelectionChanged(), and CProjectView::x_OnWidgetSelChanged().

◆ m_ViewId

const size_t CProjectViewBase::m_ViewId

protected

Definition at line 171 of file project_view_base_impl.hpp.

Referenced by GetId().

◆ m_VisibleRangeChangeAllowed

bool CProjectViewBase::m_VisibleRangeChangeAllowed

protected

this view's private color

enum defining how we broadcast our selections

Definition at line 193 of file project_view_base_impl.hpp.

Referenced by CProjectView::IsVisibleRangeChangeAllowed(), and CProjectView::SetVisibleRangeChangeAllowed().

◆ m_Workbench

IWorkbench* CProjectViewBase::m_Workbench

protected

Definition at line 173 of file project_view_base_impl.hpp.

Referenced by CSimpleProjectView::CloseWidget(), CSequinDesktopView::CloseWidget(), CTextView::CloseWidget(), DestroyView(), CMPCrossAlignView::DestroyView(), eh_OnProjectChanged(), CSequinDesktopView::GetAppSelection(), CTextView::GetAppSelection(), GetServiceLocator(), CProjectView::InitView(), CSimpleProjectView::InitView(), CTableView::InitView(), CMPCrossAlignView::InitView(), CMultiAlignView::InitView(), CPhyTreeView::InitView(), CSeqTextView::InitView(), CViewGraphic::InitView(), CSequinDesktopView::InitView(), CTextView::InitView(), CVcfTableView::InitView(), CTableViewWithTextViewNav::InitView(), CPhyTreeView::OnCreateSelectedSubtree(), CPhyTreeView::OnExportTree(), CMultiAlignView::OnOpenGraphicalView(), CViewGraphic::OnOpenGraphicalView(), CViewGraphic::OnProjectChanged(), CTextView::OnTextGotFocus(), CTextView::OnTextLostFocus(), CTextView::OnTextPositionChanged(), CViewGraphic::OnViewAttached(), CViewGraphic::OnViewReleased(), CViewGraphic::OnVisibleRangeChanged(), CSimpleProjectView::OnWidgetCommand(), CViewGraphic::OnWidgetRangeChanged(), RefreshViewWindow(), SetWorkbench(), CProjectView::SetWorkbench(), CViewGraphic::SetWorkbench(), CSimpleProjectView::ShowView(), CSequinDesktopView::ShowView(), CTextView::ShowView(), CSimpleProjectView::WidgetActivated(), x_AttachToProject(), CCrossAlignView::x_CreateMenuBarMenu(), CDotMatrixView::x_CreateMenuBarMenu(), x_DetachFromProject(), CTableViewWithTextViewNav::x_GetCmdProcessor(), CTableViewWithTextViewNav::x_GetFlatFileCtrl(), CProjectView::x_GetUndoManager(), CTableViewWithTextViewNav::x_GetViewObjects(), CVcfTableView::x_OnDataChanged(), CProjectView::x_OnDecoratePopupMenu(), CSequinDesktopView::x_OnRefreshData(), CSequinDesktopView::x_OnSingleMouseClick(), CTableView::x_OnUrlHover(), CVcfTableView::x_OnUrlHover(), CProjectView::x_OnWidgetItemActivated(), CTableView::x_QueryStatusChange(), CPhyTreeView::x_QueryStatusChange(), CVcfTableView::x_QueryStatusChange(), CTableViewWithTextViewNav::x_QueryStatusChange(), x_UpdateContentLabel(), and CTextView::~CTextView().

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

include/gui/core/project_view_base_impl.hpp
src/gui/core/project_view_base_impl.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CProjectViewBase()

◆ ~CProjectViewBase()

Member Function Documentation

◆ CreateViewWindow()

◆ DECLARE_EVENT_MAP()

◆ Destroy()

◆ DestroyView()

◆ DestroyViewWindow()

◆ eh_OnProjectChanged()

◆ eh_OnViewAttached()

◆ eh_OnViewReleased()

◆ GetClientLabel()

◆ GetColor()

◆ GetCommandHandler()

◆ GetCompatibleToolBars()

◆ GetContentLabel()

◆ GetFingerprint()

◆ GetIconAlias()

◆ GetId()

◆ GetLabel()

◆ GetMenu()

◆ GetProjectId()

◆ GetScope()

◆ GetSelClientLabel()

◆ GetServiceLocator()

◆ GetTypeDescriptor()

◆ GetWindow()

◆ InitialLayout()

◆ OnPrint()

◆ OnProjectChanged() [1/2]

◆ OnProjectChanged() [2/2]

◆ OnSelectionChanged()

◆ OnViewAttached()

◆ OnViewReleased()

◆ RefreshViewWindow()

◆ SetAsyncDestroy()

◆ SetColor()

◆ SetFingerprint()

◆ SetLabelGenerator()

◆ SetWorkbench()

◆ x_AttachToProject()

◆ x_CreateMenuBarMenu()

◆ x_DetachFromProject()

◆ x_GetOrigObject()

◆ x_GetScope()

◆ x_HasProject()

◆ x_ReportInvalidInputData()

◆ x_UpdateContentLabel()

Member Data Documentation

◆ m_Color

◆ m_ContentLabel

◆ m_Fingerprint

◆ m_LabelGenerator

◆ m_MenuBarMenu

◆ m_ProjectId

◆ m_ProjectName

◆ m_ResetHistAsync

◆ m_Scope

◆ m_SelectionService

◆ m_ViewId

◆ m_VisibleRangeChangeAllowed

◆ m_Workbench