Stores frame styles of an array of cells, supports merged ranges. More...

#include <framelinkarray.hxx>

Public Member Functions
	Array ()
	Constructs an empty array. More...

	~Array ()
	Destructs the array. More...

void	Initialize (sal_Int32 nWidth, sal_Int32 nHeight)
	Reinitializes the array with the specified size. More...

sal_Int32	GetColCount () const
	Returns the number of columns in the array. More...

sal_Int32	GetRowCount () const
	Returns the number of rows in the array. More...

sal_Int32	GetCellCount () const
	Returns the number of cells in the array. More...

sal_Int32	GetCellIndex (sal_Int32 nCol, sal_Int32 nRow, bool bRTL) const
	Returns the cell index from the cell address (nCol,nRow). More...

void	SetCellStyleLeft (sal_Int32 nCol, sal_Int32 nRow, const Style &rStyle)
	Sets the left frame style of the cell (nCol,nRow). More...

void	SetCellStyleRight (sal_Int32 nCol, sal_Int32 nRow, const Style &rStyle)
	Sets the right frame style of the cell (nCol,nRow). More...

void	SetCellStyleTop (sal_Int32 nCol, sal_Int32 nRow, const Style &rStyle)
	Sets the top frame style of the cell (nCol,nRow). More...

void	SetCellStyleBottom (sal_Int32 nCol, sal_Int32 nRow, const Style &rStyle)
	Sets the bottom frame style of the specified cell (nCol,nRow). More...

void	SetCellStyleTLBR (sal_Int32 nCol, sal_Int32 nRow, const Style &rStyle)
	Sets the top-left to bottom-right frame style of the cell (nCol,nRow). More...

void	SetCellStyleBLTR (sal_Int32 nCol, sal_Int32 nRow, const Style &rStyle)
	Sets the bottom-left to top-right frame style of the cell (nCol,nRow). More...

void	SetCellStyleDiag (sal_Int32 nCol, sal_Int32 nRow, const Style &rTLBR, const Style &rBLTR)
	Sets both diagonal frame styles of the specified cell (nCol,nRow). More...

void	SetColumnStyleLeft (sal_Int32 nCol, const Style &rStyle)
	Sets the left frame style of the specified column. More...

void	SetColumnStyleRight (sal_Int32 nCol, const Style &rStyle)
	Sets the right frame style of the specified column. More...

void	SetRowStyleTop (sal_Int32 nRow, const Style &rStyle)
	Sets the top frame style of the specified row. More...

void	SetRowStyleBottom (sal_Int32 nRow, const Style &rStyle)
	Sets the bottom frame style of the specified row. More...

void	SetCellRotation (sal_Int32 nCol, sal_Int32 nRow, SvxRotateMode eRotMode, double fOrientation)
	Sets the rotation parameters of the cell (nCol,nRow). More...

bool	HasCellRotation () const
	Check if at least one cell is rotated. More...

const Style &	GetCellStyleLeft (sal_Int32 nCol, sal_Int32 nRow) const
	Returns the left frame style of the cell (nCol,nRow). More...

const Style &	GetCellStyleRight (sal_Int32 nCol, sal_Int32 nRow) const
	Returns the right frame style of the cell (nCol,nRow). More...

const Style &	GetCellStyleTop (sal_Int32 nCol, sal_Int32 nRow) const
	Returns the top frame style of the cell (nCol,nRow). More...

const Style &	GetCellStyleBottom (sal_Int32 nCol, sal_Int32 nRow) const
	Returns the top frame style of the cell (nCol,nRow). More...

const Style &	GetCellStyleTLBR (sal_Int32 nCol, sal_Int32 nRow) const
	Returns the top-left to bottom-right frame style of the cell (nCol,nRow). More...

const Style &	GetCellStyleBLTR (sal_Int32 nCol, sal_Int32 nRow) const
	Returns the bottom-left to top-right frame style of the cell (nCol,nRow). More...

const Style &	GetCellStyleTL (sal_Int32 nCol, sal_Int32 nRow) const
	Returns the top-left to bottom-right frame style of the cell (nCol,nRow). More...

const Style &	GetCellStyleBR (sal_Int32 nCol, sal_Int32 nRow) const
	Returns the top-left to bottom-right frame style of the cell (nCol,nRow). More...

const Style &	GetCellStyleBL (sal_Int32 nCol, sal_Int32 nRow) const
	Returns the bottom-left to top-right frame style of the cell (nCol,nRow). More...

const Style &	GetCellStyleTR (sal_Int32 nCol, sal_Int32 nRow) const
	Returns the bottom-left to top-right frame style of the cell (nCol,nRow). More...

void	SetMergedRange (sal_Int32 nFirstCol, sal_Int32 nFirstRow, sal_Int32 nLastCol, sal_Int32 nLastRow)
	Inserts a new merged cell range. More...

void	SetAddMergedLeftSize (sal_Int32 nCol, sal_Int32 nRow, sal_Int32 nAddSize)
	Sets an additional left width for the merged range that contains (nCol,nRow). More...

