Dtk_OneCell Class Reference

Allows the representation of cell. More...

Public Member Functions
void	AddAdditionnalGeometries (Dtk_tab< Dtk_EntityPtr > inAdditionnalGeometries)
	Adds some additionnal geometries to the Dtk_OneCell. More...
void	Delete_Text ()
	Affects _text to null in order not to read the text which is inside. More...
	Dtk_OneCell ()
	Base constructor. More...
	Dtk_OneCell (const Dtk_OneCell &inToBeCopied)
	Dtk_OneCell (Dtk_OneCell &&inToBeMoved) DTK_NOEXCEPT
Dtk_Int32	DtkDynamicType (const int &inId)
	Retrieves the dynamic entity type. More...
Dtk_Double64	get_min_Height ()
	Gets the original height. More...
Dtk_Double64	get_min_Width ()
	Gets the original width of the Dtk_Onecell. More...
const Dtk_tab< Dtk_EntityPtr > &	GetAdditionnalGeometries () const
	Retrieves the additionnal geometries of the Dtk_OneCell. More...
Dtk_Size_t &	getAnchor ()
	Gets the Dtk_OneCell anchor. More...
Dtk_Int32	GetBorderBottomBlanked ()
	Gets BorderBottomBlanked of Bottom border. More...
const Dtk_RGB &	GetBorderBottomColor ()
	Gets BorderBottomColor of Bottom border. More...
Dtk_Int32	GetBorderLeftBlanked ()
	Gets BorderLeftBlanked of Left border. More...
const Dtk_RGB &	GetBorderLeftColor ()
	Gets BorderLeftColor of Left border. More...
Dtk_Int32	GetBorderRightBlanked ()
	Gets BorderRightBlanked of Right border. More...
const Dtk_RGB &	GetBorderRightColor ()
	Gets BorderRightColor of Right border. More...
Dtk_Int32	GetBorderTopBlanked ()
	Gets BorderTopBlanked of Top border. More...
const Dtk_RGB &	GetBorderTopColor ()
	Gets BorderTopColor of Top border. More...
Dtk_Double64	getHeight () const
	Gets the height of the Dtk_OneCell. More...
Dtk_justication_type &	getJustification ()
	Gets the Dtk_OneCell justification. More...
Dtk_Int32	getnbCells_Left_Right () const
	Gets the Dtk_OneCell nbCells_Left_Right. More...
Dtk_Int32	getnbCells_Top_Bottom () const
	Gets the number of cells at the bottom or left of the Dtk_OneCell. More...
Dtk_CompositeText &	GetText ()
	Gets the text witch is in the Dtk_OneCell. More...
const Dtk_CompositeText &	GetText () const
Dtk_Double64	getWidth () const
	Gets the width of the Dtk_OneCell. More...
Dtk_bool	HasText () const
bool	Merged_Cell_Horizontally ()
	Tests if the cell is composed of cells merged horizontally. More...
bool	Merged_Cell_Vertically ()
	tests if the cell is composed of cells merged vertically. More...
Dtk_OneCell &	operator= (const Dtk_OneCell &inToBeAssigned)
	Assignment Operator. More...
Dtk_OneCell &	operator= (Dtk_OneCell &&inToBeMoved)
	\MoveOp{inToBeMoved} More...
void	set_min_Height (const double &inHeight)
	Sets the Dtk_OneCell min_Height. More...
void	set_min_Width (const double &min_Width)
	Sets the Dtk_OneCell min_Width. More...
void	setAnchor (const Dtk_Size_t &inNumberOfAnchor)
	Set anchor of text. More...
void	SetBorderBottomBlanked (const Dtk_Int32 &inBorderBottomBlanked)
	Sets BorderBottomBlanked of Bottom border. More...
void	SetBorderBottomColor (const Dtk_Int32 &inBorderBottomColor)
	Sets BorderBottomColor of Bottom border. More...
void	SetBorderBottomColor (const Dtk_RGB &inBorderBottomColor)
void	SetBorderLeftBlanked (const Dtk_Int32 &inBorderLeftBlanked)
	Sets BorderLeftBlanked of Left border. More...
