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

Contains the column settings for a range of columns. More...

#include <xetable.hxx>

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

Public Member Functions

 XclExpColinfo (const XclExpRoot &rRoot, SCCOL nScCol, SCROW nLastScRow, XclExpColOutlineBuffer &rOutlineBfr)
 Constructs the record with the settings in the Calc document. More...
 
void ConvertXFIndexes ()
 Converts the XF identifier into the Excel XF index. More...
 
bool TryMerge (const XclExpColinfo &rColInfo)
 Tries to merge this record with the passed record. More...
 
sal_uInt16 GetColWidth () const
 Returns the Excel width of the column(s). More...
 
sal_uInt16 GetXFIndex () const
 Returns the final Excel XF index of the column(s). More...
 
sal_uInt16 GetColCount () const
 Returns the number of columns represented by this record. More...
 
bool IsDefault (const XclExpDefcolwidth &rDefColWidth)
 Returns true, if the column has default format and width. More...
 
virtual void SaveXml (XclExpXmlStream &rStrm) override
 
- Public Member Functions inherited from XclExpRecord
 XclExpRecord (sal_uInt16 nRecId=EXC_ID_UNKNOWN, std::size_t nRecSize=0)
 
 XclExpRecord (XclExpRecord const &)=default
 
virtual ~XclExpRecord () override
 
sal_uInt16 GetRecId () const
 Returns the current record ID. More...
 
std::size_t GetRecSize () const
 Returns the current record size prediction. More...
 
void SetRecId (sal_uInt16 nRecId)
 Sets a new record ID. More...
 
void SetRecSize (std::size_t nRecSize)
 Sets a new record size prediction. More...
 
void AddRecSize (std::size_t nRecSize)
 Adds a size value to the record size prediction. More...
 
void SetRecHeader (sal_uInt16 nRecId, std::size_t nRecSize)
 Sets record ID and size with one call. More...
 
virtual void Save (XclExpStream &rStrm) override
 Writes the record header and calls WriteBody(). More...
 
- Public Member Functions inherited from XclExpRecordBase
 XclExpRecordBase ()
 
 XclExpRecordBase (XclExpRecordBase const &)
 
 XclExpRecordBase (XclExpRecordBase &&)
 
XclExpRecordBaseoperator= (XclExpRecordBase const &)
 
XclExpRecordBaseoperator= (XclExpRecordBase &&) noexcept
 
virtual ~XclExpRecordBase ()
 
- Public Member Functions inherited from salhelper::SimpleReferenceObject
 SimpleReferenceObject ()
 
void acquire ()
 
void release ()
 

Private Member Functions

virtual void WriteBody (XclExpStream &rStrm) override
 Writes the contents of this COLINFO record. More...
 

Private Attributes

XclExpXFId maXFId
 
bool mbCustomWidth
 The XF identifier for column default format. More...
 
sal_uInt16 mnWidth
 True = Column width is different from default width. More...
 
sal_uInt16 mnScWidth
 Excel width of the column. More...
 
sal_uInt16 mnFlags
 Calc width of the column. More...
 
sal_uInt8 mnOutlineLevel
 Additional column flags. More...
 
sal_uInt16 mnFirstXclCol
 Outline Level of column (for OOXML) More...
 
sal_uInt16 mnLastXclCol
 Index to first column. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from salhelper::SimpleReferenceObject
static voidoperator new (std::size_t nSize)
 
static voidoperator 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...
 
long GetCharWidth () const
 Returns the width of the '0' character (default font) for the current printer (twips). More...
 
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' character (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 (const OUString &aPass)
 
static css::uno::Sequence< css::beans::NamedValue > GenerateDefaultEncryptionData ()
 
- Static Protected Member Functions inherited from XclRoot
static const OUStringLiteral & GetDefaultPassword ()
 Returns the default password used for stream encryption. More...
 
- Protected Attributes inherited from salhelper::SimpleReferenceObject
oslInterlockedCount m_nCount
 

Detailed Description

Contains the column settings for a range of columns.

After construction the record contains a temporary XF identifier returned from the XF buffer. After creating the entire Excel document in memory, the ConvertXFIndexes() function converts it into the real Excel XF index.

Definition at line 699 of file xetable.hxx.

Constructor & Destructor Documentation

