NCBI C++ ToolKit
Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
CSimpleProjectView Class Reference

Search Toolkit Book for CSimpleProjectView

#include <gui/core/simple_project_view.hpp>

+ Inheritance diagram for CSimpleProjectView:
+ Collaboration diagram for CSimpleProjectView:

Public Member Functions

IGuiWidgetHost implementation
virtual void CloseWidget ()
 IGuiWidgetHost implementation. More...
 
virtual void WidgetSelectionChanged ()
 
virtual void WidgetActivated ()
 
virtual void OnWidgetCommand (const string &command)
 
virtual void ShowView (const string &viewName, FWindowFactory widgetFactory, TConstScopedObjects &objects, bool bFloat)
 
IWMClient implementation
virtual wxWindow * GetWindow ()
 IWMClient implementation. More...
 
virtual bool IsADialog () const
 returns true if client is a non-modal dioalog More...
 
IView implementation

@(

virtual const CViewTypeDescriptorGetTypeDescriptor () const
 IView implementation. More...
 
virtual void CreateViewWindow (wxWindow *parent)
 create Window corresponding to the view More...
 
virtual void DestroyViewWindow ()
 destroy Window corresponding to the view More...
 
IProjectView implementation
virtual bool InitView (TConstScopedObjects &objects, const objects::CUser_object *params)
 IProjectView implementation. More...
 
virtual void OnProjectChanged (CProjectViewEvent &evt)
 
ISelectionClient Implementation
virtual void GetSelection (CSelectionEvent &evt) const
 ISelectionClient Implementation. More...
 
virtual void GetSelection (TConstScopedObjects &objs) const
 shall return data objects representing selected things, return one data object for every selected thing. More...
 
virtual void GetMainObject (TConstScopedObjects &objs) const
 Adds the main data objects represented by the client to "objects". More...
 
virtual void GetActiveObjects (TConstScopedObjects &objects) const
 
virtual void GetActiveObjects (vector< TConstScopedObjects > &objects)
 Prioritized active objects. More...
 
- Public Member Functions inherited from CProjectView
 CProjectView ()
 CProjectView implementation. More...
 
virtual ~CProjectView (void)
 
void SetVisibleRangeService (IVisibleRangeService *service)
 
virtual void GetVisibleRanges (CVisibleRange &vrange) const
 populate a visible range event for broadcasting More...
 
void GetReflectionInfo (const objects::CSeq_id &id, list< TSeqRange > &visible_ranges, CRgbaColor &color, string &label) const
 Retrieve all information relevant to showing view reflection - that is, displaying the location of sibling views. More...
 
void BroadcastVisibleRange (CVisibleRange::EBasicPolicy bp)
 fire a non-recursive visible range changed event More...
 
virtual void SetWorkbench (IWorkbench *workbench)
 IView implementation. More...
 
virtual void SetSelectionService (ISelectionService *service)
 
virtual void SetSelection (CSelectionEvent &evt)
 handles selection broadcast received from Selection Service this function acts as a shell, it controlls state and catches exceptions. More...
 
virtual void BroadcastSelection ()
 
virtual void OnVisibleRangeChanged (const CVisibleRange &, IVisibleRangeClient *)
 
bool IsVisibleRangeChangeAllowed ()
 
void SetVisibleRangeChangeAllowed (bool flag)
 
void OnVRCAllowedChanged ()
 
void OnBroadcastVisibleRange (wxCommandEvent &event)
 
virtual void OnUndo ()
 
virtual void OnRedo ()
 
virtual bool CanUndo ()
 
virtual bool CanRedo ()
 
virtual void OnWidgetRangeChanged ()
 
virtual void OnWidgetSelChanged ()
 
void OnDecoratePopupMenu (CEvent *event)
 
void OnShowPopupMenu (CEvent *event)
 
- Public Member Functions inherited from CProjectViewBase
 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 IServiceLocatorGetServiceLocator () const
 
virtual CRef< objects::CScope > GetScope () const
 
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 CRgbaColorGetColor () 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 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 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...
 
CObjectoperator= (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)
 
CPtrToObjectProxyGetPtrProxy (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 TListenersGetListeners (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 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 ~IWMClient ()
 
- Public Member Functions inherited from IMenuContributor
virtual ~IMenuContributor ()
 
- Public Member Functions inherited from ISelectionClient
virtual ~ISelectionClient ()
 
- Public Member Functions inherited from IToolBarContext
virtual ~IToolBarContext ()
 
- Public Member Functions inherited from IVisibleRangeClient
virtual ~IVisibleRangeClient ()
 
- Public Member Functions inherited from IGuiWidgetHost
virtual ~IGuiWidgetHost ()
 
virtual void GetAppSelection (TConstObjects &)
 

Static Public Member Functions

static CIRef< IProjectViewCreateView (const string &viewName, FWindowFactory widgetFactory, IServiceLocator *serviceLocator, TConstScopedObjects &objects, ISimpleProjectViewCmdHandler *cmdHandler=0, bool bFloat=false)
 
- Static Public Member Functions inherited from CProjectViewBase
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 const CObjectx_GetOrigObject () const
 CProjectViewBase overridables. More...
 
virtual void x_OnSetSelection (CSelectionEvent &evt)
 override in derived classes in order to handle selection broadcast More...
 
void x_ActivateTextView (CProjectService &prjSrv)
 
- Protected Member Functions inherited from CProjectView
 DECLARE_EVENT_MAP ()
 
virtual objects::CScope * x_PreAttachToProject (TConstScopedObjects &objects)
 
virtual void x_PostAttachToProject ()
 
virtual void x_OnDecoratePopupMenu (CPopupMenuEvent &event)
 
virtual void x_OnShowPopupMenu ()
 
virtual wxEvtHandler * x_CreateEventHandler ()
 creates vew event handler for using in window event propagation hierarchy More...
 
virtual wxMenu * x_CreateContextMenuBackbone ()
 creates the template of the context menu More...
 
virtual CUndoManagerx_GetUndoManager ()
 gets undo manager More...
 
void x_OnWidgetRangeChanged (CEvent *event)
 private, non-virtual event handlers. More...
 
void x_OnWidgetSelChanged (CEvent *event)
 
void x_OnWidgetItemActivated (CEvent *event)
 
- Protected Member Functions inherited from CProjectViewBase
virtual objects::CScope * x_GetScope () 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 SEvtMapGetEventMap () 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 SwxMenuItemRecGetMenuDef () const
 simpler way to provide a static menu using macros defined earlier in this file More...
 

Protected Attributes

CProjectViewTypeDescriptor m_ViewDescr
 
FWindowFactory m_WidgetFactory
 
wxWindow * m_Widget
 
CIRef< ISimpleProjectViewCmdHandlerm_CmdHandler
 
- Protected Attributes inherited from CProjectView
IVisibleRangeServicem_VisibleRangeService
 
- Protected Attributes inherited from CProjectViewBase
const size_t m_ViewId
 
IWorkbenchm_Workbench
 
unique_ptr< const wxMenu > m_MenuBarMenu
 
TProjectId m_ProjectId
 
CRef< objects::CScope > m_Scope
 
string m_ProjectName
 
string m_ContentLabel
 
ISelectionServicem_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
 

Private Member Functions

 CSimpleProjectView (const string &viewName, FWindowFactory widgetFactory, ISimpleProjectViewCmdHandler *cmdHandler)
 

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< Uint8TCounter
 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, TListenersTPools
 
typedef list< AutoPtr< SPostRequest > > TPostRequests
 
typedef std::map< CEventHandler *, intTHandlerToCount
 
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...
 
- Static Protected Attributes inherited from CProjectViewBase
static CIRef< IProjectViewLabelm_LabelGenerator
 
- Static Protected Attributes inherited from CEventHandler
static const SEvtMap sm_EvtMap
 

Detailed Description

Definition at line 68 of file simple_project_view.hpp.

Constructor & Destructor Documentation

◆ CSimpleProjectView()

CSimpleProjectView::CSimpleProjectView ( const string viewName,
FWindowFactory  widgetFactory,
ISimpleProjectViewCmdHandler cmdHandler 
)
private

Definition at line 89 of file simple_project_view.cpp.

Referenced by CreateView().

Member Function Documentation

◆ CloseWidget()

void CSimpleProjectView::CloseWidget ( )
virtual

◆ CreateView()

CIRef< IProjectView > CSimpleProjectView::CreateView ( const string viewName,
FWindowFactory  widgetFactory,
IServiceLocator serviceLocator,
TConstScopedObjects objects,
ISimpleProjectViewCmdHandler cmdHandler = 0,
bool  bFloat = false 
)
static

◆ CreateViewWindow()

void CSimpleProjectView::CreateViewWindow ( wxWindow *  parent)
virtual

create Window corresponding to the view

Implements CProjectViewBase.

Definition at line 207 of file simple_project_view.cpp.

References _ASSERT, m_Widget, m_WidgetFactory, and IGuiWidget::SetHost().

◆ DestroyViewWindow()

void CSimpleProjectView::DestroyViewWindow ( )
virtual

destroy Window corresponding to the view

Implements CProjectViewBase.

Definition at line 215 of file simple_project_view.cpp.

References m_Widget, IGuiWidget::SetClosing(), and IGuiWidget::SetHost().

◆ GetActiveObjects() [1/2]

void CSimpleProjectView::GetActiveObjects ( TConstScopedObjects objects) const
virtual

Reimplemented from ISelectionClient.

Definition at line 319 of file simple_project_view.cpp.

References IGuiWidget::GetActiveObjects(), ITERATE, and m_Widget.

◆ GetActiveObjects() [2/2]

void CSimpleProjectView::GetActiveObjects ( vector< TConstScopedObjects > &  sel)
virtual

Prioritized active objects.

Reimplemented from ISelectionClient.

Definition at line 330 of file simple_project_view.cpp.

References IGuiWidget::GetActiveObjects(), and m_Widget.

◆ GetMainObject()

void CSimpleProjectView::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.

Reimplemented from CProjectView.

Definition at line 308 of file simple_project_view.cpp.

References IGuiWidget::GetActiveObjects(), and m_Widget.

◆ GetSelection() [1/2]

void CSimpleProjectView::GetSelection ( CSelectionEvent evt) const
virtual

◆ GetSelection() [2/2]

void CSimpleProjectView::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.

Reimplemented from CProjectView.

Definition at line 294 of file simple_project_view.cpp.

References IGuiWidget::GetSelectedObjects(), ITERATE, m_Widget, CProjectViewBase::x_GetScope(), and CProjectViewBase::x_HasProject().

◆ GetTypeDescriptor()

const CViewTypeDescriptor & CSimpleProjectView::GetTypeDescriptor ( ) const
virtual

IView implementation.

Implements CProjectViewBase.

Definition at line 202 of file simple_project_view.cpp.

References m_ViewDescr.

◆ GetWindow()

wxWindow * CSimpleProjectView::GetWindow ( )
virtual

IWMClient implementation.

Implements CProjectViewBase.

Definition at line 189 of file simple_project_view.cpp.

References _ASSERT, and m_Widget.

◆ InitView()

bool CSimpleProjectView::InitView ( TConstScopedObjects objects,
const objects::CUser_object *  params 
)
virtual

◆ IsADialog()

bool CSimpleProjectView::IsADialog ( ) const
virtual

returns true if client is a non-modal dioalog

Reimplemented from IWMClient.

Definition at line 195 of file simple_project_view.cpp.

References m_Widget.

◆ OnProjectChanged()

void CSimpleProjectView::OnProjectChanged ( CProjectViewEvent evt)
virtual

◆ OnWidgetCommand()

void CSimpleProjectView::OnWidgetCommand ( const string command)
virtual

Implements IGuiWidgetHost.

Definition at line 174 of file simple_project_view.cpp.

References command, m_CmdHandler, m_Widget, and CProjectViewBase::m_Workbench.

◆ ShowView()

void CSimpleProjectView::ShowView ( const string viewName,
FWindowFactory  widgetFactory,
TConstScopedObjects objects,
bool  bFloat 
)
virtual

◆ WidgetActivated()

void CSimpleProjectView::WidgetActivated ( )
virtual

◆ WidgetSelectionChanged()

void CSimpleProjectView::WidgetSelectionChanged ( )
virtual

◆ x_ActivateTextView()

void CSimpleProjectView::x_ActivateTextView ( CProjectService prjSrv)
protected

Member Data Documentation

◆ m_CmdHandler

CIRef<ISimpleProjectViewCmdHandler> CSimpleProjectView::m_CmdHandler
protected

Definition at line 134 of file simple_project_view.hpp.

Referenced by OnWidgetCommand().

◆ m_ViewDescr

CProjectViewTypeDescriptor CSimpleProjectView::m_ViewDescr
protected

Definition at line 129 of file simple_project_view.hpp.

Referenced by GetTypeDescriptor(), and InitView().

◆ m_Widget

wxWindow* CSimpleProjectView::m_Widget
protected

◆ m_WidgetFactory

FWindowFactory CSimpleProjectView::m_WidgetFactory
protected

Definition at line 131 of file simple_project_view.hpp.

Referenced by CreateViewWindow().


The documentation for this class was generated from the following files:
Modified on Sun Apr 21 03:41:20 2024 by modify_doxy.py rev. 669887