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

Search Toolkit Book for CCommentConfig

CCommentConfig – help config class for holding a set of settings for a comment glyph. More...

#include <gui/widgets/seq_graphic/comment_glyph.hpp>

+ Inheritance diagram for CCommentConfig:
+ Collaboration diagram for CCommentConfig:

Public Types

enum  EPosition {
  ePos_Above , ePos_Below , ePos_Inside , ePos_Left ,
  ePos_Right , ePos_Any
}
 
- 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 Member Functions

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

EPosition m_RelativePos
 relative position between the comment and target. More...
 
CRgbaColor m_LabelColor
 
CRgbaColor m_LineColor
 
CGlTextureFont m_Font
 
bool m_ShowBoundary
 
bool m_ShowConnection
 display a connection between the comment and target. More...
 
bool m_Centered
 label is centered against the target. More...
 

Additional Inherited Members

- 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

CCommentConfig – help config class for holding a set of settings for a comment glyph.

Definition at line 101 of file comment_glyph.hpp.

Member Enumeration Documentation

◆ EPosition

Enumerator
ePos_Above 
ePos_Below 
ePos_Inside 
ePos_Left 
ePos_Right 
ePos_Any 

Definition at line 104 of file comment_glyph.hpp.

Constructor & Destructor Documentation

◆ CCommentConfig()

CCommentConfig::CCommentConfig ( )
inline

Definition at line 113 of file comment_glyph.hpp.

Member Data Documentation

◆ m_Centered

bool CCommentConfig::m_Centered

◆ m_Font

CGlTextureFont CCommentConfig::m_Font

◆ m_LabelColor

CRgbaColor CCommentConfig::m_LabelColor

◆ m_LineColor

CRgbaColor CCommentConfig::m_LineColor

◆ m_RelativePos

EPosition CCommentConfig::m_RelativePos

relative position between the comment and target.

Definition at line 124 of file comment_glyph.hpp.

◆ m_ShowBoundary

bool CCommentConfig::m_ShowBoundary

◆ m_ShowConnection

bool CCommentConfig::m_ShowConnection

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