Showing content from http://www.ncbi.nlm.nih.gov/IEB/ToolBox/CPP_DOC/doxyhtml/classCDataMiningView.html below:
NCBI C++ ToolKit: CDataMiningView Class Reference
Search Toolkit Book for CDataMiningView
CDataMiningView. More...
#include <gui/core/data_mining_view.hpp>
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 *) 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...
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...
virtual void SetRegistryPath (const string ®_path) virtual void LoadSettings () virtual void SaveSettings () const 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 () virtual void OnVisibleRangeChanged (const CVisibleRange &, IVisibleRangeClient *) 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 ~IView () 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 () virtual ~IRegSettings () virtual ~ISelectionClient () virtual void GetActiveObjects (TConstScopedObjects &objects) const virtual void GetActiveObjects (vector< TConstScopedObjects > &sel) Prioritized active objects. More...
virtual ~IVisibleRangeClient () 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 ELabel { eContent , eTypeAndContent , eDetailed , eDefault = eDetailed } Different flavors of label types for different GUI aspects. More...
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 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 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...
virtual void DeleteThis (void) Virtual method "deleting" this object. More...
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) ◆ CDataMiningView() CDataMiningView::CDataMiningView ( ) ◆ ~CDataMiningView() virtual CDataMiningView::~CDataMiningView ( ) virtual ◆ 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()
returns the client label (name) to be displayed in UI
Implements IWMClient.
◆ GetColor()
returns a color associated with the client, n/a if NULL
Implements IWMClient.
◆ GetCommandHandler() virtual wxEvtHandler* CDataMiningView::GetCommandHandler ( ) inlinevirtual ◆ 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()
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 ◆ GetSelection() [1/2] ◆ GetSelection() [2/2]
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()
return an object providing meta information about thei view type
Implements IView.
◆ GetWindow() virtual wxWindow* CDataMiningView::GetWindow ( ) virtual ◆ LoadSettings() virtual void CDataMiningView::LoadSettings ( ) virtual
Implements IRegSettings.
◆ OnVisibleRangeChanged() ◆ OnWidgetSelChanged() void CDataMiningView::OnWidgetSelChanged ( CEvent * evt )
TODO these mehods must be protected.
◆ SaveSettings() virtual void CDataMiningView::SaveSettings ( ) const virtual
Implements IRegSettings.
◆ SelectToolByName() ◆ SetColor()
returns a color associated with the client
Implements IWMClient.
◆ SetRegistryPath() ◆ SetSelection() ◆ SetSelectionService() ◆ 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() ◆ x_UpdateSelectionScope() void CDataMiningView::x_UpdateSelectionScope ( ) ◆ x_UpdateToolCombo() void CDataMiningView::x_UpdateToolCombo ( bool update_list ) ◆ CDataMiningViewFactory ◆ m_CurrSelScope ◆ m_CurrSelScopeDirty ◆ m_DataMiningService ◆ m_Panel ◆ m_Range ◆ m_RegPath ◆ m_SelectionService ◆ m_TypeDescr ◆ m_Workbench
The documentation for this class was generated from the following file:
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