void	SetBorderLeftColor (const Dtk_Int32 &inBorderLeftColor)
	Sets BorderLeftColor of Left border. More...
void	SetBorderLeftColor (const Dtk_RGB &inBorderLeftColor)
void	SetBorderRightBlanked (const Dtk_Int32 &inBorderRightBlanked)
	Sets BorderRightBlanked of Right border. More...
void	SetBorderRightColor (const Dtk_Int32 &inBorderRightColor)
	Sets BorderRightColor of Right border. More...
void	SetBorderRightColor (const Dtk_RGB &inBorderRightColor)
void	SetBorderTopBlanked (const Dtk_Int32 &inBorderTopBlanked)
	Sets BorderTopBlanked of Top border. More...
void	SetBorderTopColor (const Dtk_Int32 &inBorderTopColor)
	Sets BorderTopColor of Top border. More...
void	SetBorderTopColor (const Dtk_RGB &inBorderTopColor)
void	setHeight (const double &inHeight)
	Sets the Dtk_OneCell height. More...
void	setJustification (const Dtk_justication_type &inNewJustification)
	Sets justification. More...
void	setnbCells_Left_Right (const Dtk_Size_t &inNewVal)
	Sets nbCells_Left_Right. More...
void	setnbCells_Top_Bottom (const Dtk_Size_t &inNewVal)
	Sets nbCells_Top_Bottom. More...
void	SetText (Dtk_CompositeText text)
	Sets the text in the Dtk_OneCell. More...
void	setWidth (const double &inWidth)
	Sets the Dtk_OneCell Width. More...
	~Dtk_OneCell ()
	Destructor. More...

Static Public Member Functions
static Dtk_OneCell *	DtkDynamicCast (Dtk_Object *s)
	Performs a dynamic cast - doesn't need RTTI -. More...

Protected Types
enum	{ _typeID = DTK_TYPE_CELL }

Protected Member Functions
void	_CopyC (const Dtk_OneCell &cell)
void	_InitC ()
void	_ResetC ()

Protected Attributes
Dtk_tab< Dtk_EntityPtr >	_AdditionnalGeometries
	Added geometries for Dtk_OneCell. More...
Dtk_Int32	_BorderBottomBlanked
Dtk_RGB	_BorderBottomColor
Dtk_Int32	_BorderLeftBlanked
Dtk_RGB	_BorderLeftColor
Dtk_Int32	_BorderRightBlanked
Dtk_RGB	_BorderRightColor
Dtk_Int32	_BorderTopBlanked
Dtk_RGB	_BorderTopColor
Dtk_bool	_HasText
Dtk_Double64	_Height
	The real height (before and after mergers). More...
Dtk_CompositeText	_text
Dtk_Double64	_Width
	The real width (before and after mergers). More...
Dtk_Size_t	anchor
	Defines the anchor texts. More...
Dtk_justication_type	justification
	Text justification. More...
Dtk_Double64	min_Height
	The original height before mergers. More...
Dtk_Double64	min_Width
	The original width before mergers. More...
Dtk_Int32	nbCells_Left_Right
	Number of adjacent cells to the left or right. More...
Dtk_Int32	nbCells_Top_Bottom
	Number of adjacent cells at the top or bottom. More...

Detailed Description

Allows the representation of cell.

min_Height: The original height before mergers.

min_Width: The original width before mergers.

nbCells_Left_Right: Number of adjacent cells to the left or right.

nbCells_Top_Bottom: Number of adjacent cells at the top or bottom.

Member Enumeration Documentation

anonymous enum

anonymous enum

protected

Enumerator
_typeID

     {
          _typeID = DTK_TYPE_CELL
     };

Constructor & Destructor Documentation

Dtk_OneCell() [1/3]

Dtk_OneCell::Dtk_OneCell

(

)

Base constructor.

Dtk_OneCell() [2/3]

Dtk_OneCell::Dtk_OneCell

(

const Dtk_OneCell &

inToBeCopied

)

Dtk_OneCell() [3/3]

Dtk_OneCell::Dtk_OneCell

(

Dtk_OneCell &&

inToBeMoved

)

~Dtk_OneCell()

Dtk_OneCell::~Dtk_OneCell

