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

Collects all rows which contain all cells of a sheet. More...

#include <xetable.hxx>

Inheritance diagram for XclExpRowBuffer:
[legend]
Collaboration diagram for XclExpRowBuffer:
[legend]

Public Member Functions

 XclExpRowBuffer (const XclExpRoot &rRoot)
 
void AppendCell (XclExpCellRef const &xCell, bool bIsMergedBase)
 Appends the passed cell object to the row that the cell specifies. More...
 
void CreateRows (SCROW nFirstFreeScRow)
 Forces insertion of all ROW records before the passed row. More...
 
void Finalize (XclExpDefaultRowData &rDefRowData, const ScfUInt16Vec &rColXFIndexes, size_t nStartColAllDefault)
 Converts all XF identifiers into the Excel XF indexes and calculates default formats. More...
 
virtual void Save (XclExpStream &rStrm) override
 Writes the DIMENSIONS record, all ROW records and all cell records. More...
 
virtual void SaveXml (XclExpXmlStream &rStrm) override
 
XclExpDimensionsGetDimensions ()
 
sal_uInt8 GetHighestOutlineLevel () const
 
- Public Member Functions inherited from XclExpRecordBase
 XclExpRecordBase ()
 
 XclExpRecordBase (XclExpRecordBase const &)
 
 XclExpRecordBase (XclExpRecordBase &&)
 
XclExpRecordBaseoperator= (XclExpRecordBase const &)
 
XclExpRecordBaseoperator= (XclExpRecordBase &&) noexcept
 
virtual ~XclExpRecordBase ()
 
virtual void Save (XclExpStream &rStrm)
 Overwrite this method to do any operation while saving the record. More...
 
virtual void SaveXml (XclExpXmlStream &rStrm)
 
- Public Member Functions inherited from salhelper::SimpleReferenceObject
 SimpleReferenceObject ()
 
void acquire ()
 
void release ()
 

Private Types

typedef std::shared_ptr< XclExpRowRowRef
 
typedef ::std::map< sal_uInt32, RowRefRowMap
 

Private Member Functions

XclExpRowGetOrCreateRow (sal_uInt32 nXclRow, bool bRowAlwaysEmpty)
 Returns access to the specified ROW record. More...
 

Private Attributes

RowMap maRowMap
 
XclExpRowOutlineBuffer maOutlineBfr
 
XclExpDimensions maDimensions
 Buffer for row outline groups. More...
 
sal_uInt8 mnHighestOutlineLevel
 DIMENSIONS record for used area. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from salhelper::SimpleReferenceObject
static void * operator new (std::size_t nSize)
 
static void * operator new (std::size_t nSize, std::nothrow_t const &rNothrow)
 
static void operator delete (void *pPtr)
 
static void operator delete (void *pPtr, std::nothrow_t const &rNothrow)
 
- Protected Member Functions inherited from salhelper::SimpleReferenceObject
virtual ~SimpleReferenceObject () COVERITY_NOEXCEPT_FALSE
 
- Protected Member Functions inherited from XclExpRoot
 XclExpRoot (XclExpRootData &rExpRootData)
 
const XclExpRootGetRoot () const
 Returns this root instance - for code readability in derived classes. More...
 
bool IsRelUrl () const
 Returns true, if URLs should be stored relative to the document location. More...
 
sc::CompileFormulaContextGetCompileFormulaContext () const
 
XclExpTabInfoGetTabInfo () const
 Returns the buffer for Calc->Excel sheet index conversion. More...
 
XclExpAddressConverterGetAddressConverter () const
 Returns the address converter. More...
 
XclExpFormulaCompilerGetFormulaCompiler () const
 Returns the formula compiler to produce formula token arrays. More...
 
XclExpProgressBarGetProgressBar () const
 Returns the export progress bar. More...
 
XclExpSstGetSst () const
 Returns the shared string table. More...
 
XclExpPaletteGetPalette () const
 Returns the color buffer. More...
 
XclExpFontBufferGetFontBuffer () const
 Returns the font buffer. More...
 
XclExpNumFmtBufferGetNumFmtBuffer () const
 Returns the number format buffer. More...
 
XclExpXFBufferGetXFBuffer () const
 Returns the cell formatting attributes buffer. More...
 
XclExpLinkManagerGetGlobalLinkManager () const
 Returns the global link manager for defined names. More...
 
XclExpLinkManagerGetLocalLinkManager () const
 Returns the local link manager for the current sheet. More...
 
XclExpNameManagerGetNameManager () const
 Returns the buffer that contains internal defined names. More...
 
XclExpObjectManagerGetObjectManager () const
 Returns the drawing object manager. More...
 