void	SetAddMergedRightSize (sal_Int32 nCol, sal_Int32 nRow, sal_Int32 nAddSize)
	Sets an additional right width for the merged range that contains (nCol,nRow). More...

void	SetAddMergedTopSize (sal_Int32 nCol, sal_Int32 nRow, sal_Int32 nAddSize)
	Sets an additional top height for the merged range that contains (nCol,nRow). More...

void	SetAddMergedBottomSize (sal_Int32 nCol, sal_Int32 nRow, sal_Int32 nAddSize)
	Sets an additional bottom height for the merged range that contains (nCol,nRow). More...

bool	IsMerged (sal_Int32 nCol, sal_Int32 nRow) const
	Returns true, if the cell (nCol,nRow) is part of a merged range. More...

void	GetMergedOrigin (sal_Int32 &rnFirstCol, sal_Int32 &rnFirstRow, sal_Int32 nCol, sal_Int32 nRow) const
	Returns the address of the top-left cell of the merged range that contains (nCol,nRow). More...

void	GetMergedRange (sal_Int32 &rnFirstCol, sal_Int32 &rnFirstRow, sal_Int32 &rnLastCol, sal_Int32 &rnLastRow, sal_Int32 nCol, sal_Int32 nRow) const
	Returns the top-left and bottom-right address of the merged range that contains (nCol,nRow). More...

void	SetClipRange (sal_Int32 nFirstCol, sal_Int32 nFirstRow, sal_Int32 nLastCol, sal_Int32 nLastRow)
	Sets a clipping range. More...

void	SetXOffset (sal_Int32 nXOffset)
	Sets the X output coordinate of the left column. More...

void	SetYOffset (sal_Int32 nYOffset)
	Sets the Y output coordinate of the top row. More...

void	SetColWidth (sal_Int32 nCol, sal_Int32 nWidth)
	Sets the output width of the specified column. More...

void	SetRowHeight (sal_Int32 nRow, sal_Int32 nHeight)
	Sets the output height of the specified row. More...

void	SetAllColWidths (sal_Int32 nWidth)
	Sets the same output width for all columns. More...

void	SetAllRowHeights (sal_Int32 nHeight)
	Sets the same output height for all rows. More...

sal_Int32	GetColPosition (sal_Int32 nCol) const
	Returns the X output coordinate of the left border of the specified column. More...

sal_Int32	GetRowPosition (sal_Int32 nRow) const
	Returns the Y output coordinate of the top border of the specified row. More...

sal_Int32	GetColWidth (sal_Int32 nFirstCol, sal_Int32 nLastCol) const
	Returns the output width of the specified range of columns. More...

sal_Int32	GetRowHeight (sal_Int32 nFirstRow, sal_Int32 nLastRow) const
	Returns the output height of the specified range of rows. More...

sal_Int32	GetWidth () const
	Returns the output width of the entire array. More...

sal_Int32	GetHeight () const
	Returns the output height of the entire array. More...

basegfx::B2DRange	GetCellRange (sal_Int32 nCol, sal_Int32 nRow) const
	Returns the output range of the cell (nCol,nRow). More...

basegfx::B2DRange	GetB2DRange (sal_Int32 nFirstCol, sal_Int32 nFirstRow, sal_Int32 nLastCol, sal_Int32 nLastRow) const

void	MirrorSelfX ()
	Mirrors the entire array horizontally. More...

drawinglayer::primitive2d::Primitive2DContainer	CreateB2DPrimitiveRange (sal_Int32 nFirstCol, sal_Int32 nFirstRow, sal_Int32 nLastCol, sal_Int32 nLastRow, const Color *pForceColor) const
	Draws the part of the specified range, that is inside the clipping range. More...

drawinglayer::primitive2d::Primitive2DContainer	CreateB2DPrimitiveArray () const
	Draws the part of the array, that is inside the clipping range. More...

Private Attributes
std::unique_ptr< ArrayImpl >	mxImpl

Detailed Description

Stores frame styles of an array of cells, supports merged ranges.

This class is able to store the frame styles of an array of cells and to draw the entire array or parts of it to any output device.

Every cell contains the style of the left, right, top, bottom, top-left to bottom-right, and bottom-left to top-right frame border.

On drawing, the thicker frame border of neighbored cells is selected automatically. All borders are drawn "connected", that means, the correct start and end coordinates of all lines of the borders are calculated, especially, if they are drawn together with diagonal frame borders.

This array fully supports merged cell ranges. In a merged range, the frame borders of the top-left cell is extended to the entire range, and all other cells in that range are overlapped. Again, all connected frame borders, also diagonals and frame borders from adjacent merged ranges, are handled automatically.

Additionally, a clipping range can be set. If such a range is used, all frame borders outside this range are completely ignored, and are not used in the connected border calculation anymore.

The array can be mirrored in both directions. It is possible to specify, whether to mirror the double frame styles, and whether to swap diagonal frame borders.

Definition at line 62 of file framelinkarray.hxx.

Constructor & Destructor Documentation

◆ Array()

