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

Converts edit engine text objects to an Excel header/footer string. More...

#include <xehelper.hxx>

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

Public Member Functions

 XclExpHFConverter (const XclExpHFConverter &)=delete
 delete copy constructor More...
 
const XclExpHFConverteroperator= (const XclExpHFConverter &)=delete
 delete copy-assignment operator More...
 
 XclExpHFConverter (const XclExpRoot &rRoot)
 
void GenerateString (const EditTextObject *pLeftObj, const EditTextObject *pCenterObj, const EditTextObject *pRightObj)
 Generates the header/footer string from the passed edit engine text objects. More...
 
const OUString & GetHFString () const
 Returns the last generated header/footer string. More...
 
sal_Int32 GetTotalHeight () const
 Returns the total height of the last generated header/footer in twips. More...
 

Private Member Functions

void AppendPortion (const EditTextObject *pTextObj, sal_Unicode cPortionCode)
 Converts the text object contents and stores it in the passed string. More...
 

Private Attributes

EditEnginemrEE
 
OUString maHFString
 The header/footer edit engine. More...
 
sal_Int32 mnTotalHeight
 The last generated header/footer string. More...
 

Additional Inherited Members

- 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 OUString GetDefaultPassword ()
 Returns the default password used for stream encryption. More...
 

Detailed Description

Converts edit engine text objects to an Excel header/footer string.

Header/footer content is divided into three parts: Left, center and right portion. All formatting information will be encoded in the Excel string using special character sequences. A control sequence starts with the ampersand character.

Supported control sequences: &L start of left portion &C start of center portion &R start of right portion &P current page number &N page count &D current date &T current time &A table name &F file name without path &Z file path without file name &Z&F file path and name &U underlining on/off &E double underlining on/off &S strikeout characters on/off &X superscript on/off &Y subscript on/off &"fontname,fontstyle" use font with name 'fontname' and style 'fontstyle' &fontheight set font height in points ('fontheight' is a decimal value)

Known but unsupported control sequences: &G picture

Definition at line 359 of file xehelper.hxx.

Constructor & Destructor Documentation

XclExpHFConverter::XclExpHFConverter ( const XclExpHFConverter )
delete

delete copy constructor

XclExpHFConverter::XclExpHFConverter ( const XclExpRoot rRoot)
explicit

Definition at line 660 of file xehelper.cxx.

Member Function Documentation

void XclExpHFConverter::AppendPortion ( const EditTextObject pTextObj,
sal_Unicode  cPortionCode 
)
private

Converts the text object contents and stores it in the passed string.

Definition at line 679 of file xehelper.cxx.

References ScGlobal::addToken(), Color::AsRGBHexString(), EE_CHAR_ESCAPEMENT(), EE_CHAR_FONTHEIGHT(), EE_FEATURE_FIELD(), EXC_FONT_APP, EXC_FONTESC_NONE, EXC_FONTESC_SUB, EXC_FONTESC_SUPER, EXC_FONTUNDERL_DOUBLE, EXC_FONTUNDERL_NONE, EXC_FONTUNDERL_SINGLE, EXC_FONTWGHT_BOLD, EXC_FONTWGHT_NORMAL, FontList::Get(), EditEngine::GetAttribs(), vcl::Font::GetColor(), XclRoot::GetDoc(), XclRoot::GetDocShell(), SvxEscapementItem::GetEsc(), vcl::Font::GetFamilyName(), ScPatternAttr::GetFont(), XclExpRoot::GetFontBuffer(), ScPatternAttr::GetFromEditItemSet(), vcl::Font::GetItalic(), EditEngine::GetParagraphCount(), EditEngine::GetPortions(), vcl::Font::GetStrikeout(), FontList::GetStyleName(), EditEngine::GetText(), vcl::Font::GetUnderline(), EditEngine::GetUpdateMode(), vcl::Font::GetWeight(), XclTools::GetXclFontName(), Color::IsRGBEqual(), ITALIC_NONE, ITALIC_NORMAL, LINESTYLE_DOUBLE, LINESTYLE_NONE, LINESTYLE_SINGLE, XclFontData::maColor, maHFString, XclFontData::maName, XclFontData::maStyle, XclFontData::mbItalic, XclFontData::mbStrikeout, XclFontData::mnEscapem, XclFontData::mnHeight, mnTotalHeight, XclFontData::mnUnderline, XclFontData::mnWeight, mrEE, ESelection::nEndPos, ESelection::nStartPos, SC_AUTOCOL_RAW, XclFontData::SetScEscapement(), EditEngine::SetText(), EditEngine::SetUpdateMode(), STRIKEOUT_NONE, ulimit_cast(), WEIGHT_BOLD, and WEIGHT_NORMAL.

Referenced by GenerateString().

void XclExpHFConverter::GenerateString ( const EditTextObject pLeftObj,
const EditTextObject pCenterObj,
const EditTextObject pRightObj 
)

Generates the header/footer string from the passed edit engine text objects.

Definition at line 667 of file xehelper.cxx.

References AppendPortion(), maHFString, and mnTotalHeight.

Referenced by XclExpPageSettings::XclExpPageSettings().

const OUString& XclExpHFConverter::GetHFString ( ) const
inline

Returns the last generated header/footer string.

Definition at line 376 of file xehelper.hxx.

References maHFString.

Referenced by XclExpPageSettings::XclExpPageSettings().

sal_Int32 XclExpHFConverter::GetTotalHeight ( ) const
inline

Returns the total height of the last generated header/footer in twips.

Definition at line 378 of file xehelper.hxx.

References mnTotalHeight.

Referenced by XclExpPageSettings::XclExpPageSettings().

const XclExpHFConverter& XclExpHFConverter::operator= ( const XclExpHFConverter )
delete

delete copy-assignment operator

Member Data Documentation

OUString XclExpHFConverter::maHFString
private

The header/footer edit engine.

Definition at line 388 of file xehelper.hxx.

Referenced by AppendPortion(), GenerateString(), and GetHFString().

sal_Int32 XclExpHFConverter::mnTotalHeight
private

The last generated header/footer string.

Definition at line 389 of file xehelper.hxx.

Referenced by AppendPortion(), GenerateString(), and GetTotalHeight().

EditEngine& XclExpHFConverter::mrEE
private

Definition at line 387 of file xehelper.hxx.

Referenced by AppendPortion().


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