LibreOffice Module sc (master): ScDataAreaExtras Struct Reference

LibreOffice Module sc (master) 1

Struct to hold non-data extended area, used with ScDocument::ShrinkToUsedDataArea(). More...

#include <sortparam.hxx>

Public Types
enum class	Clip { None , Col , Row }

Public Member Functions
bool	anyExtrasWanted () const

void	resetArea ()

bool	operator== (const ScDataAreaExtras &rOther) const

void	GetOverallRange (SCCOL &nCol1, SCROW &nRow1, SCCOL &nCol2, SCROW &nRow2, Clip eClip=Clip::None) const
	Obtain the overall range if area extras are larger. More...

void	SetOverallRange (SCCOL nCol1, SCROW nRow1, SCCOL nCol2, SCROW nRow2)
	Set the overall range. More...

Public Attributes
bool	mbCellNotes = false
	If TRUE, consider the presence of cell notes besides data. More...

bool	mbCellDrawObjects = false
	If TRUE, consider the presence of draw objects anchored to the cell. More...

bool	mbCellFormats = false
	If TRUE, consider the presence of cell formats. More...

SCCOL	mnStartCol = SCCOL_MAX

SCROW	mnStartRow = SCROW_MAX

SCCOL	mnEndCol = -1

SCROW	mnEndRow = -1

Detailed Description

Struct to hold non-data extended area, used with ScDocument::ShrinkToUsedDataArea().

Definition at line 52 of file sortparam.hxx.

Member Enumeration Documentation

◆ Clip

enum class ScDataAreaExtras::Clip

strong

Enumerator
None
Col
Row

Definition at line 76 of file sortparam.hxx.

Member Function Documentation

◆ anyExtrasWanted()

bool ScDataAreaExtras::anyExtrasWanted ( ) const

inline

Definition at line 65 of file sortparam.hxx.

References mbCellDrawObjects, mbCellFormats, and mbCellNotes.

Referenced by sc::UndoSort::Execute(), ScTable::Reorder(), ScTable::Sort(), and ScDBDocFunc::Sort().

◆ GetOverallRange()

void ScDataAreaExtras::GetOverallRange	(	SCCOL &	nCol1,
		SCROW &	nRow1,
		SCCOL &	nCol2,
		SCROW &	nRow2,
		Clip	eClip = `Clip::None`
	)		const

inline

Obtain the overall range if area extras are larger.

Definition at line 84 of file sortparam.hxx.

References Col, mnEndCol, mnEndRow, mnStartCol, mnStartRow, and Row.

Referenced by lcl_reduceBlock(), and ScDBDocFunc::Sort().

◆ operator==()

bool ScDataAreaExtras::operator== ( const ScDataAreaExtras & rOther ) const

inline

Definition at line 68 of file sortparam.hxx.

References mbCellDrawObjects, mbCellFormats, and mbCellNotes.

◆ resetArea()

void ScDataAreaExtras::resetArea ( )

inline

Definition at line 66 of file sortparam.hxx.

References mnEndCol, mnEndRow, mnStartCol, mnStartRow, SCCOL_MAX, and SCROW_MAX.

Referenced by ScSortParam::ScSortParam(), and ScDBDocFunc::Sort().

◆ SetOverallRange()

void ScDataAreaExtras::SetOverallRange	(	SCCOL	nCol1,
		SCROW	nRow1,
		SCCOL	nCol2,
		SCROW	nRow2
	)

inline

Set the overall range.

Definition at line 103 of file sortparam.hxx.

References mnEndCol, mnEndRow, mnStartCol, and mnStartRow.

Referenced by ScDBDocFunc::Sort().

Member Data Documentation

◆ mbCellDrawObjects

bool ScDataAreaExtras::mbCellDrawObjects = false

If TRUE, consider the presence of draw objects anchored to the cell.

Definition at line 57 of file sortparam.hxx.

Referenced by anyExtrasWanted(), ScSortParam::Clear(), ScCellShell::ExecuteDB(), ScTabPageSortOptions::FillItemSet(), ScColumn::GetDataExtrasAt(), ScColumn::GetLastDataPos(), lcl_reduceBlock(), operator==(), ScTabPageSortOptions::Reset(), ScSortParam::ScSortParam(), ScTable::ShrinkToUsedDataArea(), ScTable::SortReorderAreaExtrasByRow(), and ScGridWindow::UpdateAutoFilterFromMenu().

◆ mbCellFormats

bool ScDataAreaExtras::mbCellFormats = false

If TRUE, consider the presence of cell formats.

Definition at line 59 of file sortparam.hxx.

Referenced by anyExtrasWanted(), ScSortParam::Clear(), ScTable::CreateSortInfoArray(), ScCellShell::ExecuteDB(), ScTabPageSortOptions::FillItemSet(), ScSortDescriptor::FillProperties(), ScSortDescriptor::FillSortParam(), ScColumn::GetDataExtrasAt(), ScColumn::GetLastDataPos(), operator==(), ScTable::Reorder(), ScTabPageSortOptions::Reset(), ScSortParam::ScSortParam(), ScTable::ShrinkToUsedDataArea(), ScTable::Sort(), ScDBDocFunc::Sort(), ScTable::SortReorderAreaExtrasByColumn(), ScTable::SortReorderAreaExtrasByRow(), ScGridWindow::UpdateAutoFilterFromMenu(), and writeSort().

◆ mbCellNotes

bool ScDataAreaExtras::mbCellNotes = false

If TRUE, consider the presence of cell notes besides data.

Definition at line 55 of file sortparam.hxx.

Referenced by anyExtrasWanted(), ScCellShell::ExecuteDB(), ScTabPageSortOptions::FillItemSet(), ScColumn::GetDataExtrasAt(), ScColumn::GetLastDataPos(), lcl_reduceBlock(), operator==(), ScTabPageSortOptions::Reset(), ScTable::ShrinkToUsedDataArea(), ScTable::SortReorderAreaExtrasByRow(), and ScGridWindow::UpdateAutoFilterFromMenu().

◆ mnEndCol

SCCOL ScDataAreaExtras::mnEndCol = -1

Definition at line 62 of file sortparam.hxx.

Referenced by sc::UndoSort::Execute(), GetOverallRange(), resetArea(), SetOverallRange(), ScTable::ShrinkToUsedDataArea(), and ScTable::SortReorderAreaExtrasByRow().

◆ mnEndRow

SCROW ScDataAreaExtras::mnEndRow = -1

Definition at line 63 of file sortparam.hxx.

Referenced by sc::UndoSort::Execute(), ScColumn::GetDataExtrasAt(), ScColumn::GetLastDataPos(), GetOverallRange(), resetArea(), SetOverallRange(), and ScTable::SortReorderAreaExtrasByColumn().

◆ mnStartCol

SCCOL ScDataAreaExtras::mnStartCol = SCCOL_MAX

Definition at line 60 of file sortparam.hxx.

Referenced by sc::UndoSort::Execute(), GetOverallRange(), resetArea(), SetOverallRange(), ScTable::ShrinkToUsedDataArea(), ScTable::Sort(), and ScTable::SortReorderAreaExtrasByRow().

◆ mnStartRow

SCROW ScDataAreaExtras::mnStartRow = SCROW_MAX

Definition at line 61 of file sortparam.hxx.

Referenced by sc::UndoSort::Execute(), ScColumn::GetDataExtrasAt(), GetOverallRange(), resetArea(), SetOverallRange(), ScTable::Sort(), and ScTable::SortReorderAreaExtrasByColumn().

The documentation for this struct was generated from the following file:

sortparam.hxx