(

)

Destructor.

Member Function Documentation

_CopyC()

void Dtk_OneCell::_CopyC ( const Dtk_OneCell &  cell )

protected

_InitC()

void Dtk_OneCell::_InitC ( )

protected

_ResetC()

void Dtk_OneCell::_ResetC ( )

protected

AddAdditionnalGeometries()

void Dtk_OneCell::AddAdditionnalGeometries

(

Dtk_tab< Dtk_EntityPtr >

inAdditionnalGeometries

)

Adds some additionnal geometries to the Dtk_OneCell.

Parameters

inAdditionnalGeometries

The geometries to be added

Delete_Text()

void Dtk_OneCell::Delete_Text

(

)

Affects _text to null in order not to read the text which is inside.

DtkDynamicCast()

static Dtk_OneCell* Dtk_OneCell::DtkDynamicCast ( Dtk_Object *  s )

static

Performs a dynamic cast - doesn't need RTTI -.

DtkDynamicType()

Dtk_Int32 Dtk_OneCell::DtkDynamicType

(

const int &

inId

)

Retrieves the dynamic entity type.

get_min_Height()

Dtk_Double64 Dtk_OneCell::get_min_Height

(

)

Gets the original height.

Returns

min_Height

get_min_Width()

Dtk_Double64 Dtk_OneCell::get_min_Width

(

)

Gets the original width of the Dtk_Onecell.

Returns

min_Width

GetAdditionnalGeometries()

const Dtk_tab< Dtk_EntityPtr >& Dtk_OneCell::GetAdditionnalGeometries

(

)

const

Retrieves the additionnal geometries of the Dtk_OneCell.

Returns

The additionnal geometries array - read only -.

getAnchor()

Dtk_Size_t& Dtk_OneCell::getAnchor

(

)

Gets the Dtk_OneCell anchor.

Returns

anchor;

GetBorderBottomBlanked()

Dtk_Int32 Dtk_OneCell::GetBorderBottomBlanked

(

)

Gets BorderBottomBlanked of Bottom border.

Returns

BorderBottomBlanked DTK_TRUE is blanked

GetBorderBottomColor()

const Dtk_RGB& Dtk_OneCell::GetBorderBottomColor

(

)

Gets BorderBottomColor of Bottom border.

Returns

BorderBottomColor

GetBorderLeftBlanked()

Dtk_Int32 Dtk_OneCell::GetBorderLeftBlanked

(

)

Gets BorderLeftBlanked of Left border.

Returns

BorderLeftBlanked DTK_TRUE is blanked

GetBorderLeftColor()

const Dtk_RGB& Dtk_OneCell::GetBorderLeftColor

(

)

Gets BorderLeftColor of Left border.

Returns

BorderLeftColor

GetBorderRightBlanked()

Dtk_Int32 Dtk_OneCell::GetBorderRightBlanked

(

)

Gets BorderRightBlanked of Right border.

Returns

BorderRightBlanked DTK_TRUE is blanked

GetBorderRightColor()

const Dtk_RGB& Dtk_OneCell::GetBorderRightColor

(

)

Gets BorderRightColor of Right border.

Returns

BorderRightColor

GetBorderTopBlanked()

Dtk_Int32 Dtk_OneCell::GetBorderTopBlanked

(

)

Gets BorderTopBlanked of Top border.

Returns

BorderTopBlanked DTK_TRUE is blanked

GetBorderTopColor()

const Dtk_RGB& Dtk_OneCell::GetBorderTopColor

(

)

Gets BorderTopColor of Top border.

Returns

BorderTopColor

getHeight()

Dtk_Double64 Dtk_OneCell::getHeight

(

)

const

Gets the height of the Dtk_OneCell.

Returns

_Height

getJustification()

Dtk_justication_type& Dtk_OneCell::getJustification

(

)

Gets the Dtk_OneCell justification.

Returns

text justification

getnbCells_Left_Right()

Dtk_Int32 Dtk_OneCell::getnbCells_Left_Right

(

)

const

Gets the Dtk_OneCell nbCells_Left_Right.

Returns

nbCells_Left_Right

getnbCells_Top_Bottom()

