LibreOffice Module sc (master) 1
Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
ScCellIterator Class Reference

Walk through all cells in an area. More...

#include <dociter.hxx>

Collaboration diagram for ScCellIterator:
[legend]

Public Member Functions

 ScCellIterator (ScDocument &rDoc, const ScRange &rRange, SubtotalFlags nSubTotalFlags=SubtotalFlags::NONE)
 
const ScAddress & GetPos () const
 
CellType getType () const
 
OUString getString () const
 
const EditTextObject * getEditText () const
 
ScFormulaCell * getFormulaCell ()
 
const ScFormulaCell * getFormulaCell () const
 
ScCellValue getCellValue () const
 
const ScRefCellValue & getRefCellValue () const
 
bool hasString () const
 
bool isEmpty () const
 
bool equalsWithoutFormat (const ScAddress &rPos) const
 
bool first ()
 
bool next ()
 

Private Types

typedef std::pair< sc::CellStoreType::const_iterator, size_t > PositionType
 

Private Member Functions

void incBlock ()
 
void incPos ()
 
void setPos (size_t nPos)
 
const ScColumn * getColumn () const
 
void init ()
 
bool getCurrent ()
 

Private Attributes

ScDocument & mrDoc
 
ScAddress maStartPos
 
ScAddress maEndPos
 
ScAddress maCurPos
 
PositionType maCurColPos
 
SubtotalFlags mnSubTotalFlags
 
ScRefCellValue maCurCell
 

Detailed Description

Walk through all cells in an area.

For SubTotal and Aggregate depending on mnSubTotalFlags.

Definition at line 205 of file dociter.hxx.

Member Typedef Documentation

◆ PositionType

typedef std::pair<sc::CellStoreType::const_iterator, size_t> ScCellIterator::PositionType
private

Definition at line 207 of file dociter.hxx.

Constructor & Destructor Documentation

◆ ScCellIterator()

ScCellIterator::ScCellIterator ( ScDocument &  rDoc,
const ScRange &  rRange,
SubtotalFlags  nSubTotalFlags = SubtotalFlags::NONE 
)

Definition at line 819 of file dociter.cxx.

References init().

Member Function Documentation

◆ equalsWithoutFormat()

bool ScCellIterator::equalsWithoutFormat ( const ScAddress &  rPos) const

Definition at line 1004 of file dociter.cxx.

References ScRefCellValue::equalsWithoutFormat(), maCurCell, and mrDoc.

◆ first()

bool ScCellIterator::first ( )

Definition at line 1010 of file dociter.cxx.

References getColumn(), getCurrent(), ScColumn::maCells, maCurColPos, maCurPos, maStartPos, ScAddress::Row(), ScAddress::Tab(), and ValidTab().

Referenced by ScChangeTrack::AppendContentsIfInRefDoc(), ScInterpreter::CreateMatrixFromDoubleRef(), ScViewFunc::DoRefConversion(), ScAccessibleCell::FillDependents(), sc::SearchResultsDlg::FillResults(), ScDetectiveFunc::FindPredLevelArea(), ScDetectiveFunc::FindSuccLevel(), ScDetectiveFunc::GetAllPreds(), ScDetectiveFunc::GetAllSuccs(), ScDocument::GetFormulaEntries(), ScAutoNameCache::GetNameOccurrences(), ScDetectiveFunc::HasError(), ScDocument::HasSubTotalCells(), ScDetectiveFunc::InsertPredLevelArea(), ScDetectiveFunc::InsertSuccLevel(), ScInterpreter::IterateParameters(), lcl_HasErrors(), ScChangeTrack::LookUpContents(), ScDetectiveFunc::MarkInvalid(), ScCompiler::ParseColRowName(), ScCompiler::ParseTableRefColumn(), ScTableLink::Refresh(), ScInterpreter::ScCountEmptyCells(), and ScTransferObj::StripRefs().

◆ getCellValue()

ScCellValue ScCellIterator::getCellValue ( ) const

Definition at line 973 of file dociter.cxx.

References CELLTYPE_EDIT, CELLTYPE_FORMULA, CELLTYPE_STRING, CELLTYPE_VALUE, ScFormulaCell::Clone(), EditTextObject::Clone(), ScRefCellValue::getDouble(), ScRefCellValue::getEditText(), ScRefCellValue::getFormula(), ScRefCellValue::getSharedString(), ScRefCellValue::getType(), and maCurCell.

Referenced by ScChangeTrack::AppendContentsIfInRefDoc(), and ScChangeTrack::LookUpContents().

◆ getColumn()

const ScColumn * ScCellIterator::getColumn ( ) const
private

Definition at line 855 of file dociter.cxx.

References ScAddress::Col(), maCurPos, ScDocument::maTabs, mrDoc, and ScAddress::Tab().

Referenced by first(), getCurrent(), and setPos().

◆ getCurrent()

bool ScCellIterator::getCurrent ( )
private

Definition at line 892 of file dociter.cxx.

