NCBI C++ ToolKit
Classes | Public Member Functions | Protected Member Functions | Private Types | Private Attributes | List of all members
CPanelGrid Class Reference

Search Toolkit Book for CPanelGrid

#include "panel_grid.hpp"
(Private to src/gui/print.)

+ Inheritance diagram for CPanelGrid:
+ Collaboration diagram for CPanelGrid:

Classes

struct  SNeighbors
 

Public Member Functions

 CPanelGrid (CIdGenerator *objid_gen, unsigned int cols, unsigned int rows)
 
virtual ~CPanelGrid ()
 
TPanelRef GetPanel (unsigned int panel) const
 
TPanelRef GetPanel (unsigned int col, unsigned int row) const
 
unsigned int GetNumPanels (void) const
 
TAlignment GetVAlign (unsigned int row) const
 
TAlignment GetHAlign (unsigned int col) const
 
SNeighbors GetNeighbours (unsigned int row, unsigned int col) 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
 

Protected Member Functions

unsigned int x_GetPanelNumber (unsigned int col, unsigned int row) const
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Private Types

typedef CPrintOptions::TAlignment TAlignment
 
typedef CRef< CPanelTPanelRef
 

Private Attributes

CRef< CIdGeneratorm_ObjIdGenerator
 
unsigned int m_Cols
 
unsigned int m_Rows
 
vector< TPanelRefm_Panels
 

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

Detailed Description

Definition at line 48 of file panel_grid.hpp.

Member Typedef Documentation

◆ TAlignment

Definition at line 51 of file panel_grid.hpp.

◆ TPanelRef

typedef CRef<CPanel> CPanelGrid::TPanelRef
private

Definition at line 52 of file panel_grid.hpp.

Constructor & Destructor Documentation

◆ CPanelGrid()

CPanelGrid::CPanelGrid ( CIdGenerator objid_gen,
unsigned int  cols,
unsigned int  rows 
)

◆ ~CPanelGrid()

CPanelGrid::~CPanelGrid ( )
virtual

Definition at line 75 of file panel_grid.cpp.

Member Function Documentation

◆ GetHAlign()

CPanelGrid::TAlignment CPanelGrid::GetHAlign ( unsigned int  col) const

Definition at line 101 of file panel_grid.cpp.

References CPrintOptions::eCenter, CPrintOptions::eLeft, CPrintOptions::eRight, and m_Cols.

Referenced by CPanelGrid().

◆ GetNeighbours()

CPanelGrid::SNeighbors CPanelGrid::GetNeighbours ( unsigned int  row,
unsigned int  col 
) const

Definition at line 153 of file panel_grid.cpp.

References GetPanel(), n, and row.

Referenced by CPageHandler::x_CreatePrintersMarks().

◆ GetNumPanels()

unsigned int CPanelGrid::GetNumPanels ( void  ) const

Definition at line 147 of file panel_grid.cpp.

References m_Cols, and m_Rows.

Referenced by CPageHandler::WritePages().

◆ GetPanel() [1/2]

CRef< CPanel > CPanelGrid::GetPanel ( unsigned int  col,
unsigned int  row 
) const

Definition at line 131 of file panel_grid.cpp.

References GetPanel(), row, and x_GetPanelNumber().

◆ GetPanel() [2/2]

CRef< CPanel > CPanelGrid::GetPanel ( unsigned int  panel) const

◆ GetVAlign()

CPanelGrid::TAlignment CPanelGrid::GetVAlign ( unsigned int  row) const

Definition at line 80 of file panel_grid.cpp.

References CPrintOptions::eBottom, CPrintOptions::eMiddle, CPrintOptions::eTop, m_Rows, and row.

Referenced by CPanelGrid().

◆ x_GetPanelNumber()

unsigned int CPanelGrid::x_GetPanelNumber ( unsigned int  col,
unsigned int  row 
) const
protected

Definition at line 137 of file panel_grid.cpp.

References m_Cols, m_Rows, and row.

Referenced by CPanelGrid(), and GetPanel().

Member Data Documentation

◆ m_Cols

unsigned int CPanelGrid::m_Cols
private

Definition at line 85 of file panel_grid.hpp.

Referenced by CPanelGrid(), GetHAlign(), GetNumPanels(), and x_GetPanelNumber().

◆ m_ObjIdGenerator

CRef<CIdGenerator> CPanelGrid::m_ObjIdGenerator
private

Definition at line 83 of file panel_grid.hpp.

Referenced by CPanelGrid().

◆ m_Panels

vector<TPanelRef> CPanelGrid::m_Panels
private

Definition at line 88 of file panel_grid.hpp.

Referenced by CPanelGrid(), and GetPanel().

◆ m_Rows

unsigned int CPanelGrid::m_Rows
private

Definition at line 86 of file panel_grid.hpp.

Referenced by CPanelGrid(), GetNumPanels(), GetVAlign(), and x_GetPanelNumber().


The documentation for this class was generated from the following files:
Modified on Mon Jul 22 05:04:01 2024 by modify_doxy.py rev. 669887