Dtk_Int32 Dtk_OneCell::getnbCells_Top_Bottom

(

)

const

Gets the number of cells at the bottom or left of the Dtk_OneCell.

Returns

nbCells_Top_Bottom

GetText() [1/2]

Dtk_CompositeText& Dtk_OneCell::GetText

(

)

Gets the text witch is in the Dtk_OneCell.

Returns

_text

GetText() [2/2]

const Dtk_CompositeText& Dtk_OneCell::GetText

(

)

const

getWidth()

Dtk_Double64 Dtk_OneCell::getWidth

(

)

const

Gets the width of the Dtk_OneCell.

Returns

_Width

HasText()

Dtk_bool Dtk_OneCell::HasText

(

)

const

{return _HasText;}

Merged_Cell_Horizontally()

bool Dtk_OneCell::Merged_Cell_Horizontally

(

)

Tests if the cell is composed of cells merged horizontally.

Returns

true or false

Merged_Cell_Vertically()

bool Dtk_OneCell::Merged_Cell_Vertically

(

)

tests if the cell is composed of cells merged vertically.

Returns

true or false

operator=() [1/2]

Dtk_OneCell& Dtk_OneCell::operator=

(

const Dtk_OneCell &

inToBeAssigned

)

Assignment Operator.

Parameters

inToBeAssigned

Object to copy.

operator=() [2/2]

Dtk_OneCell& Dtk_OneCell::operator=

(

Dtk_OneCell &&

inToBeMoved

)

\MoveOp{inToBeMoved}

set_min_Height()

void Dtk_OneCell::set_min_Height

(

const double &

inHeight

)

Sets the Dtk_OneCell min_Height.

Parameters

inHeight

The new height used to set min_Height

set_min_Width()

void Dtk_OneCell::set_min_Width

(

const double &

min_Width

)

Sets the Dtk_OneCell min_Width.

Parameters

inWidth

The new width used to set min_Width

setAnchor()

void Dtk_OneCell::setAnchor

(

const Dtk_Size_t &

inNumberOfAnchor

)

Set anchor of text.

Parameters

inNumberOfAnchor

The new number of anchor

SetBorderBottomBlanked()

void Dtk_OneCell::SetBorderBottomBlanked

(

const Dtk_Int32 &

inBorderBottomBlanked

)

Sets BorderBottomBlanked of Bottom border.

Parameters

inBorderBottomBlanked

: Blanked Status of the Bottom border

SetBorderBottomColor() [1/2]

void Dtk_OneCell::SetBorderBottomColor

(

const Dtk_Int32 &

inBorderBottomColor

)

Sets BorderBottomColor of Bottom border.

Parameters

inBorderBottomColor

: color of the Bottom border

SetBorderBottomColor() [2/2]

void Dtk_OneCell::SetBorderBottomColor

(

const Dtk_RGB &

inBorderBottomColor

)

SetBorderLeftBlanked()

void Dtk_OneCell::SetBorderLeftBlanked

(

const Dtk_Int32 &

inBorderLeftBlanked

)

Sets BorderLeftBlanked of Left border.

Parameters

inBorderLeftBlanked

: Blanked Status of the Left border

SetBorderLeftColor() [1/2]

void Dtk_OneCell::SetBorderLeftColor

(

const Dtk_Int32 &

inBorderLeftColor

)

Sets BorderLeftColor of Left border.

Parameters

inBorderLeftColor

: color of the Left border

SetBorderLeftColor() [2/2]

void Dtk_OneCell::SetBorderLeftColor

(

const Dtk_RGB &

inBorderLeftColor

)

SetBorderRightBlanked()

void Dtk_OneCell::SetBorderRightBlanked

(

const Dtk_Int32 &

inBorderRightBlanked

)

Sets BorderRightBlanked of Right border.

Parameters

inBorderRightBlanked

: Blanked Status of the Right border

SetBorderRightColor() [1/2]

void Dtk_OneCell::SetBorderRightColor

(

const Dtk_Int32 &

inBorderRightColor

)

Sets BorderRightColor of Right border.

Parameters

inBorderRightColor

: color of the Right border

SetBorderRightColor() [2/2]