svx::frame::Array::Array ( )

explicit

Constructs an empty array.

Definition at line 558 of file framelinkarray.cxx.

References Initialize().

◆ ~Array()

svx::frame::Array::~Array ( )

Destructs the array.

Definition at line 563 of file framelinkarray.cxx.

Member Function Documentation

◆ CreateB2DPrimitiveArray()

drawinglayer::primitive2d::Primitive2DContainer svx::frame::Array::CreateB2DPrimitiveArray ( ) const

Draws the part of the array, that is inside the clipping range.

Definition at line 1581 of file framelinkarray.cxx.

References CreateB2DPrimitiveRange(), and mxImpl.

Referenced by sdr::contact::createPrimitive2DSequenceImpl(), and svx::FrameSelectorImpl::DrawAllFrameBorders().

◆ CreateB2DPrimitiveRange()

drawinglayer::primitive2d::Primitive2DContainer svx::frame::Array::CreateB2DPrimitiveRange	(	sal_Int32	nFirstCol,
		sal_Int32	nFirstRow,
		sal_Int32	nLastCol,
		sal_Int32	nLastRow,
		const Color *	pForceColor
	)		const

Draws the part of the specified range, that is inside the clipping range.

Parameters

pForceColor If not NULL, only this color will be used to draw all frame borders.

Definition at line 1300 of file framelinkarray.cxx.

References aData, drawinglayer::primitive2d::Primitive2DContainer::append(), Cell, CELL, basegfx::utils::createPolygonFromRect(), DBG_FRAME_CHECK_COLROW, basegfx::Tuple2D< typename TYPE >::equalZero(), GetB2DRange(), GetCellStyleBLTR(), GetCellStyleBottom(), GetCellStyleLeft(), GetCellStyleRight(), GetCellStyleTLBR(), GetCellStyleTop(), GetColCount(), basegfx::utils::getColumn(), GetMergedRange(), GetRowCount(), svx::frame::HelperCreateBLTREntry(), svx::frame::HelperCreateHorizontalEntry(), svx::frame::HelperCreateTLBREntry(), svx::frame::HelperCreateVerticalEntry(), basegfx::Range2D< typename TYPE, typename TRAITS >::intersect(), basegfx::Range2D< typename TYPE, typename TRAITS >::isEmpty(), IsRotated(), svx::frame::Style::IsUsed(), and mxImpl.

Referenced by CreateB2DPrimitiveArray().

◆ GetB2DRange()

basegfx::B2DRange svx::frame::Array::GetB2DRange	(	sal_Int32	nFirstCol,
		sal_Int32	nFirstRow,
		sal_Int32	nLastCol,
		sal_Int32	nLastRow
	)		const

Definition at line 1044 of file framelinkarray.cxx.

References vcl::unotools::b2DRectangleFromRectangle(), GetColPosition(), GetColWidth(), GetRowHeight(), and GetRowPosition().

Referenced by CreateB2DPrimitiveRange().

◆ GetCellCount()

sal_Int32 svx::frame::Array::GetCellCount ( ) const

Returns the number of cells in the array.

Definition at line 583 of file framelinkarray.cxx.

References mxImpl.

Referenced by MirrorSelfX().

◆ GetCellIndex()

sal_Int32 svx::frame::Array::GetCellIndex	(	sal_Int32	nCol,
		sal_Int32	nRow,
		bool	bRTL
	)		const

Returns the cell index from the cell address (nCol,nRow).

Definition at line 588 of file framelinkarray.cxx.

References DBG_FRAME_CHECK_COLROW, and mxImpl.

◆ GetCellRange()

basegfx::B2DRange svx::frame::Array::GetCellRange	(	sal_Int32	nCol,
		sal_Int32	nRow
	)		const

Returns the output range of the cell (nCol,nRow).

Returns total output range of merged ranges.

Definition at line 1012 of file framelinkarray.cxx.

References tools::Rectangle::AdjustBottom(), tools::Rectangle::AdjustLeft(), tools::Rectangle::AdjustRight(), tools::Rectangle::AdjustTop(), vcl::unotools::b2DRectangleFromRectangle(), Cell, CELL, GetColPosition(), GetColWidth(), GetRowHeight(), GetRowPosition(), and mxImpl.

Referenced by svx::FrameSelectorImpl::InitBorderGeometry().

◆ GetCellStyleBL()

const Style & svx::frame::Array::GetCellStyleBL	(	sal_Int32	nCol,
		sal_Int32	nRow
	)		const

Returns the bottom-left to top-right frame style of the cell (nCol,nRow).

Returns: The bottom-left to top-right frame style, if the cell is not part of a merged range, or if (nCol,nRow) is the bottom-left corner of a merged range (useful to find connected frame styles). An invisible style for invalid cell addresses.

Definition at line 815 of file framelinkarray.cxx.

References CELL, mxImpl, and svx::frame::OBJ_STYLE_NONE.

Referenced by svx::frame::HelperCreateHorizontalEntry(), and svx::frame::HelperCreateVerticalEntry().

◆ GetCellStyleBLTR()