XclExpFilterManagerGetFilterManager () const
 Returns the filter manager. More...
 
XclExpPivotTableManagerGetPivotTableManager () const
 Returns the pivot table manager. More...
 
XclExpDxfsGetDxfs () const
 Returns the differential formatting list. More...
 
OStringBuffer & GetStringBuf () const
 Clean and return the OStringBuffer. More...
 
XclExpXmlPivotTableManagerGetXmlPivotTableManager ()
 
XclExpTablesManagerGetTablesManager ()
 
void InitializeConvert ()
 Is called when export filter starts to create the Excel document (all BIFF versions). More...
 
void InitializeGlobals ()
 Is called when export filter starts to create the workbook global data (>=BIFF5). More...
 
void InitializeTable (SCTAB nScTab)
 Is called when export filter starts to create data for a single sheet (all BIFF versions). More...
 
void InitializeSave ()
 Is called before export filter starts to write the records to the stream. More...
 
XclExpRecordRef CreateRecord (sal_uInt16 nRecId) const
 Returns the reference to a record (or record list) representing a root object. More...
 
bool IsDocumentEncrypted () const
 
css::uno::Sequence< css::beans::NamedValue > GetEncryptionData () const
 
- Protected Member Functions inherited from XclRoot
 XclRoot (XclRootData &rRootData)
 
 XclRoot (const XclRoot &rRoot)
 
virtual ~XclRoot ()
 
XclRootoperator= (const XclRoot &rRoot)
 
RootDataGetOldRoot () const
 Returns old RootData struct. More...
 
XclBiff GetBiff () const
 Returns the current BIFF version of the importer/exporter. More...
 
XclOutput GetOutput () const
 Returns the current output format of the importer/exporter. More...
 
bool IsImport () const
 Returns true, if currently a document is imported. More...
 
rtl_TextEncoding GetTextEncoding () const
 Returns the text encoding to import/export byte strings. More...
 
LanguageType GetSysLanguage () const
 Returns the system language, i.e. More...
 
LanguageType GetDocLanguage () const
 Returns the document language. More...
 
LanguageType GetUILanguage () const
 Returns the UI language. More...
 
sal_Int16 GetDefApiScript () const
 Returns the default script type, e.g. More...
 
tools::Long GetCharWidth () const
 Returns the width of the '0' character (default font) for the current printer (twips). More...
 
tools::Long GetSpaceWidth () const
 
bool IsInGlobals () const
 Returns the current Calc sheet index. More...
 
SCTAB GetCurrScTab () const
 Returns the current Calc sheet index. More...
 
sal_Int32 GetHmmFromPixelX (double fPixelX) const
 Calculates the width of the passed number of pixels in 1/100 mm. More...
 
sal_Int32 GetHmmFromPixelY (double fPixelY) const
 Calculates the height of the passed number of pixels in 1/100 mm. More...
 
SfxMediumGetMedium () const
 Returns the medium to import from. More...
 
const OUString & GetDocUrl () const
 Returns the document URL of the imported/exported file. More...
 
const OUString & GetBasePath () const
 Returns the base path of the imported/exported file. More...
 
const OUString & GetUserName () const
 Returns the current user name. More...
 
css::uno::Sequence< css::beans::NamedValue > RequestEncryptionData (::comphelper::IDocPasswordVerifier &rVerifier) const
 Requests and verifies a password from the medium or the user. More...
 
const tools::SvRef< SotStorage > & GetRootStorage () const
 Returns the OLE2 root storage of the imported/exported file. More...
 
bool HasVbaStorage () const
 Returns true, if the document contains a VBA storage. More...
 
tools::SvRef< SotStorageOpenStorage (tools::SvRef< SotStorage > const &xStrg, const OUString &rStrgName) const
 Tries to open a storage as child of the specified storage for reading or writing. More...
 
tools::SvRef< SotStorageOpenStorage (const OUString &rStrgName) const
 Tries to open a storage as child of the root storage for reading or writing. More...
 
tools::SvRef< SotStorageStreamOpenStream (tools::SvRef< SotStorage > const &xStrg, const OUString &rStrmName) const
 Tries to open a new stream in the specified storage for reading or writing. More...
 
tools::SvRef< SotStorageStreamOpenStream (const OUString &rStrmName) const
 Tries to open a new stream in the root storage for reading or writing. More...
 
ScDocumentGetDoc () const
 Returns reference to the destination document (import) or source document (export). More...
 
SfxObjectShellGetDocShell () const
 Returns the object shell of the Calc document. More...
 
ScModelObjGetDocModelObj () const
 Returns the object model of the Calc document. More...
 
OutputDeviceGetPrinter () const
 Returns pointer to the printer of the Calc document. More...
 
