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

The main progress bar for the export filter. More...

#include <xehelper.hxx>

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

Public Member Functions

 XclExpProgressBar (const XclExpRoot &rRoot)
 
virtual ~XclExpProgressBar () override
 
void Initialize ()
 Initializes all segments and sub progress bars. More...
 
void IncRowRecordCount ()
 Increases the number of existing ROW records by 1. More...
 
void ActivateCreateRowsSegment ()
 Activates the progress segment to create ROW records. More...
 
void ActivateFinalRowsSegment ()
 Activates the progress segment to finalize ROW records. More...
 
void Progress ()
 Increases the currently activated (sub) progress bar by 1 step. More...
 

Private Types

typedef std::unique_ptr< ScfProgressBarScfProgressBarPtr
 

Private Attributes

ScfProgressBarPtr mxProgress
 
ScfProgressBarmpSubProgress
 Progress bar implementation. More...
 
ScfProgressBarmpSubRowCreate
 Current sub progress bar. More...
 
ScfInt32Vec maSubSegRowCreate
 Sub progress bar for creating table rows. More...
 
ScfProgressBarmpSubRowFinal
 Segment ID's for all sheets in sub progress bar. More...
 
sal_Int32 mnSegRowFinal
 Sub progress bar for finalizing ROW records. More...
 
std::size_t mnRowCount
 Progress segment for finalizing ROW records. 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 const OUStringLiteral & GetDefaultPassword ()
 Returns the default password used for stream encryption. More...
 

Detailed Description

The main progress bar for the export filter.

This class encapsulates creation and initialization of sub progress segments. The Activate***Segment() functions activate a specific segment of the main progress bar. The implementation of these functions contain the calculation of the needed size of the segment. Following calls of the Progress() function increase the currently activated sub segment.

Definition at line 41 of file xehelper.hxx.

Member Typedef Documentation

typedef std::unique_ptr< ScfProgressBar > XclExpProgressBar::ScfProgressBarPtr
private

Definition at line 62 of file xehelper.hxx.

Constructor & Destructor Documentation

XclExpProgressBar::XclExpProgressBar ( const XclExpRoot rRoot)
explicit

Definition at line 62 of file xehelper.cxx.

XclExpProgressBar::~XclExpProgressBar ( )
overridevirtual

Definition at line 73 of file xehelper.cxx.

Member Function Documentation

void XclExpProgressBar::ActivateCreateRowsSegment ( )

Activates the progress segment to create ROW records.

Definition at line 112 of file xehelper.cxx.

References ScfProgressBar::ActivateSegment(), XclRoot::GetCurrScTab(), XclExpRoot::GetTabInfo(), maSubSegRowCreate, mpSubProgress, mpSubRowCreate, and SCF_INV_SEGMENT.

Referenced by XclExpCellTable::XclExpCellTable().

void XclExpProgressBar::ActivateFinalRowsSegment ( )

Activates the progress segment to finalize ROW records.

Definition at line 127 of file xehelper.cxx.

References ScfProgressBar::Activate(), ScfProgressBar::AddSegment(), mnRowCount, mnSegRowFinal, mpSubProgress, mpSubRowFinal, and mxProgress.

Referenced by XclExpRowBuffer::Finalize().

void XclExpProgressBar::IncRowRecordCount ( )

Increases the number of existing ROW records by 1.

Definition at line 107 of file xehelper.cxx.

References mnRowCount.

Referenced by XclExpRow::XclExpRow().

void XclExpProgressBar::Initialize ( )
void XclExpProgressBar::Progress ( )

Increases the currently activated (sub) progress bar by 1 step.

Definition at line 139 of file xehelper.cxx.

References ScfProgressBar::IsFull(), mpSubProgress, and ScfProgressBar::Progress().

Referenced by XclExpRow::Finalize(), and XclExpRow::XclExpRow().

Member Data Documentation

ScfInt32Vec XclExpProgressBar::maSubSegRowCreate
private

Sub progress bar for creating table rows.

Definition at line 68 of file xehelper.hxx.

Referenced by ActivateCreateRowsSegment(), and Initialize().

std::size_t XclExpProgressBar::mnRowCount
private

Progress segment for finalizing ROW records.

Definition at line 73 of file xehelper.hxx.

Referenced by ActivateFinalRowsSegment(), and IncRowRecordCount().

sal_Int32 XclExpProgressBar::mnSegRowFinal
private

Sub progress bar for finalizing ROW records.

Definition at line 71 of file xehelper.hxx.

Referenced by ActivateFinalRowsSegment(), and Initialize().

ScfProgressBar* XclExpProgressBar::mpSubProgress
private

Progress bar implementation.

Definition at line 65 of file xehelper.hxx.

Referenced by ActivateCreateRowsSegment(), ActivateFinalRowsSegment(), and Progress().

ScfProgressBar* XclExpProgressBar::mpSubRowCreate
private

Current sub progress bar.

Definition at line 67 of file xehelper.hxx.

Referenced by ActivateCreateRowsSegment(), and Initialize().

ScfProgressBar* XclExpProgressBar::mpSubRowFinal
private

Segment ID's for all sheets in sub progress bar.

Definition at line 70 of file xehelper.hxx.

Referenced by ActivateFinalRowsSegment().

ScfProgressBarPtr XclExpProgressBar::mxProgress
private

Definition at line 64 of file xehelper.hxx.

Referenced by ActivateFinalRowsSegment(), and Initialize().


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