const Style & svx::frame::Array::GetCellStyleBLTR	(	sal_Int32	nCol,
		sal_Int32	nRow
	)		const

Returns the bottom-left to top-right frame style of the cell (nCol,nRow).

Ignores merged ranges;

Returns: The bottom-left to top-right frame style or an invisible style for invalid cell addresses.

Definition at line 786 of file framelinkarray.cxx.

References CELL.

Referenced by CreateB2DPrimitiveRange().

◆ GetCellStyleBottom()

const Style & svx::frame::Array::GetCellStyleBottom	(	sal_Int32	nCol,
		sal_Int32	nRow
	)		const

Returns the top frame style of the cell (nCol,nRow).

Returns thicker of own top style or bottom style of the cell above. Returns the style only if visible (i.e. at top border of a merged range).

Returns: The top frame style or an invisible style for invalid cell addresses.

Definition at line 763 of file framelinkarray.cxx.

References LASTCELL, mxImpl, svx::frame::OBJ_STYLE_NONE, and ORIGCELL.

Referenced by CreateB2DPrimitiveRange(), svx::frame::HelperCreateBLTREntry(), svx::frame::HelperCreateTLBREntry(), and svx::frame::HelperCreateVerticalEntry().

◆ GetCellStyleBR()

const Style & svx::frame::Array::GetCellStyleBR	(	sal_Int32	nCol,
		sal_Int32	nRow
	)		const

Returns the top-left to bottom-right frame style of the cell (nCol,nRow).

Returns: The top-left to bottom-right frame style, if the cell is not part of a merged range, or if (nCol,nRow) is the bottom-right corner of a merged range (useful to find connected frame styles). An invisible style for invalid cell addresses.

Definition at line 803 of file framelinkarray.cxx.

References CELL, mxImpl, and svx::frame::OBJ_STYLE_NONE.

Referenced by svx::frame::HelperCreateHorizontalEntry(), and svx::frame::HelperCreateVerticalEntry().

◆ GetCellStyleLeft()

const Style & svx::frame::Array::GetCellStyleLeft	(	sal_Int32	nCol,
		sal_Int32	nRow
	)		const

Returns the left frame style of the cell (nCol,nRow).

Returns thicker of own left style or right style of the cell to the left. Returns the style only if visible (i.e. at left border of a merged range).

Returns: The left frame style or an invisible style for invalid cell addresses.

Definition at line 709 of file framelinkarray.cxx.

References mxImpl, svx::frame::OBJ_STYLE_NONE, and ORIGCELL.

Referenced by CreateB2DPrimitiveRange(), svx::frame::HelperCreateBLTREntry(), svx::frame::HelperCreateHorizontalEntry(), svx::frame::HelperCreateTLBREntry(), and svx::frame::HelperCreateVerticalEntry().

◆ GetCellStyleRight()

const Style & svx::frame::Array::GetCellStyleRight	(	sal_Int32	nCol,
		sal_Int32	nRow
	)		const

Returns the right frame style of the cell (nCol,nRow).

Returns thicker of own right style or left style of the cell to the right. Returns the style only if visible (i.e. at right border of a merged range).

Returns: The left frame style or an invisible style for invalid cell addresses.

Definition at line 727 of file framelinkarray.cxx.

References LASTCELL, mxImpl, svx::frame::OBJ_STYLE_NONE, and ORIGCELL.

Referenced by CreateB2DPrimitiveRange(), svx::frame::HelperCreateBLTREntry(), svx::frame::HelperCreateHorizontalEntry(), and svx::frame::HelperCreateTLBREntry().

◆ GetCellStyleTL()

const Style & svx::frame::Array::GetCellStyleTL	(	sal_Int32	nCol,
		sal_Int32	nRow
	)		const

Returns the top-left to bottom-right frame style of the cell (nCol,nRow).

Returns: The top-left to bottom-right frame style, if the cell is not part of a merged range, or if (nCol,nRow) is the top-left corner of a merged range (useful to find connected frame styles). An invisible style for invalid cell addresses.

Definition at line 791 of file framelinkarray.cxx.

References CELL, mxImpl, and svx::frame::OBJ_STYLE_NONE.

Referenced by svx::frame::HelperCreateHorizontalEntry(), and svx::frame::HelperCreateVerticalEntry().

◆ GetCellStyleTLBR()

const Style & svx::frame::Array::GetCellStyleTLBR	(	sal_Int32	nCol,
		sal_Int32	nRow
	)		const

Returns the top-left to bottom-right frame style of the cell (nCol,nRow).

Ignores merged ranges;

Returns: The top-left to bottom-right frame style or an invisible style for invalid cell addresses.

Definition at line 781 of file framelinkarray.cxx.

References CELL.

Referenced by CreateB2DPrimitiveRange().

◆ GetCellStyleTop()

const Style & svx::frame::Array::GetCellStyleTop	(	sal_Int32	nCol,
		sal_Int32	nRow
	)		const

Returns the top frame style of the cell (nCol,nRow).