ScStyleSheetPoolGetStyleSheetPool () const
 Returns the style sheet pool of the Calc document. More...
 
ScRangeNameGetNamedRanges () const
 Returns the defined names container of the Calc document. More...
 
SdrPageGetSdrPage (SCTAB nScTab) const
 Returns the drawing layer page of the passed sheet, if present. More...
 
SvNumberFormatterGetFormatter () const
 Returns the number formatter of the Calc document. More...
 
DateTime GetNullDate () const
 Returns the null date of the current number formatter. More...
 
sal_uInt16 GetBaseYear () const
 Returns the base year depending on the current null date (1900 or 1904). More...
 
double GetDoubleFromDateTime (const DateTime &rDateTime) const
 Converts a date/time value to a floating-point value. More...
 
DateTime GetDateTimeFromDouble (double fValue) const
 Converts a floating-point value to a date/time value. More...
 
ScEditEngineDefaulterGetEditEngine () const
 Returns the edit engine for import/export of rich strings etc. More...
 
ScHeaderEditEngineGetHFEditEngine () const
 Returns the edit engine for import/export of headers/footers. More...
 
EditEngineGetDrawEditEngine () const
 Returns the edit engine for import/export of drawing text boxes. More...
 
XclFontPropSetHelperGetFontPropSetHelper () const
 Returns the property set helper for fonts. More...
 
XclChPropSetHelperGetChartPropSetHelper () const
 Returns the property set helper for the chart filters. More...
 
ScExtDocOptionsGetExtDocOptions () const
 Returns the extended document options. More...
 
XclTracerGetTracer () const
 Returns the filter tracer. More...
 
const ScAddressGetScMaxPos () const
 Returns the highest possible cell address in a Calc document. More...
 
const ScAddressGetXclMaxPos () const
 Returns the highest possible cell address in an Excel document (using current BIFF version). More...
 
const ScAddressGetMaxPos () const
 Returns the highest possible cell address valid in Calc and Excel (using current BIFF version). More...
 
void SetDocLanguage (LanguageType eLang)
 Sets the document language. More...
 
void SetUILanguage (LanguageType eLang)
 Sets the UI language, i.e. More...
 
void SetTextEncoding (rtl_TextEncoding eTextEnc)
 Sets the text encoding to import/export byte strings. More...
 
void SetCharWidth (const XclFontData &rFontData)
 Sets the width of the '0' - '9' digit character as well as the ' ' space char (using the default font) for the current printer (twips). More...
 
void SetCurrScTab (SCTAB nScTab)
 Sets the current Calc sheet index. More...
 
void IncCurrScTab ()
 Increases the current Calc sheet index by 1. More...
 
- Static Protected Member Functions inherited from XclExpRoot
static css::uno::Sequence< css::beans::NamedValue > GenerateEncryptionData (std::u16string_view aPass)
 
static css::uno::Sequence< css::beans::NamedValue > GenerateDefaultEncryptionData ()
 
- Static Protected Member Functions inherited from XclRoot
static OUString GetDefaultPassword ()
 Returns the default password used for stream encryption. More...
 
- Protected Attributes inherited from salhelper::SimpleReferenceObject
oslInterlockedCount m_nCount
 

Detailed Description

Collects all rows which contain all cells of a sheet.

This row buffer automatically creates ROW records when cells are inserted with the AppendCell() function. It is possible to force creation of more ROW records with the CreateRows() function. In both cases, all preceding missing ROW records are inserted too.

Definition at line 914 of file xetable.hxx.

Member Typedef Documentation

◆ RowMap

typedef ::std::map<sal_uInt32, RowRef> XclExpRowBuffer::RowMap
private

Definition at line 947 of file xetable.hxx.

◆ RowRef

typedef std::shared_ptr<XclExpRow> XclExpRowBuffer::RowRef
private

Definition at line 946 of file xetable.hxx.

Constructor & Destructor Documentation

◆ XclExpRowBuffer()

XclExpRowBuffer::XclExpRowBuffer ( const XclExpRoot rRoot)
explicit

Definition at line 2207 of file xetable.cxx.

Member Function Documentation

◆ AppendCell()

void XclExpRowBuffer::AppendCell ( XclExpCellRef const &  xCell,
bool  bIsMergedBase 
)

Appends the passed cell object to the row that the cell specifies.

Definition at line 2215 of file xetable.cxx.

References XclExpRow::AppendCell(), and GetOrCreateRow().

Referenced by XclExpCellTable::XclExpCellTable().

◆ CreateRows()

void XclExpRowBuffer::CreateRows ( SCROW  nFirstFreeScRow)

Forces insertion of all ROW records before the passed row.