References ScRefCellValue::clear(), ScAddress::Col(), sc::element_type_empty, sc::element_type_formula, ScDocument::GetAllocatedColumnsCount(), getColumn(), ScColumn::GetDoc(), ScFormulaCell::GetErrCode(), IgnoreErrVal, IgnoreFiltered, IgnoreHidden, IgnoreNestedStAg, incBlock(), ScAddress::IncCol(), incPos(), ScAddress::IncTab(), ScColumn::IsEmptyData(), ScFormulaCell::IsSubTotal(), ScColumn::maCells, maCurCell, maCurColPos, maCurPos, maEndPos, maStartPos, mnSubTotalFlags, mrDoc, NONE, ScAddress::Row(), ScDocument::RowFiltered(), ScDocument::RowHidden(), ScAddress::SetCol(), setPos(), ScAddress::SetRow(), ScAddress::Tab(), and sc::toRefCell().

Referenced by first(), and next().

◆ getEditText()

const EditTextObject * ScCellIterator::getEditText ( ) const
inline

Definition at line 235 of file dociter.hxx.

References ScRefCellValue::getEditText(), and maCurCell.

Referenced by ScAutoNameCache::GetNameOccurrences().

◆ getFormulaCell() [1/2]

ScFormulaCell * ScCellIterator::getFormulaCell ( )
inline

Definition at line 236 of file dociter.hxx.

References ScRefCellValue::getFormula(), and maCurCell.

Referenced by ScViewFunc::DoRefConversion(), ScAccessibleCell::FillDependents(), ScDetectiveFunc::FindSuccLevel(), ScDetectiveFunc::GetAllPreds(), ScDetectiveFunc::GetAllSuccs(), ScAutoNameCache::GetNameOccurrences(), ScDetectiveFunc::HasError(), ScDocument::HasSubTotalCells(), ScDetectiveFunc::InsertSuccLevel(), lcl_HasErrors(), ScCompiler::ParseColRowName(), ScCompiler::ParseTableRefColumn(), ScTableLink::Refresh(), and ScTransferObj::StripRefs().

◆ getFormulaCell() [2/2]

const ScFormulaCell * ScCellIterator::getFormulaCell ( ) const
inline

Definition at line 237 of file dociter.hxx.

References ScRefCellValue::getFormula(), and maCurCell.

◆ GetPos()

const ScAddress & ScCellIterator::GetPos ( ) const
inline

Definition at line 231 of file dociter.hxx.

References maCurPos.

Referenced by ScChangeTrack::AppendContentsIfInRefDoc(), ScInterpreter::CreateMatrixFromDoubleRef(), ScViewFunc::DoRefConversion(), ScAccessibleCell::FillDependents(), sc::SearchResultsDlg::FillResults(), ScDetectiveFunc::FindPredLevelArea(), ScDetectiveFunc::FindSuccLevel(), ScDetectiveFunc::GetAllPreds(), ScDetectiveFunc::GetAllSuccs(), ScAutoNameCache::GetNameOccurrences(), ScDetectiveFunc::HasError(), ScDetectiveFunc::InsertPredLevelArea(), ScDetectiveFunc::InsertSuccLevel(), ScChangeTrack::LookUpContents(), ScDetectiveFunc::MarkInvalid(), ScCompiler::ParseColRowName(), ScCompiler::ParseTableRefColumn(), and ScTransferObj::StripRefs().

◆ getRefCellValue()

const ScRefCellValue & ScCellIterator::getRefCellValue ( ) const
inline

Definition at line 239 of file dociter.hxx.

References maCurCell.

Referenced by ScInterpreter::CreateMatrixFromDoubleRef(), ScChangeTrack::LookUpContents(), ScDetectiveFunc::MarkInvalid(), and ScInterpreter::ScCountEmptyCells().

◆ getString()

OUString ScCellIterator::getString ( ) const

Definition at line 968 of file dociter.cxx.

References ScRefCellValue::getString(), maCurCell, and mrDoc.

Referenced by ScDocument::GetFormulaEntries(), ScAutoNameCache::GetNameOccurrences(), ScCompiler::ParseColRowName(), and ScCompiler::ParseTableRefColumn().

◆ getType()

CellType ScCellIterator::getType ( ) const
inline

Definition at line 233 of file dociter.hxx.

References ScRefCellValue::getType(), and maCurCell.

Referenced by ScViewFunc::DoRefConversion(), ScAccessibleCell::FillDependents(), ScDetectiveFunc::FindPredLevelArea(), ScDetectiveFunc::FindSuccLevel(), ScDetectiveFunc::GetAllPreds(), ScDetectiveFunc::GetAllSuccs(), ScAutoNameCache::GetNameOccurrences(), ScDetectiveFunc::HasError(), ScDocument::HasSubTotalCells(), ScDetectiveFunc::InsertPredLevelArea(), ScDetectiveFunc::InsertSuccLevel(), lcl_HasErrors(), ScCompiler::ParseColRowName(), ScCompiler::ParseTableRefColumn(), ScTableLink::Refresh(), and ScTransferObj::StripRefs().

◆ hasString()