Returns thicker of own top style or bottom style of the cell above. Returns the style only if visible (i.e. at top border of a merged range).

Returns: The top frame style or an invisible style for invalid cell addresses.

Definition at line 745 of file framelinkarray.cxx.

References mxImpl, svx::frame::OBJ_STYLE_NONE, and ORIGCELL.

Referenced by CreateB2DPrimitiveRange(), svx::frame::HelperCreateBLTREntry(), svx::frame::HelperCreateHorizontalEntry(), svx::frame::HelperCreateTLBREntry(), and svx::frame::HelperCreateVerticalEntry().

◆ GetCellStyleTR()

const Style & svx::frame::Array::GetCellStyleTR	(	sal_Int32	nCol,
		sal_Int32	nRow
	)		const

Returns the bottom-left to top-right frame style of the cell (nCol,nRow).

Returns: The bottom-left to top-right frame style, if the cell is not part of a merged range, or if (nCol,nRow) is the top-right corner of a merged range (useful to find connected frame styles). An invisible style for invalid cell addresses.

Definition at line 827 of file framelinkarray.cxx.

References CELL, mxImpl, and svx::frame::OBJ_STYLE_NONE.

Referenced by svx::frame::HelperCreateHorizontalEntry(), and svx::frame::HelperCreateVerticalEntry().

◆ GetColCount()

sal_Int32 svx::frame::Array::GetColCount ( ) const

Returns the number of columns in the array.

Definition at line 573 of file framelinkarray.cxx.

References mxImpl.

Referenced by CreateB2DPrimitiveRange(), svx::FrameSelectorImpl::DrawAllFrameBorders(), and svx::FrameSelectorImpl::InitBorderGeometry().

◆ GetColPosition()

sal_Int32 svx::frame::Array::GetColPosition ( sal_Int32 nCol ) const

Returns the X output coordinate of the left border of the specified column.

@descr The column index <array-width> returns the X output coordinate of the right array border.

Definition at line 976 of file framelinkarray.cxx.

References DBG_FRAME_CHECK_COL_1, and mxImpl.

Referenced by GetB2DRange(), GetCellRange(), GetColWidth(), and GetWidth().

◆ GetColWidth()

sal_Int32 svx::frame::Array::GetColWidth	(	sal_Int32	nFirstCol,
		sal_Int32	nLastCol
	)		const

Returns the output width of the specified range of columns.

Definition at line 988 of file framelinkarray.cxx.

References DBG_FRAME_CHECK_COL, and GetColPosition().

Referenced by GetB2DRange(), and GetCellRange().

◆ GetHeight()

sal_Int32 svx::frame::Array::GetHeight ( ) const

Returns the output height of the entire array.

Definition at line 1007 of file framelinkarray.cxx.

References GetRowPosition(), and mxImpl.

◆ GetMergedOrigin()

void svx::frame::Array::GetMergedOrigin	(	sal_Int32 &	rnFirstCol,
		sal_Int32 &	rnFirstRow,
		sal_Int32	nCol,
		sal_Int32	nRow
	)		const

Returns the address of the top-left cell of the merged range that contains (nCol,nRow).

Definition at line 911 of file framelinkarray.cxx.

References DBG_FRAME_CHECK_COLROW, and mxImpl.

Referenced by GetMergedRange().

◆ GetMergedRange()

void svx::frame::Array::GetMergedRange	(	sal_Int32 &	rnFirstCol,
		sal_Int32 &	rnFirstRow,
		sal_Int32 &	rnLastCol,
		sal_Int32 &	rnLastRow,
		sal_Int32	nCol,
		sal_Int32	nRow
	)		const

Returns the top-left and bottom-right address of the merged range that contains (nCol,nRow).

Definition at line 918 of file framelinkarray.cxx.

References GetMergedOrigin(), and mxImpl.

Referenced by CreateB2DPrimitiveRange().

◆ GetRowCount()

sal_Int32 svx::frame::Array::GetRowCount ( ) const

Returns the number of rows in the array.

Definition at line 578 of file framelinkarray.cxx.

References mxImpl.

Referenced by CreateB2DPrimitiveRange(), svx::FrameSelectorImpl::DrawAllFrameBorders(), and svx::FrameSelectorImpl::InitBorderGeometry().

◆ GetRowHeight()

sal_Int32 svx::frame::Array::GetRowHeight	(	sal_Int32	nFirstRow,
		sal_Int32	nLastRow
	)		const

Returns the output height of the specified range of rows.

Definition at line 995 of file framelinkarray.cxx.

References DBG_FRAME_CHECK_ROW, and GetRowPosition().

Referenced by GetB2DRange(), and GetCellRange().

◆ GetRowPosition()

sal_Int32 svx::frame::Array::GetRowPosition ( sal_Int32 nRow ) const

Returns the Y output coordinate of the top border of the specified row.

@descr The row index <array-height> returns the Y output coordinate of the bottom array border.

Definition at line 982 of file framelinkarray.cxx.

References DBG_FRAME_CHECK_ROW_1, and mxImpl.

