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

Search Toolkit Book for CBoundaryParams

IBoundaryParams. More...

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

+ Inheritance diagram for CBoundaryParams:
+ Collaboration diagram for CBoundaryParams:

Public Member Functions

 CBoundaryParams ()
 
 CBoundaryParams (bool show_boundary, bool show_bg, const CRgbaColor &fg, const CRgbaColor &bg, TModelUnit w, int padding=2)
 
accessors
bool ShowBoundary () const
 
bool ShowBackground () const
 
const CRgbaColorGetBgColor () const
 
const CRgbaColorGetFgColor () const
 
TModelUnit GetLineWidth () const
 
int GetPadding () const
 
mutators
void SetShowBoundary (bool flag)
 
void SetShowBackground (bool flag)
 
void SetBgColor (const CRgbaColor &flag)
 
void SetFgColor (const CRgbaColor &flag)
 
void SetLineWidth (TModelUnit flag)
 
void SetPadding (int p)
 
- 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
 

Private Attributes

bool m_ShowBoundary
 
bool m_ShowBackground
 
CRgbaColor m_FgColor
 
CRgbaColor m_BgColor
 
TModelUnit m_LineWidth
 
int m_Padding
 

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

IBoundaryParams.

Definition at line 198 of file layout_group.hpp.

Constructor & Destructor Documentation

◆ CBoundaryParams() [1/2]

CBoundaryParams::CBoundaryParams ( )
inline

Definition at line 201 of file layout_group.hpp.

◆ CBoundaryParams() [2/2]

CBoundaryParams::CBoundaryParams ( bool  show_boundary,
bool  show_bg,
const CRgbaColor fg,
const CRgbaColor bg,
TModelUnit  w,
int  padding = 2 
)
inline

Definition at line 210 of file layout_group.hpp.

Member Function Documentation

◆ GetBgColor()

const CRgbaColor& CBoundaryParams::GetBgColor ( ) const
inline

Definition at line 224 of file layout_group.hpp.

References m_BgColor.

Referenced by CLayoutGroup::x_DrawBoundary().

◆ GetFgColor()

const CRgbaColor& CBoundaryParams::GetFgColor ( ) const
inline

Definition at line 225 of file layout_group.hpp.

References m_FgColor.

Referenced by CLayoutGroup::x_DrawBoundary().

◆ GetLineWidth()

TModelUnit CBoundaryParams::GetLineWidth ( ) const
inline

Definition at line 226 of file layout_group.hpp.

References m_LineWidth.

Referenced by CLayoutGroup::x_DrawBoundary().

◆ GetPadding()

int CBoundaryParams::GetPadding ( ) const
inline

Definition at line 227 of file layout_group.hpp.

References m_Padding.

Referenced by CLayoutGroup::x_UpdateBoundingBox().

◆ SetBgColor()

void CBoundaryParams::SetBgColor ( const CRgbaColor flag)
inline

Definition at line 234 of file layout_group.hpp.

References m_BgColor.

Referenced by CSixFramesTransTrack::x_LoadSettings().

◆ SetFgColor()

void CBoundaryParams::SetFgColor ( const CRgbaColor flag)
inline

Definition at line 235 of file layout_group.hpp.

References m_FgColor.

◆ SetLineWidth()

void CBoundaryParams::SetLineWidth ( TModelUnit  flag)
inline

Definition at line 236 of file layout_group.hpp.

References m_LineWidth.

◆ SetPadding()

void CBoundaryParams::SetPadding ( int  p)
inline

Definition at line 237 of file layout_group.hpp.

References m_Padding.

◆ SetShowBackground()

void CBoundaryParams::SetShowBackground ( bool  flag)
inline

Definition at line 233 of file layout_group.hpp.

References m_ShowBackground.

Referenced by CSixFramesTransTrack::x_LoadSettings().

◆ SetShowBoundary()

void CBoundaryParams::SetShowBoundary ( bool  flag)
inline

Definition at line 232 of file layout_group.hpp.

References m_ShowBoundary.

Referenced by CSixFramesTransTrack::x_LoadSettings().

◆ ShowBackground()

bool CBoundaryParams::ShowBackground ( ) const
inline

Definition at line 223 of file layout_group.hpp.

References m_ShowBackground.

Referenced by CLayoutGroup::x_DrawBoundary().

◆ ShowBoundary()

bool CBoundaryParams::ShowBoundary ( ) const
inline

Definition at line 222 of file layout_group.hpp.

References m_ShowBoundary.

Referenced by CLayoutGroup::x_DrawBoundary().

Member Data Documentation

◆ m_BgColor

CRgbaColor CBoundaryParams::m_BgColor
private

Definition at line 244 of file layout_group.hpp.

Referenced by GetBgColor(), and SetBgColor().

◆ m_FgColor

CRgbaColor CBoundaryParams::m_FgColor
private

Definition at line 243 of file layout_group.hpp.

Referenced by GetFgColor(), and SetFgColor().

◆ m_LineWidth

TModelUnit CBoundaryParams::m_LineWidth
private

Definition at line 245 of file layout_group.hpp.

Referenced by GetLineWidth(), and SetLineWidth().

◆ m_Padding

int CBoundaryParams::m_Padding
private

Definition at line 246 of file layout_group.hpp.

Referenced by GetPadding(), and SetPadding().

◆ m_ShowBackground

bool CBoundaryParams::m_ShowBackground
private

Definition at line 242 of file layout_group.hpp.

Referenced by SetShowBackground(), and ShowBackground().

◆ m_ShowBoundary

bool CBoundaryParams::m_ShowBoundary
private

Definition at line 241 of file layout_group.hpp.

Referenced by SetShowBoundary(), and ShowBoundary().


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