void Dtk_OneCell::SetBorderRightColor

(

const Dtk_RGB &

inBorderRightColor

)

SetBorderTopBlanked()

void Dtk_OneCell::SetBorderTopBlanked

(

const Dtk_Int32 &

inBorderTopBlanked

)

Sets BorderTopBlanked of Top border.

Parameters

inBorderTopBlanked

: Blanked Status of the Top border

SetBorderTopColor() [1/2]

void Dtk_OneCell::SetBorderTopColor

(

const Dtk_Int32 &

inBorderTopColor

)

Sets BorderTopColor of Top border.

Parameters

inBorderTopColor

: color of the Top border

SetBorderTopColor() [2/2]

void Dtk_OneCell::SetBorderTopColor

(

const Dtk_RGB &

inBorderTopColor

)

setHeight()

void Dtk_OneCell::setHeight

(

const double &

inHeight

)

Sets the Dtk_OneCell height.

Parameters

inHeight

The new height used to set _Height

setJustification()

void Dtk_OneCell::setJustification

(

const Dtk_justication_type &

inNewJustification

)

Sets justification.

Parameters

inNewJustification

The new Justification

setnbCells_Left_Right()

void Dtk_OneCell::setnbCells_Left_Right

(

const Dtk_Size_t &

inNewVal

)

Sets nbCells_Left_Right.

Parameters

inNewVal

The new int used to set nbCells_Left_Right

setnbCells_Top_Bottom()

void Dtk_OneCell::setnbCells_Top_Bottom

(

const Dtk_Size_t &

inNewVal

)

Sets nbCells_Top_Bottom.

Parameters

inNewVal

The new int used to set nbCells_Top_Bottom

SetText()

void Dtk_OneCell::SetText

(

Dtk_CompositeText

text

)

Sets the text in the Dtk_OneCell.

Parameters

text	The new text used to set _text

setWidth()

void Dtk_OneCell::setWidth

(

const double &

inWidth

)

Sets the Dtk_OneCell Width.

Parameters

inWidth

The new width used to set _Width

Field Documentation

_AdditionnalGeometries

Dtk_tab<Dtk_EntityPtr> Dtk_OneCell::_AdditionnalGeometries

protected

Added geometries for Dtk_OneCell.

_BorderBottomBlanked

Dtk_Int32 Dtk_OneCell::_BorderBottomBlanked

protected

_BorderBottomColor

Dtk_RGB Dtk_OneCell::_BorderBottomColor

protected

_BorderLeftBlanked

Dtk_Int32 Dtk_OneCell::_BorderLeftBlanked

protected

_BorderLeftColor

Dtk_RGB Dtk_OneCell::_BorderLeftColor

protected

_BorderRightBlanked

Dtk_Int32 Dtk_OneCell::_BorderRightBlanked

protected

_BorderRightColor

Dtk_RGB Dtk_OneCell::_BorderRightColor

protected

_BorderTopBlanked

Dtk_Int32 Dtk_OneCell::_BorderTopBlanked

protected

_BorderTopColor

Dtk_RGB Dtk_OneCell::_BorderTopColor

protected

_HasText

Dtk_bool Dtk_OneCell::_HasText

protected

_Height

Dtk_Double64 Dtk_OneCell::_Height

protected

The real height (before and after mergers).

_text

Dtk_CompositeText Dtk_OneCell::_text

protected

_Width

Dtk_Double64 Dtk_OneCell::_Width

protected

The real width (before and after mergers).

anchor

Dtk_Size_t Dtk_OneCell::anchor

protected

Defines the anchor texts.

justification

Dtk_justication_type Dtk_OneCell::justification

protected

Text justification.

min_Height

Dtk_Double64 Dtk_OneCell::min_Height

protected

The original height before mergers.

min_Width

Dtk_Double64 Dtk_OneCell::min_Width

protected

The original width before mergers.

nbCells_Left_Right

Dtk_Int32 Dtk_OneCell::nbCells_Left_Right

protected

Number of adjacent cells to the left or right.

nbCells_Top_Bottom

Dtk_Int32 Dtk_OneCell::nbCells_Top_Bottom

protected

Number of adjacent cells at the top or bottom.