Referenced by GetB2DRange(), GetCellRange(), GetHeight(), and GetRowHeight().

◆ GetWidth()

sal_Int32 svx::frame::Array::GetWidth ( ) const

Returns the output width of the entire array.

Definition at line 1002 of file framelinkarray.cxx.

References GetColPosition(), and mxImpl.

◆ HasCellRotation()

bool svx::frame::Array::HasCellRotation ( ) const

Check if at least one cell is rotated.

Definition at line 698 of file framelinkarray.cxx.

References mxImpl.

◆ Initialize()

void svx::frame::Array::Initialize	(	sal_Int32	nWidth,
		sal_Int32	nHeight
	)

Reinitializes the array with the specified size.

Clears all styles.

Definition at line 568 of file framelinkarray.cxx.

References mxImpl.

Referenced by Array(), sdr::contact::createPrimitive2DSequenceImpl(), and svx::FrameSelectorImpl::InitBorderGeometry().

◆ IsMerged()

bool svx::frame::Array::IsMerged	(	sal_Int32	nCol,
		sal_Int32	nRow
	)		const

Returns true, if the cell (nCol,nRow) is part of a merged range.

Definition at line 905 of file framelinkarray.cxx.

References CELL, and DBG_FRAME_CHECK_COLROW.

◆ MirrorSelfX()

void svx::frame::Array::MirrorSelfX ( )

Mirrors the entire array horizontally.

Definition at line 1053 of file framelinkarray.cxx.

References Cell, CELL, GetCellCount(), and mxImpl.

◆ SetAddMergedBottomSize()

void svx::frame::Array::SetAddMergedBottomSize	(	sal_Int32	nCol,
		sal_Int32	nRow,
		sal_Int32	nAddSize
	)

Sets an additional bottom height for the merged range that contains (nCol,nRow).

@descr Useful to handle merged ranges that are not completely part of the array. @precond The merged range must be at the bottom border of the array.

Definition at line 893 of file framelinkarray.cxx.

References Cell, CELL, DBG_FRAME_CHECK, DBG_FRAME_CHECK_COLROW, mxImpl, and PUTCELL.

◆ SetAddMergedLeftSize()

void svx::frame::Array::SetAddMergedLeftSize	(	sal_Int32	nCol,
		sal_Int32	nRow,
		sal_Int32	nAddSize
	)

Sets an additional left width for the merged range that contains (nCol,nRow).

@descr Useful to handle merged ranges that are not completely part of the array. @precond The merged range must be at the left border of the array.

Definition at line 857 of file framelinkarray.cxx.

References Cell, CELL, DBG_FRAME_CHECK, DBG_FRAME_CHECK_COLROW, mxImpl, and PUTCELL.

◆ SetAddMergedRightSize()

void svx::frame::Array::SetAddMergedRightSize	(	sal_Int32	nCol,
		sal_Int32	nRow,
		sal_Int32	nAddSize
	)

Sets an additional right width for the merged range that contains (nCol,nRow).

@descr Useful to handle merged ranges that are not completely part of the array. @precond The merged range must be at the right border of the array.

Definition at line 869 of file framelinkarray.cxx.

References Cell, CELL, DBG_FRAME_CHECK, DBG_FRAME_CHECK_COLROW, mxImpl, and PUTCELL.

◆ SetAddMergedTopSize()

void svx::frame::Array::SetAddMergedTopSize	(	sal_Int32	nCol,
		sal_Int32	nRow,
		sal_Int32	nAddSize
	)

Sets an additional top height for the merged range that contains (nCol,nRow).

@descr Useful to handle merged ranges that are not completely part of the array. @precond The merged range must be at the top border of the array.

Definition at line 881 of file framelinkarray.cxx.

References Cell, CELL, DBG_FRAME_CHECK, DBG_FRAME_CHECK_COLROW, mxImpl, and PUTCELL.

◆ SetAllColWidths()

void svx::frame::Array::SetAllColWidths ( sal_Int32 nWidth )

Sets the same output width for all columns.

Definition at line 964 of file framelinkarray.cxx.

References mxImpl.

Referenced by svx::FrameSelectorImpl::InitBorderGeometry().

◆ SetAllRowHeights()

void svx::frame::Array::SetAllRowHeights ( sal_Int32 nHeight )

Sets the same output height for all rows.

Definition at line 970 of file framelinkarray.cxx.

References mxImpl.

Referenced by svx::FrameSelectorImpl::InitBorderGeometry().

◆ SetCellRotation()

void svx::frame::Array::SetCellRotation	(	sal_Int32	nCol,
		sal_Int32	nRow,
		SvxRotateMode	eRotMode,
		double	fOrientation
	)

Sets the rotation parameters of the cell (nCol,nRow).

Ignores merged ranges.

Definition at line 682 of file framelinkarray.cxx.

References Cell, CELL, DBG_FRAME_CHECK_COLROW, mxImpl, and PUTCELL.

◆ SetCellStyleBLTR()

void svx::frame::Array::SetCellStyleBLTR	(	sal_Int32	nCol,
		sal_Int32	nRow,
		const Style &	rStyle
	)

