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

Search Toolkit Book for CInlineLayout

CInlineLayout is the anther simple layout policy that put a list of glyphs in a single line horizontally sorted by glyph's start position. More...

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

+ Inheritance diagram for CInlineLayout:
+ Collaboration diagram for CInlineLayout:

Public Member Functions

 CInlineLayout ()
 
 CInlineLayout (bool allow_overlap)
 
virtual void BuildLayout (CLayoutGroup &group, SBoundingBox &bound) const
 CInlineLayout. More...
 
void BuildLayout (TObjectList &objs, SBoundingBox &bound) const
 
int GetTopMargin () const
 CInlineLayout inline method implementation. More...
 
void SetTopMargin (int d)
 
void SetAllowOverlap (bool flag)
 
- 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 ILayoutPolicy
virtual ~ILayoutPolicy ()
 
void SetSorter (TSorter &sorter)
 

Private Member Functions

void x_BuildLayout1Row (TObjectList &objects, SBoundingBox &bound, bool side_labeling) const
 
void x_BuildLayoutMultiRows (TObjectList &objects, SBoundingBox &bound, bool side_labeling) const
 

Private Attributes

int m_TopMargin
 
bool m_AllowOverlap
 

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 ILayoutPolicy
typedef list< CRef< CSeqGlyph > > TObjectList
 
typedef vector< CRef< CSeqGlyph > > TLayoutRow
 
typedef vector< TLayoutRowTLayout
 
typedef std::function< bool(const CRef< CSeqGlyph > &, const CRef< CSeqGlyph > &)> TSorter
 
- 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...
 
- Protected Member Functions inherited from ILayoutPolicy
void x_SeparateObjects (CLayoutGroup &group, TLayout &layout, SBoundingBox &bound, size_t group_size, int vert_space) const
 Separate objects into multiple sub-groups. More...
 
virtual void x_SetObjectPos (TLayout &layout, SBoundingBox &bound) const
 Set the objects' position (Y), and update the bounding box of the group (of all objects). More...
 
- Protected Attributes inherited from ILayoutPolicy
TSorter m_Sorter = nullptr
 

Detailed Description

CInlineLayout is the anther simple layout policy that put a list of glyphs in a single line horizontally sorted by glyph's start position.

Additionally, if a glyph has sided label, the policy will force to hide its label when there is not enough space between glyphs to fit the label.

Definition at line 86 of file simple_layout_policy.hpp.

Constructor & Destructor Documentation

◆ CInlineLayout() [1/2]

CInlineLayout::CInlineLayout ( )
inline

Definition at line 91 of file simple_layout_policy.hpp.

◆ CInlineLayout() [2/2]

CInlineLayout::CInlineLayout ( bool  allow_overlap)
inline

Definition at line 95 of file simple_layout_policy.hpp.

Member Function Documentation

◆ BuildLayout() [1/2]

void CInlineLayout::BuildLayout ( CLayoutGroup group,
SBoundingBox bound 
) const
virtual

CInlineLayout.

Implements ILayoutPolicy.

Definition at line 100 of file simple_layout_policy.cpp.

References bound(), and CLayoutGroup::GetChildren().

Referenced by CLayeredLayout::x_SetObjectPos().

◆ BuildLayout() [2/2]

void CInlineLayout::BuildLayout ( TObjectList objs,
SBoundingBox bound 
) const

◆ GetTopMargin()

int CInlineLayout::GetTopMargin ( ) const
inline

CInlineLayout inline method implementation.

Definition at line 177 of file simple_layout_policy.hpp.

References m_TopMargin.

◆ SetAllowOverlap()

void CInlineLayout::SetAllowOverlap ( bool  flag)
inline

Definition at line 189 of file simple_layout_policy.hpp.

References m_AllowOverlap.

◆ SetTopMargin()

void CInlineLayout::SetTopMargin ( int  d)
inline

Definition at line 183 of file simple_layout_policy.hpp.

References m_TopMargin.

Referenced by CLayeredLayout::x_SetObjectPos().

◆ x_BuildLayout1Row()

void CInlineLayout::x_BuildLayout1Row ( TObjectList objects,
SBoundingBox bound,
bool  side_labeling 
) const
private

◆ x_BuildLayoutMultiRows()

void CInlineLayout::x_BuildLayoutMultiRows ( TObjectList objects,
SBoundingBox bound,
bool  side_labeling 
) const
private

Member Data Documentation

◆ m_AllowOverlap

bool CInlineLayout::m_AllowOverlap
private

Definition at line 116 of file simple_layout_policy.hpp.

Referenced by BuildLayout(), and SetAllowOverlap().

◆ m_TopMargin

int CInlineLayout::m_TopMargin
private

The documentation for this class was generated from the following files:
Modified on Fri Sep 20 14:57:24 2024 by modify_doxy.py rev. 669887