LibreOffice Module sc (master) 1
Public Member Functions | Private Attributes | List of all members
oox::xls::Connection Class Referencefinal

An external data connection (database, web query, etc.). More...

#include <connectionsbuffer.hxx>

Inheritance diagram for oox::xls::Connection:
[legend]
Collaboration diagram for oox::xls::Connection:
[legend]

Public Member Functions

 Connection (const WorkbookHelper &rHelper)
 
void importConnection (const AttributeList &rAttribs)
 Imports connection settings from the connection element. More...
 
void importWebPr (const AttributeList &rAttribs)
 Imports web query settings from the webPr element. More...
 
void importTables ()
 Imports web query table settings from the tables element. More...
 
void importTable (const AttributeList &rAttribs, sal_Int32 nElement)
 Imports a web query table identifier from the m, s, or x element. More...
 
void importConnection (SequenceInputStream &rStrm)
 Imports connection settings from the CONNECTION record. More...
 
void importWebPr (SequenceInputStream &rStrm)
 Imports web query settings from the WEBPR record. More...
 
void importWebPrTables (SequenceInputStream &rStrm)
 Imports web query table settings from the WEBPRTABLES record. More...
 
void importWebPrTable (SequenceInputStream &rStrm, sal_Int32 nRecId)
 Imports a web query table identifier from the PCITEM_MISSING, PCITEM_STRING, or PCITEM_INDEX record. More...
 
sal_Int32 getConnectionId () const
 Returns the unique connection identifier. More...
 
sal_Int32 getConnectionType () const
 Returns the source data type of the connection. More...
 
const ConnectionModelgetModel () const
 Returns read-only access to the connection model data. More...
 
- Public Member Functions inherited from oox::xls::WorkbookHelper
 WorkbookHelper (WorkbookGlobals &rBookGlob)
 
virtual ~WorkbookHelper ()
 
 WorkbookHelper (WorkbookHelper const &)=default
 
 WorkbookHelper (WorkbookHelper &&)=default
 
WorkbookHelperoperator= (WorkbookHelper const &)=delete
 
WorkbookHelperoperator= (WorkbookHelper &&)=delete
 
::oox::core::FilterBasegetBaseFilter () const
 Returns the base filter object (base class of all filters). More...
 
SegmentProgressBargetProgressBar () const
 Returns the filter progress bar. More...
 
sal_Int16 getCurrentSheetIndex () const
 Returns the index of the current Calc sheet, if filter currently processes a sheet. More...
 
bool isGeneratorKnownGood () const
 Returns true when reading a file generated by a known good generator. More...
 
bool hasCalculatedFormulaCells () const
 Returns true if any formula cell is calculated. More...
 
void setCalculatedFormulaCells ()
 Set if any formula cell is calculated. More...
 
void setVbaProjectStorage (const StorageRef &rxVbaPrjStrg)
 Sets the VBA project storage used to import VBA source code and forms. More...
 
void setCurrentSheetIndex (SCTAB nSheet)
 Sets the index of the current Calc sheet, if filter currently processes a sheet. More...
 
void finalizeWorkbookImport ()
 Final conversion after importing the workbook. More...
 
void useInternalChartDataTable (bool bInternal)
 
ScDocumentgetScDocument ()
 
const ScDocumentgetScDocument () const
 
ScDocumentImportgetDocImport ()
 
const ScDocumentImportgetDocImport () const
 
ScEditEngineDefaultergetEditEngine () const
 
const css::uno::Reference< css::sheet::XSpreadsheetDocument > & getDocument () const
 Returns a reference to the source/target spreadsheet document model. More...
 
css::uno::Reference< css::sheet::XSpreadsheet > getSheetFromDoc (sal_Int32 nSheet) const
 Returns a reference to the specified spreadsheet in the document model. More...
 
css::uno::Reference< css::sheet::XSpreadsheet > getSheetFromDoc (const OUString &rSheet) const
 Returns a reference to the specified spreadsheet in the document model. More...
 
css::uno::Reference< css::table::XCellRange > getCellRangeFromDoc (const ScRange &rRange) const
 Returns the XCellRange interface for the passed cell range address. More...
 