Definition at line 2221 of file xetable.cxx.

References XclRoot::GetMaxPos(), GetOrCreateRow(), and Row.

Referenced by XclExpCellTable::XclExpCellTable().

◆ Finalize()

void XclExpRowBuffer::Finalize ( XclExpDefaultRowData rDefRowData,
const ScfUInt16Vec rColXFIndexes,
size_t  nStartColAllDefault 
)

Converts all XF identifiers into the Excel XF indexes and calculates default formats.

Parameters
rDefRowData(out-param) The default row format is returned here.
rColXFIndexesThe column default XF indexes.
nStartColAllDefaultIndex in rColXFIndexes which starts EXC_XF_DEFAULTCELL until the end.

Definition at line 2257 of file xetable.cxx.

References XclExpProgressBar::ActivateFinalRowsSegment(), comphelper::ThreadPool::createThreadTaskTag(), EXC_XF_NOTFOUND, comphelper::ThreadPool::getPreferredConcurrency(), XclExpRoot::GetProgressBar(), comphelper::ThreadPool::getSharedOptimalPool(), XclExpRow::GetXclRow(), XclExpRow::GetXclRowRpt(), i, XclExpRow::IsDefaultable(), XclExpDefaultRowData::IsHidden(), maDimensions, maRowMap, XclExpDefaultRowData::mnHeight, comphelper::ThreadPool::pushTask(), SAL_MAX_UINT16, SAL_MAX_UINT32, XclExpDimensions::SetDimensions(), XclExpRow::SetXclRowRpt(), and comphelper::ThreadPool::waitUntilDone().

Referenced by XclExpCellTable::Finalize().

◆ GetDimensions()

XclExpDimensions & XclExpRowBuffer::GetDimensions ( )
inline

Definition at line 936 of file xetable.hxx.

References maDimensions.

◆ GetHighestOutlineLevel()

sal_uInt8 XclExpRowBuffer::GetHighestOutlineLevel ( ) const
inline

Definition at line 937 of file xetable.hxx.

References mnHighestOutlineLevel.

Referenced by XclExpCellTable::SaveXml().

◆ GetOrCreateRow()

XclExpRow & XclExpRowBuffer::GetOrCreateRow ( sal_uInt32  nXclRow,
bool  bRowAlwaysEmpty 
)
private

Returns access to the specified ROW record.

Inserts preceding missing ROW records.

Parameters
bRowAlwaysEmptytrue = Created rows will not be filled with blank cells in the XclExpRow::Finalize() function.

Definition at line 2445 of file xetable.cxx.

References XclRoot::GetCurrScTab(), XclRoot::GetDoc(), XclExpOutlineBuffer::GetLevel(), XclExpRoot::GetRoot(), ScDocument::GetRowHeight(), XclExpOutlineBuffer::IsCollapsed(), last, maOutlineBfr, maRowMap, mnHighestOutlineLevel, p, and ScDocument::RowHidden().

Referenced by AppendCell(), and CreateRows().

◆ Save()

void XclExpRowBuffer::Save ( XclExpStream rStrm)
overridevirtual

Writes the DIMENSIONS record, all ROW records and all cell records.

Reimplemented from XclExpRecordBase.

Definition at line 2402 of file xetable.cxx.

References EXC_ROW_ROWBLOCKSIZE, maDimensions, maRowMap, rStrm, and XclExpRecord::Save().

Referenced by XclExpCellTable::Save().

◆ SaveXml()

void XclExpRowBuffer::SaveXml ( XclExpXmlStream rStrm)
overridevirtual

Reimplemented from XclExpRecordBase.

Definition at line 2430 of file xetable.cxx.

References maRowMap, and rStrm.

Referenced by XclExpCellTable::SaveXml().

Member Data Documentation

◆ maDimensions

XclExpDimensions XclExpRowBuffer::maDimensions
private

Buffer for row outline groups.

Definition at line 951 of file xetable.hxx.

Referenced by Finalize(), GetDimensions(), and Save().

◆ maOutlineBfr

XclExpRowOutlineBuffer XclExpRowBuffer::maOutlineBfr
private

Definition at line 950 of file xetable.hxx.

Referenced by GetOrCreateRow().

◆ maRowMap

RowMap XclExpRowBuffer::maRowMap
private

Definition at line 949 of file xetable.hxx.

Referenced by Finalize(), GetOrCreateRow(), Save(), and SaveXml().

◆ mnHighestOutlineLevel

sal_uInt8 XclExpRowBuffer::mnHighestOutlineLevel
private

DIMENSIONS record for used area.

Definition at line 952 of file xetable.hxx.

Referenced by GetHighestOutlineLevel(), and GetOrCreateRow().


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