Sets the bottom-left to top-right frame style of the cell (nCol,nRow).

Ignores merged ranges.

Definition at line 637 of file framelinkarray.cxx.

References Cell, CELL, DBG_FRAME_CHECK_COLROW, and PUTCELL.

◆ SetCellStyleBottom()

void svx::frame::Array::SetCellStyleBottom	(	sal_Int32	nCol,
		sal_Int32	nRow,
		const Style &	rStyle
	)

Sets the bottom frame style of the specified cell (nCol,nRow).

Ignores merged ranges.

Definition at line 621 of file framelinkarray.cxx.

References Cell, CELL, DBG_FRAME_CHECK_COLROW, and PUTCELL.

Referenced by sdr::contact::createPrimitive2DSequenceImpl(), and SetRowStyleBottom().

◆ SetCellStyleDiag()

void svx::frame::Array::SetCellStyleDiag	(	sal_Int32	nCol,
		sal_Int32	nRow,
		const Style &	rTLBR,
		const Style &	rBLTR
	)

Sets both diagonal frame styles of the specified cell (nCol,nRow).

Ignores merged ranges.

Definition at line 645 of file framelinkarray.cxx.

References Cell, CELL, DBG_FRAME_CHECK_COLROW, and PUTCELL.

Referenced by svx::FrameSelectorImpl::DrawAllFrameBorders().

◆ SetCellStyleLeft()

void svx::frame::Array::SetCellStyleLeft	(	sal_Int32	nCol,
		sal_Int32	nRow,
		const Style &	rStyle
	)

Sets the left frame style of the cell (nCol,nRow).

Ignores merged ranges.

Definition at line 597 of file framelinkarray.cxx.

References Cell, CELL, DBG_FRAME_CHECK_COLROW, and PUTCELL.

Referenced by sdr::contact::createPrimitive2DSequenceImpl(), and SetColumnStyleLeft().

◆ SetCellStyleRight()

void svx::frame::Array::SetCellStyleRight	(	sal_Int32	nCol,
		sal_Int32	nRow,
		const Style &	rStyle
	)

Sets the right frame style of the cell (nCol,nRow).

Ignores merged ranges.

Definition at line 605 of file framelinkarray.cxx.

References Cell, CELL, DBG_FRAME_CHECK_COLROW, and PUTCELL.

Referenced by sdr::contact::createPrimitive2DSequenceImpl(), and SetColumnStyleRight().

◆ SetCellStyleTLBR()

void svx::frame::Array::SetCellStyleTLBR	(	sal_Int32	nCol,
		sal_Int32	nRow,
		const Style &	rStyle
	)

Sets the top-left to bottom-right frame style of the cell (nCol,nRow).

Ignores merged ranges.

Definition at line 629 of file framelinkarray.cxx.

References Cell, CELL, DBG_FRAME_CHECK_COLROW, and PUTCELL.

◆ SetCellStyleTop()

void svx::frame::Array::SetCellStyleTop	(	sal_Int32	nCol,
		sal_Int32	nRow,
		const Style &	rStyle
	)

Sets the top frame style of the cell (nCol,nRow).

Ignores merged ranges.

Definition at line 613 of file framelinkarray.cxx.

References Cell, CELL, DBG_FRAME_CHECK_COLROW, and PUTCELL.

Referenced by sdr::contact::createPrimitive2DSequenceImpl(), and SetRowStyleTop().

◆ SetClipRange()

void svx::frame::Array::SetClipRange	(	sal_Int32	nFirstCol,
		sal_Int32	nFirstRow,
		sal_Int32	nLastCol,
		sal_Int32	nLastRow
	)

Sets a clipping range.

@descr No cell borders outside of this clipping range will be drawn. In difference to simply using the CreateB2DPrimitiveRange() function with the same range, a clipping range causes the drawing functions to completely ignore the frame styles connected from outside. This is used i.e. in Calc to print single pages and to draw the print preview. Partly visible diagonal frame borders in merged ranges are correctly clipped too. This array can handle only one clip range at a time.

Definition at line 927 of file framelinkarray.cxx.

References DBG_FRAME_CHECK_COLROW, and mxImpl.

◆ SetColumnStyleLeft()

void svx::frame::Array::SetColumnStyleLeft	(	sal_Int32	nCol,
		const Style &	rStyle
	)

Sets the left frame style of the specified column.

Ignores merged ranges.

Definition at line 654 of file framelinkarray.cxx.

References DBG_FRAME_CHECK_COL, mxImpl, and SetCellStyleLeft().

Referenced by svx::FrameSelectorImpl::DrawAllFrameBorders().

◆ SetColumnStyleRight()

void svx::frame::Array::SetColumnStyleRight	(	sal_Int32	nCol,
		const Style &	rStyle
	)

Sets the right frame style of the specified column.

Ignores merged ranges.

Definition at line 661 of file framelinkarray.cxx.

References DBG_FRAME_CHECK_COL, mxImpl, and SetCellStyleRight().