css::uno::Reference< css::container::XNameContainer > getCellStyleFamily () const
 Returns the cell styles container from the Calc document. More...
 
css::uno::Reference< css::style::XStyle > getStyleObject (const OUString &rStyleName, bool bPageStyle) const
 Returns the specified cell or page style from the Calc document. More...
 
RangeDataRet createNamedRangeObject (OUString &orName, sal_Int32 nIndex, sal_Int32 nNameFlags, bool bHidden) const
 Creates and returns a defined name on-the-fly in the Calc document. More...
 
RangeDataRet createLocalNamedRangeObject (OUString &orName, sal_Int32 nIndex, sal_Int32 nNameFlags, sal_Int32 nTab, bool bHidden) const
 Creates and returns a defined name on-the-fly in the sheet. More...
 
css::uno::Reference< css::sheet::XDatabaseRange > createDatabaseRangeObject (OUString &orName, const ScRange &rRangeAddr) const
 Creates and returns a database range on-the-fly in the Calc document. More...
 
css::uno::Reference< css::sheet::XDatabaseRange > createUnnamedDatabaseRangeObject (const ScRange &rRangeAddr) const
 Creates and returns an unnamed database range on-the-fly in the Calc document. More...
 
ScDBDatafindDatabaseRangeByIndex (sal_uInt16 nIndex) const
 Finds the (already existing) database range of the given formula token index. More...
 
css::uno::Reference< css::style::XStyle > createStyleObject (OUString &orStyleName, bool bPageStyle) const
 Creates and returns a com.sun.star.style.Style object for cells or pages. More...
 
FormulaBuffergetFormulaBuffer () const
 
WorkbookSettingsgetWorkbookSettings () const
 Returns the global workbook settings object. More...
 
ViewSettingsgetViewSettings () const
 Returns the workbook and sheet view settings object. More...
 
WorksheetBuffergetWorksheets () const
 Returns the worksheet buffer containing sheet names and properties. More...
 
ThemeBuffergetTheme () const
 Returns the office theme object read from the theme substorage. More...
 
StylesBuffergetStyles () const
 Returns all cell formatting objects read from the styles substream. More...
 
SharedStringsBuffergetSharedStrings () const
 Returns the shared strings read from the shared strings substream. More...
 
ExternalLinkBuffergetExternalLinks () const
 Returns the external links read from the external links substream. More...
 
DefinedNamesBuffergetDefinedNames () const
 Returns the defined names read from the workbook globals. More...
 
