NCBI C++ ToolKit
List of all members
CAlnSummaryViewFactory Class Reference

Search Toolkit Book for CAlnSummaryViewFactory

CAlnSummaryViewFactory. More...

#include <gui/packages/pkg_alignment/aln_summary_view.hpp>

+ Inheritance diagram for CAlnSummaryViewFactory:
+ Collaboration diagram for CAlnSummaryViewFactory:

Public Member Functions

IExtension interface implementation
virtual string GetExtensionIdentifier () const
 CAlnSummaryViewFactory. More...
 
virtual string GetExtensionLabel () const
 returns a displayable label for this extension ( please capitalize the key words - "My Extension" ) More...
 
IProjectViewFactory interface implementation
virtual IViewCreateInstance () const
 creates a view instance More...
 
virtual IViewCreateInstanceByFingerprint (const TFingerprint &fingerprint) const
 if fingerprint is recognized - creates and returns a new instance More...
 
virtual void RegisterIconAliases (wxFileArtProvider &provider)
 called by the framework to give Factory a chance to register images used by view More...
 
virtual const CProjectViewTypeDescriptorGetProjectViewTypeDescriptor () const
 returns a Descriptor for the View Type supported by the Factory More...
 
virtual bool IsCompatibleWith (const CObject &object, objects::CScope &scope)
 
virtual int TestInputObjects (TConstScopedObjects &objects)
 tests input objects (probably using object conversion, or not) and returns a combination of ETestResult flags better name is IsCompatibleWith() More...
 
- 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 IExtension
virtual ~IExtension ()
 
- Public Member Functions inherited from IProjectViewFactory
virtual const CViewTypeDescriptorGetViewTypeDescriptor () const
 returns a Descriptor for the View Type supported by the Factory More...
 
virtual IOpenViewManagerGetOpenViewManager ()
 
virtual vector< intCombineInputObjects (const TConstScopedObjects &objects)
 
virtual void CombineObjects (const TConstScopedObjects &objects, TObjectsMap &objects_map)
 
virtual bool ShowInOpenViewDlg () const
 
- Public Member Functions inherited from IViewFactory
virtual void RegisterCommands (CUICommandRegistry &, wxFileArtProvider &)
 called by the framework to give Factory a chance to register commands used by view More...
 
virtual ~IViewFactory ()
 

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 IProjectViewFactory
enum  ETestResult {
  fCanShowNone = 0x00 , fCanCombine = 0x01 , fCanShowSeparated = 0x02 , fCanShowSome = 0x04 ,
  fCanShowAll = 0x08
}
 
- Public Types inherited from IViewFactory
typedef IWMClient::CFingerprint TFingerprint
 
- 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 Attributes inherited from CObject
static const TCount eCounterBitsCanBeDeleted = 1 << 0
 Define possible object states. More...
 
static const TCount eCounterBitsInPlainHeap = 1 << 1
 Heap signature was found. More...
 
static const TCount eCounterBitsPlaceMask
 Mask for 'in heap' state flags. More...
 
static const int eCounterStep = 1 << 2
 Skip over the "in heap" bits. More...
 
static const TCount eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2)
 Minimal value for valid objects (reference counter is zero) Must be a single bit value. More...
 
static const TCount eCounterStateMask
 Valid object, and object in heap. More...
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Detailed Description

CAlnSummaryViewFactory.

Definition at line 47 of file aln_summary_view.hpp.

Member Function Documentation

◆ CreateInstance()

IView * CAlnSummaryViewFactory::CreateInstance ( ) const
virtual

creates a view instance

Implements IViewFactory.

Definition at line 138 of file aln_summary_view.cpp.

◆ CreateInstanceByFingerprint()

IView * CAlnSummaryViewFactory::CreateInstanceByFingerprint ( const TFingerprint fingerprint) const
virtual

if fingerprint is recognized - creates and returns a new instance

Implements IViewFactory.

Definition at line 143 of file aln_summary_view.cpp.

References NULL.

◆ GetExtensionIdentifier()

string CAlnSummaryViewFactory::GetExtensionIdentifier ( ) const
virtual

CAlnSummaryViewFactory.

Implements IExtension.

Definition at line 111 of file aln_summary_view.cpp.

◆ GetExtensionLabel()

string CAlnSummaryViewFactory::GetExtensionLabel ( ) const
virtual

returns a displayable label for this extension ( please capitalize the key words - "My Extension" )

Implements IExtension.

Definition at line 118 of file aln_summary_view.cpp.

◆ GetProjectViewTypeDescriptor()

const CProjectViewTypeDescriptor & CAlnSummaryViewFactory::GetProjectViewTypeDescriptor ( ) const
virtual

returns a Descriptor for the View Type supported by the Factory

Implements IProjectViewFactory.

Definition at line 132 of file aln_summary_view.cpp.

References s_AlnSummaryViewTypeDescr.

◆ IsCompatibleWith()

bool CAlnSummaryViewFactory::IsCompatibleWith ( const CObject object,
objects::CScope &  scope 
)
virtual

Reimplemented from IProjectViewFactory.

Definition at line 149 of file aln_summary_view.cpp.

References CSeq_annot::IsAlign(), and type.

Referenced by TestInputObjects().

◆ RegisterIconAliases()

void CAlnSummaryViewFactory::RegisterIconAliases ( wxFileArtProvider provider)
virtual

called by the framework to give Factory a chance to register images used by view

Implements IViewFactory.

Definition at line 125 of file aln_summary_view.cpp.

References CUIObject::GetIconAlias(), IProjectViewFactory::GetViewTypeDescriptor(), wxFileArtProvider::RegisterFileAlias(), ToWxString(), and wxT.

◆ TestInputObjects()

int CAlnSummaryViewFactory::TestInputObjects ( TConstScopedObjects objects)
virtual

tests input objects (probably using object conversion, or not) and returns a combination of ETestResult flags better name is IsCompatibleWith()

Implements IProjectViewFactory.

Definition at line 168 of file aln_summary_view.cpp.

References IProjectViewFactory::fCanShowAll, IProjectViewFactory::fCanShowSeparated, IProjectViewFactory::fCanShowSome, i, and IsCompatibleWith().


The documentation for this class was generated from the following files:
Modified on Sat Dec 02 09:22:01 2023 by modify_doxy.py rev. 669887