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

#include <tablebuffer.hxx>

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

Public Member Functions

 Table (const WorkbookHelper &rHelper)
 
void importTable (const AttributeList &rAttribs, sal_Int16 nSheet)
 Imports a table definition from the passed attributes. More...
 
void importTable (SequenceInputStream &rStrm, sal_Int16 nSheet)
 Imports a table definition from a TABLE record. More...
 
AutoFiltercreateAutoFilter ()
 Creates a new auto filter and stores it internally. More...
 
TableColumnscreateTableColumns ()
 Creates a new tableColumns handler and stores it internally. More...
 
void finalizeImport ()
 Creates a database range from this tables. More...
 
void applyAutoFilters ()
 
void applyTableColumns ()
 
sal_Int32 getTableId () const
 Returns the unique table identifier. More...
 
sal_Int32 getTokenIndex () const
 Returns the token index used in API token arrays (com.sun.star.sheet.FormulaToken). More...
 
const OUString & getDisplayName () const
 Returns the original display name of the table. More...
 
const ScRangegetOriginalRange () const
 Returns the original (unchecked) total range of the table. More...
 
const ScRangegetRange () const
 Returns the cell range of this table. More...
 
SCCOL getWidth () const
 Returns the number of columns of this table. More...
 
SCROW getHeight () const
 Returns the number of rows of this table. More...
 
sal_Int32 getHeaderRows () const
 Returns the number of header rows in the table range. More...
 
sal_Int32 getTotalsRows () const
 Returns the number of totals rows in the table range. 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...
 
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...
 
ScRangeDatacreateNamedRangeObject (OUString &orName, const css::uno::Sequence< css::sheet::FormulaToken > &rTokens, sal_Int32 nIndex, sal_Int32 nNameFlags) const
 Creates and returns a defined name on-the-fly in the Calc document. More...
 
ScRangeDatacreateLocalNamedRangeObject (OUString &orName, const css::uno::Sequence< css::sheet::FormulaToken > &rTokens, sal_Int32 nIndex, sal_Int32 nNameFlags, sal_Int32 nTab) 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

TableModel maModel
 
AutoFilterBuffer maAutoFilters
 
TableColumnsBuffer maTableColumns
 Filter settings for this table. More...
 
OUString maDBRangeName
 Column names of this table. More...
 
ScRange maDestRange
 Name of the database range in the Calc document. More...
 
sal_Int32 mnTokenIndex
 Validated range of the table in the worksheet. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from oox::xls::WorkbookHelper
static WorkbookGlobalsRef constructGlobals (ExcelFilter &rFilter)
 

Detailed Description

Definition at line 43 of file tablebuffer.hxx.

Constructor & Destructor Documentation

Table::Table ( const WorkbookHelper rHelper)
explicit

Definition at line 49 of file tablebuffer.cxx.

Member Function Documentation

void Table::applyAutoFilters ( )
void Table::applyTableColumns ( )
AutoFilter& oox::xls::Table::createAutoFilter ( )
inline

Creates a new auto filter and stores it internally.

Definition at line 53 of file tablebuffer.hxx.

References oox::xls::AutoFilterBuffer::createAutoFilter(), and maAutoFilters.

Referenced by oox::xls::TableFragment::onCreateContext(), and oox::xls::TableFragment::onCreateRecordContext().

TableColumns& oox::xls::Table::createTableColumns ( )
inline

Creates a new tableColumns handler and stores it internally.

Definition at line 55 of file tablebuffer.hxx.

References oox::xls::TableColumnsBuffer::createTableColumns(), and maTableColumns.

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

void Table::finalizeImport ( )
const OUString& oox::xls::Table::getDisplayName ( ) const
inline

Returns the original display name of the table.

Definition at line 67 of file tablebuffer.hxx.

References oox::xls::TableModel::maDisplayName, and maModel.

sal_Int32 oox::xls::Table::getHeaderRows ( ) const
inline

Returns the number of header rows in the table range.

Definition at line 78 of file tablebuffer.hxx.

References maModel, and oox::xls::TableModel::mnHeaderRows.

SCROW oox::xls::Table::getHeight ( ) const
inline

Returns the number of rows of this table.

Definition at line 76 of file tablebuffer.hxx.

References ScRange::aEnd, ScRange::aStart, maDestRange, and ScAddress::Row().

const ScRange& oox::xls::Table::getOriginalRange ( ) const
inline

Returns the original (unchecked) total range of the table.

Definition at line 70 of file tablebuffer.hxx.

References maModel, and oox::xls::TableModel::maRange.

const ScRange& oox::xls::Table::getRange ( ) const
inline

Returns the cell range of this table.

Definition at line 72 of file tablebuffer.hxx.

References maDestRange.

sal_Int32 oox::xls::Table::getTableId ( ) const
inline

Returns the unique table identifier.

Definition at line 63 of file tablebuffer.hxx.

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

sal_Int32 oox::xls::Table::getTokenIndex ( ) const
inline

Returns the token index used in API token arrays (com.sun.star.sheet.FormulaToken).

Definition at line 65 of file tablebuffer.hxx.

References mnTokenIndex.

sal_Int32 oox::xls::Table::getTotalsRows ( ) const
inline

Returns the number of totals rows in the table range.

Definition at line 80 of file tablebuffer.hxx.

References maModel, and oox::xls::TableModel::mnTotalsRows.

SCCOL oox::xls::Table::getWidth ( ) const
inline

Returns the number of columns of this table.

Definition at line 74 of file tablebuffer.hxx.

References ScRange::aEnd, ScRange::aStart, ScAddress::Col(), and maDestRange.

void Table::importTable ( const AttributeList rAttribs,
sal_Int16  nSheet 
)
void Table::importTable ( SequenceInputStream rStrm,
sal_Int16  nSheet 
)

Member Data Documentation

AutoFilterBuffer oox::xls::Table::maAutoFilters
private

Definition at line 84 of file tablebuffer.hxx.

Referenced by applyAutoFilters(), and createAutoFilter().

OUString oox::xls::Table::maDBRangeName
private

Column names of this table.

Definition at line 86 of file tablebuffer.hxx.

Referenced by applyAutoFilters(), and finalizeImport().

ScRange oox::xls::Table::maDestRange
private

Name of the database range in the Calc document.

Definition at line 87 of file tablebuffer.hxx.

Referenced by finalizeImport(), getHeight(), getRange(), and getWidth().

TableModel oox::xls::Table::maModel
private
TableColumnsBuffer oox::xls::Table::maTableColumns
private

Filter settings for this table.

Definition at line 85 of file tablebuffer.hxx.

Referenced by applyTableColumns(), and createTableColumns().

sal_Int32 oox::xls::Table::mnTokenIndex
private

Validated range of the table in the worksheet.

Definition at line 88 of file tablebuffer.hxx.

Referenced by applyTableColumns(), finalizeImport(), and getTokenIndex().


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