TableBuffergetTables () const
 Returns the tables collection (equivalent to Calc's database ranges). More...
 
ScenarioBuffergetScenarios () const
 Returns the scenarios collection. More...
 
ConnectionsBuffergetConnections () const
 Returns the collection of external data connections. More...
 
PivotCacheBuffergetPivotCaches () const
 Returns the collection of pivot caches. More...
 
PivotTableBuffergetPivotTables () const
 Returns the collection of pivot tables. More...
 
FormulaParsergetFormulaParser () const
 Returns a shared import formula parser (import filter only!). More...
 
FormulaParsercreateFormulaParser () const
 Returns an unshared import formula parser (import filter only!). More...
 
UnitConvertergetUnitConverter () const
 Returns the measurement unit converter. More...
 
AddressConvertergetAddressConverter () const
 Returns the converter for string to cell address/range conversion. More...
 
oox::drawingml::chart::ChartConvertergetChartConverter () const
 Returns the chart object converter. More...
 
PageSettingsConvertergetPageSettingsConverter () const
 Returns the page and print settings converter. More...
 
::oox::core::XmlFilterBasegetOoxFilter () const
 Returns the base OOXML/BIFF12 filter object. More...
 
bool importOoxFragment (const rtl::Reference< oox::core::FragmentHandler > &rxHandler)
 Imports a fragment using the passed fragment handler, which contains the full path to the fragment stream. More...
 
bool importOoxFragment (const rtl::Reference< oox::core::FragmentHandler > &rxHandler, oox::core::FastParser &rParser)
 
rtl_TextEncoding getTextEncoding () const
 Returns the text encoding used to import/export byte strings. More...
 

Private Attributes

ConnectionModel maModel
 

Additional Inherited Members

- Public Types inherited from oox::xls::WorkbookHelper
typedef std::pair< ScRangeData *, bool > RangeDataRet
 
- Static Public Member Functions inherited from oox::xls::WorkbookHelper
static WorkbookGlobalsRef constructGlobals (ExcelFilter &rFilter)
 

Detailed Description

An external data connection (database, web query, etc.).

Definition at line 95 of file connectionsbuffer.hxx.

Constructor & Destructor Documentation

◆ Connection()

oox::xls::Connection::Connection ( const WorkbookHelper rHelper)
explicit

Definition at line 107 of file connectionsbuffer.cxx.

References maModel, and oox::xls::ConnectionModel::mnId.

Member Function Documentation

◆ getConnectionId()

sal_Int32 oox::xls::Connection::getConnectionId ( ) const
inline

Returns the unique connection identifier.

Definition at line 119 of file connectionsbuffer.hxx.

References maModel, and oox::xls::ConnectionModel::mnId.

◆ getConnectionType()

sal_Int32 oox::xls::Connection::getConnectionType ( ) const
inline

Returns the source data type of the connection.

Definition at line 121 of file connectionsbuffer.hxx.

References maModel, and oox::xls::ConnectionModel::mnType.

◆ getModel()

const ConnectionModel & oox::xls::Connection::getModel ( ) const
inline

Returns read-only access to the connection model data.

Definition at line 123 of file connectionsbuffer.hxx.

References maModel.

◆ importConnection() [1/2]

void oox::xls::Connection::importConnection ( const AttributeList rAttribs)

◆ importConnection() [2/2]

void oox::xls::Connection::importConnection ( SequenceInputStream rStrm)

◆ importTable()

void oox::xls::Connection::importTable ( const AttributeList rAttribs,
sal_Int32  nElement 
)

Imports a web query table identifier from the m, s, or x element.

Definition at line 164 of file connectionsbuffer.cxx.

References Any, oox::AttributeList::getInteger(), oox::AttributeList::getXString(), m, maModel, oox::xls::ConnectionModel::mxWebPr, and x.

Referenced by oox::xls::ConnectionContext::onCreateContext().

◆ importTables()

void oox::xls::Connection::importTables ( )

Imports web query table settings from the tables element.

Definition at line 155 of file connectionsbuffer.cxx.

References maModel, and oox::xls::ConnectionModel::mxWebPr.

Referenced by oox::xls::ConnectionContext::onCreateContext().

◆ importWebPr() [1/2]

void oox::xls::Connection::importWebPr ( const AttributeList rAttribs)

◆ importWebPr() [2/2]

void oox::xls::Connection::importWebPr ( SequenceInputStream rStrm)

◆ importWebPrTable()

void oox::xls::Connection::importWebPrTable ( SequenceInputStream rStrm,
sal_Int32  nRecId 
)

Imports a web query table identifier from the PCITEM_MISSING, PCITEM_STRING, or PCITEM_INDEX record.

Definition at line 260 of file connectionsbuffer.cxx.

References Any, oox::xls::BIFF12_ID_PCITEM_INDEX, oox::xls::BIFF12_ID_PCITEM_MISSING, oox::xls::BIFF12_ID_PCITEM_STRING, maModel, oox::xls::ConnectionModel::mxWebPr, oox::xls::BiffHelper::readString(), and rStrm.

Referenced by oox::xls::ConnectionContext::onCreateRecordContext().

◆ importWebPrTables()

void oox::xls::Connection::importWebPrTables ( SequenceInputStream rStrm)

Imports web query table settings from the WEBPRTABLES record.

Definition at line 251 of file connectionsbuffer.cxx.

References maModel, and oox::xls::ConnectionModel::mxWebPr.

Referenced by oox::xls::ConnectionContext::onCreateRecordContext().

Member Data Documentation

◆ maModel

ConnectionModel oox::xls::Connection::maModel
private

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