Referenced by svx::FrameSelectorImpl::DrawAllFrameBorders().

◆ SetColWidth()

void svx::frame::Array::SetColWidth	(	sal_Int32	nCol,
		sal_Int32	nWidth
	)

Sets the output width of the specified column.

Definition at line 950 of file framelinkarray.cxx.

References DBG_FRAME_CHECK_COL, and mxImpl.

Referenced by sdr::contact::createPrimitive2DSequenceImpl().

◆ SetMergedRange()

void svx::frame::Array::SetMergedRange	(	sal_Int32	nFirstCol,
		sal_Int32	nFirstRow,
		sal_Int32	nLastCol,
		sal_Int32	nLastRow
	)

Inserts a new merged cell range.

@precond The range must not intersect other merged ranges.

Definition at line 840 of file framelinkarray.cxx.

References CELL, DBG_FRAME_CHECK, DBG_FRAME_CHECK_COLROW, svx::frame::lclSetMergedRange(), and mxImpl.

Referenced by sdr::contact::createPrimitive2DSequenceImpl().

◆ SetRowHeight()

void svx::frame::Array::SetRowHeight	(	sal_Int32	nRow,
		sal_Int32	nHeight
	)

Sets the output height of the specified row.

Definition at line 957 of file framelinkarray.cxx.

References DBG_FRAME_CHECK_ROW, and mxImpl.

Referenced by sdr::contact::createPrimitive2DSequenceImpl().

◆ SetRowStyleBottom()

void svx::frame::Array::SetRowStyleBottom	(	sal_Int32	nRow,
		const Style &	rStyle
	)

Sets the bottom frame style of the specified row.

Ignores merged ranges.

Definition at line 675 of file framelinkarray.cxx.

References DBG_FRAME_CHECK_ROW, mxImpl, and SetCellStyleBottom().

Referenced by svx::FrameSelectorImpl::DrawAllFrameBorders().

◆ SetRowStyleTop()

void svx::frame::Array::SetRowStyleTop	(	sal_Int32	nRow,
		const Style &	rStyle
	)

Sets the top frame style of the specified row.

Ignores merged ranges.

Definition at line 668 of file framelinkarray.cxx.

References DBG_FRAME_CHECK_ROW, mxImpl, and SetCellStyleTop().

Referenced by svx::FrameSelectorImpl::DrawAllFrameBorders().

◆ SetXOffset()

void svx::frame::Array::SetXOffset ( sal_Int32 nXOffset )

Sets the X output coordinate of the left column.

Definition at line 938 of file framelinkarray.cxx.

References mxImpl.

Referenced by svx::FrameSelectorImpl::InitBorderGeometry().

◆ SetYOffset()

void svx::frame::Array::SetYOffset ( sal_Int32 nYOffset )

Sets the Y output coordinate of the top row.

Definition at line 944 of file framelinkarray.cxx.

References mxImpl.

Referenced by svx::FrameSelectorImpl::InitBorderGeometry().

Member Data Documentation

◆ mxImpl

std::unique_ptr<ArrayImpl> svx::frame::Array::mxImpl

private

The documentation for this class was generated from the following files:

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Array()

◆ ~Array()

Member Function Documentation

◆ CreateB2DPrimitiveArray()

◆ CreateB2DPrimitiveRange()

◆ GetB2DRange()

◆ GetCellCount()

◆ GetCellIndex()

◆ GetCellRange()

◆ GetCellStyleBL()

◆ GetCellStyleBLTR()

◆ GetCellStyleBottom()

◆ GetCellStyleBR()

◆ GetCellStyleLeft()

◆ GetCellStyleRight()

◆ GetCellStyleTL()

◆ GetCellStyleTLBR()

◆ GetCellStyleTop()

◆ GetCellStyleTR()

◆ GetColCount()

◆ GetColPosition()

◆ GetColWidth()

◆ GetHeight()

◆ GetMergedOrigin()

◆ GetMergedRange()

◆ GetRowCount()

◆ GetRowHeight()

◆ GetRowPosition()

◆ GetWidth()

◆ HasCellRotation()

◆ Initialize()

◆ IsMerged()

◆ MirrorSelfX()

◆ SetAddMergedBottomSize()

◆ SetAddMergedLeftSize()

◆ SetAddMergedRightSize()

◆ SetAddMergedTopSize()

◆ SetAllColWidths()

◆ SetAllRowHeights()

◆ SetCellRotation()

◆ SetCellStyleBLTR()

◆ SetCellStyleBottom()

◆ SetCellStyleDiag()

◆ SetCellStyleLeft()

◆ SetCellStyleRight()

◆ SetCellStyleTLBR()

◆ SetCellStyleTop()

◆ SetClipRange()

◆ SetColumnStyleLeft()

◆ SetColumnStyleRight()

◆ SetColWidth()

◆ SetMergedRange()

◆ SetRowHeight()

◆ SetRowStyleBottom()

◆ SetRowStyleTop()

◆ SetXOffset()

◆ SetYOffset()

Member Data Documentation

◆ mxImpl