bool ScCellIterator::hasString ( ) const

Definition at line 994 of file dociter.cxx.

References ScRefCellValue::hasString(), and maCurCell.

Referenced by ScDocument::GetFormulaEntries(), ScAutoNameCache::GetNameOccurrences(), ScCompiler::ParseColRowName(), and ScCompiler::ParseTableRefColumn().

◆ incBlock()

void ScCellIterator::incBlock ( )
private

Definition at line 828 of file dociter.cxx.

References maCurColPos, maCurPos, and ScAddress::SetRow().

Referenced by getCurrent(), and incPos().

◆ incPos()

void ScCellIterator::incPos ( )
private

Definition at line 836 of file dociter.cxx.

References incBlock(), ScAddress::IncRow(), maCurColPos, and maCurPos.

Referenced by getCurrent(), and next().

◆ init()

void ScCellIterator::init ( )
private

Definition at line 860 of file dociter.cxx.

References ScAddress::Col(), ScDocument::GetTableCount(), ScAddress::IncTab(), maCurPos, maEndPos, maStartPos, ScDocument::maTabs, ScDocument::MaxCol(), ScDocument::MaxRow(), MAXTAB, mrDoc, PutInOrder(), ScAddress::Row(), ScAddress::SetCol(), ScAddress::SetRow(), ScAddress::SetTab(), ScAddress::Tab(), ScDocument::ValidCol(), ScDocument::ValidRow(), and ValidTab().

Referenced by ScCellIterator().

◆ isEmpty()

bool ScCellIterator::isEmpty ( ) const

Definition at line 999 of file dociter.cxx.

References ScRefCellValue::isEmpty(), and maCurCell.

Referenced by ScInterpreter::CreateMatrixFromDoubleRef(), and ScInterpreter::IterateParameters().

◆ next()

bool ScCellIterator::next ( )

Definition at line 1022 of file dociter.cxx.

References getCurrent(), and incPos().

Referenced by ScChangeTrack::AppendContentsIfInRefDoc(), ScInterpreter::CreateMatrixFromDoubleRef(), ScViewFunc::DoRefConversion(), ScAccessibleCell::FillDependents(), sc::SearchResultsDlg::FillResults(), ScDetectiveFunc::FindPredLevelArea(), ScDetectiveFunc::FindSuccLevel(), ScDetectiveFunc::GetAllPreds(), ScDetectiveFunc::GetAllSuccs(), ScDocument::GetFormulaEntries(), ScAutoNameCache::GetNameOccurrences(), ScDetectiveFunc::HasError(), ScDocument::HasSubTotalCells(), ScDetectiveFunc::InsertPredLevelArea(), ScDetectiveFunc::InsertSuccLevel(), ScInterpreter::IterateParameters(), lcl_HasErrors(), ScChangeTrack::LookUpContents(), ScDetectiveFunc::MarkInvalid(), ScCompiler::ParseColRowName(), ScCompiler::ParseTableRefColumn(), ScTableLink::Refresh(), ScInterpreter::ScCountEmptyCells(), and ScTransferObj::StripRefs().

◆ setPos()

void ScCellIterator::setPos ( size_t  nPos)
private

Definition at line 849 of file dociter.cxx.

References getColumn(), ScColumn::maCells, maCurColPos, maCurPos, nPos, and ScAddress::SetRow().

Referenced by getCurrent().

Member Data Documentation

◆ maCurCell

ScRefCellValue ScCellIterator::maCurCell
private

Definition at line 217 of file dociter.hxx.

Referenced by equalsWithoutFormat(), getCellValue(), getCurrent(), getEditText(), getFormulaCell(), getRefCellValue(), getString(), getType(), hasString(), and isEmpty().

◆ maCurColPos

PositionType ScCellIterator::maCurColPos
private

Definition at line 214 of file dociter.hxx.

Referenced by first(), getCurrent(), incBlock(), incPos(), and setPos().

◆ maCurPos

ScAddress ScCellIterator::maCurPos
private

Definition at line 212 of file dociter.hxx.

Referenced by first(), getColumn(), getCurrent(), GetPos(), incBlock(), incPos(), init(), and setPos().

◆ maEndPos

ScAddress ScCellIterator::maEndPos
private

Definition at line 211 of file dociter.hxx.

Referenced by getCurrent(), and init().

◆ maStartPos

ScAddress ScCellIterator::maStartPos
private

Definition at line 210 of file dociter.hxx.

Referenced by first(), getCurrent(), and init().

◆ mnSubTotalFlags

SubtotalFlags ScCellIterator::mnSubTotalFlags
private

Definition at line 215 of file dociter.hxx.

Referenced by getCurrent().

◆ mrDoc

ScDocument& ScCellIterator::mrDoc
private

Definition at line 209 of file dociter.hxx.

Referenced by equalsWithoutFormat(), getColumn(), getCurrent(), getString(), and init().

The documentation for this class was generated from the following files:
Generated on Thu Feb 2 2023 22:13:40 for LibreOffice Module sc (master) by doxygen 1.9.3