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

Search Toolkit Book for CGuiObjectInfoSeq_loc

+ Inheritance diagram for CGuiObjectInfoSeq_loc:
+ Collaboration diagram for CGuiObjectInfoSeq_loc:

Public Member Functions

virtual string GetType () const
 
virtual string GetSubtype () const
 
virtual string GetLabel () const
 
virtual void GetToolTip (ITooltipFormatter &tooltip, string &t_title, TSeqPos at_p=(TSeqPos)-1) const
 Get tooltip. More...
 
virtual void GetLinks (ITooltipFormatter &, bool) const
 Get a set of links. More...
 
virtual string GetIcon () const
 
virtual string GetViewCategory () const
 To share default view between different types. 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 IGuiObjectInfo
virtual ~IGuiObjectInfo ()
 

Static Public Member Functions

static CGuiObjectInfoSeq_locCreateObject (SConstScopedObject &object, ICreateParams *params)
 
- Static Public Member Functions inherited from CObject
static NCBI_NORETURN void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_NORETURN 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)
 

Private Types

enum  ESubtype { kUnknown, kDNA, kProtein }
 

Private Attributes

CConstRef< CObjectm_Object
 
CRef< objects::CScope > m_Scope
 
enum CGuiObjectInfoSeq_loc::ESubtype m_Subtype
 

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 CAtomicCounter TCounter
 Counter type is CAtomiCounter. More...
 
typedef TCounter::TValue TCount
 Alias for value type of counter. 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...
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Detailed Description

Definition at line 46 of file gui_object_info_seq_loc.cpp.

Member Enumeration Documentation

Enumerator
kUnknown 
kDNA 
kProtein 

Definition at line 63 of file gui_object_info_seq_loc.cpp.

Member Function Documentation

CGuiObjectInfoSeq_loc * CGuiObjectInfoSeq_loc::CreateObject ( SConstScopedObject object,
ICreateParams params 
)
static
string CGuiObjectInfoSeq_loc::GetIcon ( ) const
virtual

Implements IGuiObjectInfo.

Definition at line 126 of file gui_object_info_seq_loc.cpp.

References kDNA, kProtein, and m_Subtype.

string CGuiObjectInfoSeq_loc::GetLabel ( void  ) const
virtual
virtual void CGuiObjectInfoSeq_loc::GetLinks ( ITooltipFormatter links,
bool  no_ncbi_base 
) const
inlinevirtual

Get a set of links.

Parameters
no_ncbi_baseif set to true, then the NCBI base path should be removed from the returned URL links.

Implements IGuiObjectInfo.

Definition at line 55 of file gui_object_info_seq_loc.cpp.

virtual string CGuiObjectInfoSeq_loc::GetSubtype ( void  ) const
inlinevirtual

Implements IGuiObjectInfo.

Definition at line 52 of file gui_object_info_seq_loc.cpp.

void CGuiObjectInfoSeq_loc::GetToolTip ( ITooltipFormatter tooltip,
string t_title,
TSeqPos  at_p = (TSeqPos)-1 
) const
virtual

Get tooltip.

The tooltip may contain HTML tags.

Parameters
tooltiptooltip content
t_titletooltip title (can be empty)
at_puser-interested sequence pos. For some cases, we may want to return postion-specific information, such as flanking sequence around that postion, along with other object information. It is optional. (TSeqPos)-1 means no postion is provided.

Implements IGuiObjectInfo.

Definition at line 145 of file gui_object_info_seq_loc.cpp.

References ITooltipFormatter::AddRow(), CLabel::eDescriptionBrief, CLabel::GetLabel(), m_Object, and m_Scope.

virtual string CGuiObjectInfoSeq_loc::GetType ( void  ) const
inlinevirtual

Implements IGuiObjectInfo.

Definition at line 51 of file gui_object_info_seq_loc.cpp.

virtual string CGuiObjectInfoSeq_loc::GetViewCategory ( ) const
inlinevirtual

To share default view between different types.

Implements IGuiObjectInfo.

Definition at line 57 of file gui_object_info_seq_loc.cpp.

Member Data Documentation

CConstRef<CObject> CGuiObjectInfoSeq_loc::m_Object
private

Definition at line 60 of file gui_object_info_seq_loc.cpp.

Referenced by CreateObject(), GetLabel(), and GetToolTip().

CRef<objects::CScope> CGuiObjectInfoSeq_loc::m_Scope
mutableprivate

Definition at line 61 of file gui_object_info_seq_loc.cpp.

Referenced by CreateObject(), GetLabel(), and GetToolTip().

enum CGuiObjectInfoSeq_loc::ESubtype CGuiObjectInfoSeq_loc::m_Subtype
private

Referenced by CreateObject(), and GetIcon().


The documentation for this class was generated from the following file:
Modified on Fri Apr 20 12:42:29 2018 by modify_doxy.py rev. 546573