RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from http://www.ncbi.nlm.nih.gov/IEB/ToolBox/CPP_DOC/doxyhtml/classCProjectViewBase.html below:

NCBI C++ ToolKit: CProjectViewBase Class Reference

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>

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...
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 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) 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...
virtual string GetSelClientLabel () returns a string identifying the client in UI More...
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...
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 () CObjectEx (void) virtual ~CObjectEx (void) 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...
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 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...
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 () virtual ~IView () 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 () 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 () virtual ~IToolBarContext () 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) () 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 enum ELabel { eContent , eTypeAndContent , eDetailed , eDefault = eDetailed } Different flavors of label types for different GUI aspects. More...
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...

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

Definition at line 63 of file project_view_base_impl.hpp.

◆ CProjectViewBase() CProjectViewBase::CProjectViewBase ( ) ◆ ~CProjectViewBase() ◆ 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 ◆ DestroyView() void CProjectViewBase::DestroyView ( ) virtual ◆ 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 ◆ eh_OnViewReleased() void CProjectViewBase::eh_OnViewReleased ( CEvent * event ) protected ◆ GetClientLabel()

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() ◆ GetCommandHandler() wxEvtHandler * CProjectViewBase::GetCommandHandler ( ) virtual ◆ GetCompatibleToolBars() void CProjectViewBase::GetCompatibleToolBars ( vector< string > & names ) virtual ◆ 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() ◆ GetIconAlias() string CProjectViewBase::GetIconAlias ( ) const virtual ◆ GetId() size_t CProjectViewBase::GetId ( ) const virtual ◆ GetLabel()

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 ◆ GetProjectId() ◆ GetScope() CRef< CScope > CProjectViewBase::GetScope ( void ) const virtual ◆ GetSelClientLabel() string CProjectViewBase::GetSelClientLabel ( ) virtual ◆ GetServiceLocator() ◆ GetTypeDescriptor()

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.

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

◆ InitialLayout() void CProjectViewBase::InitialLayout ( ) virtual ◆ OnPrint() void CProjectViewBase::OnPrint ( ) virtual ◆ OnProjectChanged() [1/2] void CProjectViewBase::OnProjectChanged ( ) virtual ◆ OnProjectChanged() [2/2]

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() ◆ OnViewAttached() void CProjectViewBase::OnViewAttached ( IView & view ) virtual ◆ OnViewReleased() void CProjectViewBase::OnViewReleased ( IView & view ) virtual ◆ RefreshViewWindow() void CProjectViewBase::RefreshViewWindow ( ) virtual ◆ SetAsyncDestroy() virtual void CProjectViewBase::SetAsyncDestroy ( bool reset_hist_async ) inlinevirtual ◆ SetColor() ◆ SetFingerprint() void CProjectViewBase::SetFingerprint ( const string & fp ) virtual ◆ SetLabelGenerator() ◆ SetWorkbench() void CProjectViewBase::SetWorkbench ( IWorkbench * workbench ) virtual ◆ x_AttachToProject() void CProjectViewBase::x_AttachToProject ( CGBDocument & doc ) protectedvirtual

Definition at line 167 of file project_view_base_impl.cpp.

References EXT_POINT__OPEN_PROJECT_VIEW_EXTENSION, GetExtensionAsInterface(), ITERATE, m_ProjectId, m_ProjectName, m_Scope, m_Workbench, CRef< C, Locker >::Reset(), and CGBDocument::x_AttachView().

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_CreateMenuBarMenu() void CProjectViewBase::x_CreateMenuBarMenu ( ) protectedvirtual ◆ x_DetachFromProject() void CProjectViewBase::x_DetachFromProject ( ) protectedvirtual

Definition at line 225 of file project_view_base_impl.cpp.

References _ASSERT, CAppTaskService::AddTask(), IProjectView::eTypeAndContent, CProjectService::GetGBWorkspace(), GetLabel(), CRef< C, Locker >::GetPointer(), IServiceLocator::GetServiceByType(), IWorkbench::GetServiceLocator(), kEmptyStr, m_ProjectId, m_ResetHistAsync, m_Scope, m_Workbench, CRef< C, Locker >::Reset(), CGBProjectHandle::sm_NullId, CGBDocument::x_DetachView(), and x_HasProject().

Referenced by DestroyView(), and CProjectView::InitView().

◆ x_GetOrigObject()

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

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

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

◆ m_Color ◆ m_ContentLabel string CProjectViewBase::m_ContentLabel protected ◆ m_Fingerprint string CProjectViewBase::m_Fingerprint protected ◆ m_LabelGenerator ◆ m_MenuBarMenu unique_ptr<const wxMenu> CProjectViewBase::m_MenuBarMenu protected ◆ m_ProjectId ◆ m_ProjectName string CProjectViewBase::m_ProjectName protected ◆ m_ResetHistAsync bool CProjectViewBase::m_ResetHistAsync protected ◆ m_Scope CRef<objects::CScope> CProjectViewBase::m_Scope protected ◆ m_SelectionService ◆ m_ViewId const size_t CProjectViewBase::m_ViewId protected ◆ m_VisibleRangeChangeAllowed bool CProjectViewBase::m_VisibleRangeChangeAllowed protected ◆ m_Workbench

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

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4