XclExpColinfo::XclExpColinfo ( const XclExpRoot rRoot,
SCCOL  nScCol,
SCROW  nLastScRow,
XclExpColOutlineBuffer rOutlineBfr 
)
explicit

Member Function Documentation

void XclExpColinfo::ConvertXFIndexes ( )

Converts the XF identifier into the Excel XF index.

Definition at line 1642 of file xetable.cxx.

References XclExpXFId::ConvertXFIndex(), XclExpRoot::GetRoot(), and maXFId.

sal_uInt16 XclExpColinfo::GetColCount ( ) const
inline

Returns the number of columns represented by this record.

Definition at line 720 of file xetable.hxx.

References mnFirstXclCol, and mnLastXclCol.

sal_uInt16 XclExpColinfo::GetColWidth ( ) const
inline

Returns the Excel width of the column(s).

Definition at line 716 of file xetable.hxx.

References mnWidth.

sal_uInt16 XclExpColinfo::GetXFIndex ( ) const
inline

Returns the final Excel XF index of the column(s).

Definition at line 718 of file xetable.hxx.

References maXFId, and XclExpXFId::mnXFIndex.

bool XclExpColinfo::IsDefault ( const XclExpDefcolwidth rDefColWidth)

Returns true, if the column has default format and width.

Also sets mbCustomWidth

Definition at line 1647 of file xetable.cxx.

References EXC_XF_DEFAULTCELL, XclExpDefcolwidth::IsDefWidth(), maXFId, mbCustomWidth, mnFlags, mnOutlineLevel, mnWidth, and XclExpXFId::mnXFIndex.

void XclExpColinfo::SaveXml ( XclExpXmlStream rStrm)
overridevirtual
bool XclExpColinfo::TryMerge ( const XclExpColinfo rColInfo)

Tries to merge this record with the passed record.

Possible, if passed record directly follows this record and has equal contents.

Returns
true = This record is equal to passed record and has been updated.

Definition at line 1656 of file xetable.cxx.

References maXFId, mnFirstXclCol, mnFlags, mnLastXclCol, mnOutlineLevel, mnWidth, and XclExpXFId::mnXFIndex.

void XclExpColinfo::WriteBody ( XclExpStream rStrm)
overrideprivatevirtual

Writes the contents of this COLINFO record.

Reimplemented from XclExpRecord.

Definition at line 1670 of file xetable.cxx.

References ScAddress::Col(), XclRoot::GetMaxPos(), XclExpStream::GetRoot(), maXFId, mnFirstXclCol, mnFlags, mnLastXclCol, mnWidth, and XclExpXFId::mnXFIndex.

Member Data Documentation

XclExpXFId XclExpColinfo::maXFId
private
bool XclExpColinfo::mbCustomWidth
private

The XF identifier for column default format.

Definition at line 733 of file xetable.hxx.

Referenced by IsDefault(), and SaveXml().

sal_uInt16 XclExpColinfo::mnFirstXclCol
private

Outline Level of column (for OOXML)

Definition at line 738 of file xetable.hxx.

Referenced by GetColCount(), SaveXml(), TryMerge(), and WriteBody().

sal_uInt16 XclExpColinfo::mnFlags
private

Calc width of the column.

Definition at line 736 of file xetable.hxx.

Referenced by IsDefault(), SaveXml(), TryMerge(), WriteBody(), and XclExpColinfo().

sal_uInt16 XclExpColinfo::mnLastXclCol
private

Index to first column.

Definition at line 739 of file xetable.hxx.

Referenced by GetColCount(), SaveXml(), TryMerge(), and WriteBody().

sal_uInt8 XclExpColinfo::mnOutlineLevel
private

Additional column flags.

Definition at line 737 of file xetable.hxx.

Referenced by IsDefault(), SaveXml(), TryMerge(), and XclExpColinfo().

sal_uInt16 XclExpColinfo::mnScWidth
private

Excel width of the column.

Definition at line 735 of file xetable.hxx.

Referenced by SaveXml(), and XclExpColinfo().

sal_uInt16 XclExpColinfo::mnWidth
private

True = Column width is different from default width.

Definition at line 734 of file xetable.hxx.

Referenced by GetColWidth(), IsDefault(), TryMerge(), WriteBody(), and XclExpColinfo().


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