LibreOffice Module sc (master)  1
Public Types | Public Member Functions | Public Attributes | List of all members
ScDataAreaExtras Struct Reference

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

#include <sortparam.hxx>

Public Types

enum  Clip {
  Clip::None,
  Clip::Col,
  Clip::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 43 of file sortparam.hxx.

Member Enumeration Documentation

Enumerator
None 
Col 
Row 

Definition at line 67 of file sortparam.hxx.

Member Function Documentation

bool ScDataAreaExtras::anyExtrasWanted ( ) const
inline

Definition at line 56 of file sortparam.hxx.

References mbCellFormats.

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

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 75 of file sortparam.hxx.

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

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

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

Definition at line 59 of file sortparam.hxx.

References mbCellDrawObjects, mbCellFormats, and mbCellNotes.

void ScDataAreaExtras::resetArea ( )
inline

Definition at line 57 of file sortparam.hxx.

References SCCOL_MAX, and SCROW_MAX.

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

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

Set the overall range.

Definition at line 94 of file sortparam.hxx.

Referenced by ScDBDocFunc::Sort().

Member Data Documentation

bool ScDataAreaExtras::mbCellDrawObjects = false
bool ScDataAreaExtras::mbCellFormats = false
bool ScDataAreaExtras::mbCellNotes = false
SCCOL ScDataAreaExtras::mnEndCol = -1
SCROW ScDataAreaExtras::mnEndRow = -1
SCCOL ScDataAreaExtras::mnStartCol = SCCOL_MAX
SCROW ScDataAreaExtras::mnStartRow = SCROW_MAX

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