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

Search Toolkit Book for CMarker

Help class to manage markers. More...

#include "seqgraphic_pane.hpp"
(Private to src/gui/widgets/seq_graphic.)

+ Inheritance diagram for CMarker:
+ Collaboration diagram for CMarker:

Public Member Functions

 CMarker ()
 
void Render (CGlPane &pane, CSeqMarkHandler::ERenderingOption option)
 
void SetLabel (const string &label)
 
const stringGetLabel () const
 
void SetPos (TModelUnit pos)
 
TSeqPos GetPos () const
 
void SetExtendedPos (TModelUnit pos)
 
void SetRange (TSeqRange range)
 
TSeqPos GetExtendedPos () const
 
void SetColor (const CRgbaColor &color)
 
const CRgbaColorGetColor () const
 
void SetRemoved (bool f)
 
bool IsRemoved () const
 
CSeqMarkHandler::EMarkerType GetMarkerType () const
 
void SetMarkerType (CSeqMarkHandler::EMarkerType t)
 
void SetFlipped (bool f)
 
bool GetFlipped () const
 
- 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

bool m_Deleted
 
CSeqMarkHandler m_Handler
 

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...
 
- 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

Help class to manage markers.

It is intended to manage (rename/remove) marker easier.

Definition at line 86 of file seqgraphic_pane.hpp.

Constructor & Destructor Documentation

◆ CMarker()

CMarker::CMarker ( )
inline

Definition at line 89 of file seqgraphic_pane.hpp.

Member Function Documentation

◆ GetColor()

const CRgbaColor& CMarker::GetColor ( void  ) const
inline

Definition at line 118 of file seqgraphic_pane.hpp.

References CSeqMarkHandler::GetColor(), and m_Handler.

◆ GetExtendedPos()

TSeqPos CMarker::GetExtendedPos ( ) const
inline

Definition at line 112 of file seqgraphic_pane.hpp.

References CSeqMarkHandler::GetExtendedPos(), and m_Handler.

◆ GetFlipped()

bool CMarker::GetFlipped ( ) const
inline

Definition at line 136 of file seqgraphic_pane.hpp.

References CSeqMarkHandler::GetFlipped(), and m_Handler.

◆ GetLabel()

const string& CMarker::GetLabel ( void  ) const
inline

Definition at line 97 of file seqgraphic_pane.hpp.

References CSeqMarkHandler::GetLabel(), and m_Handler.

◆ GetMarkerType()

CSeqMarkHandler::EMarkerType CMarker::GetMarkerType ( ) const
inline

Definition at line 127 of file seqgraphic_pane.hpp.

References CSeqMarkHandler::GetMarkerType(), and m_Handler.

◆ GetPos()

TSeqPos CMarker::GetPos ( void  ) const
inline

Definition at line 103 of file seqgraphic_pane.hpp.

References CSeqMarkHandler::GetPos(), and m_Handler.

◆ IsRemoved()

bool CMarker::IsRemoved ( void  ) const
inline

Definition at line 124 of file seqgraphic_pane.hpp.

References m_Deleted.

◆ Render()

void CMarker::Render ( CGlPane pane,
CSeqMarkHandler::ERenderingOption  option 
)
inline

Definition at line 91 of file seqgraphic_pane.hpp.

References m_Handler, option, and CSeqMarkHandler::Render().

◆ SetColor()

void CMarker::SetColor ( const CRgbaColor color)
inline

◆ SetExtendedPos()

void CMarker::SetExtendedPos ( TModelUnit  pos)
inline

Definition at line 106 of file seqgraphic_pane.hpp.

References m_Handler, and CSeqMarkHandler::SetExtendedPos().

Referenced by CSeqGraphicPane::AddRangeMarker().

◆ SetFlipped()

void CMarker::SetFlipped ( bool  f)
inline

Definition at line 133 of file seqgraphic_pane.hpp.

References f(), m_Handler, and CSeqMarkHandler::SetFlipped().

Referenced by CSeqGraphicPane::x_AddNewMarker().

◆ SetLabel()

void CMarker::SetLabel ( const string label)
inline

◆ SetMarkerType()

void CMarker::SetMarkerType ( CSeqMarkHandler::EMarkerType  t)
inline

◆ SetPos()

void CMarker::SetPos ( TModelUnit  pos)
inline

◆ SetRange()

void CMarker::SetRange ( TSeqRange  range)
inline

◆ SetRemoved()

void CMarker::SetRemoved ( bool  f)
inline

Definition at line 121 of file seqgraphic_pane.hpp.

References f(), and m_Deleted.

Member Data Documentation

◆ m_Deleted

bool CMarker::m_Deleted

Definition at line 140 of file seqgraphic_pane.hpp.

Referenced by IsRemoved(), and SetRemoved().

◆ m_Handler

CSeqMarkHandler CMarker::m_Handler

The documentation for this class was generated from the following file:
Modified on Fri Dec 01 04:44:38 2023 by modify_doxy.py rev. 669887