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

A column in a filtered range. More...

#include <autofilterbuffer.hxx>

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

Public Member Functions

 FilterColumn (const WorkbookHelper &rHelper)
 
void importFilterColumn (const AttributeList &rAttribs)
 Imports auto filter column settings from the filterColumn element. More...
 
void importFilterColumn (SequenceInputStream &rStrm)
 Imports auto filter column settings from the FILTERCOLUMN record. More...
 
template<typename FilterSettingsType >
FilterSettingsBasecreateFilterSettings ()
 Creates and returns the specified filter settings object. More...
 
ApiFilterSettings finalizeImport (sal_Int32 nMaxCount)
 Returns converted UNO API filter settings representing all filter settings of this column. 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

std::shared_ptr< FilterSettingsBasemxSettings
 
sal_Int32 mnColId
 
bool mbHiddenButton
 
bool mbShowButton
 

Additional Inherited Members

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

Detailed Description

A column in a filtered range.

Contains an object with specific filter settings for the cells in the column.

Definition at line 160 of file autofilterbuffer.hxx.

Constructor & Destructor Documentation

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

Definition at line 494 of file autofilterbuffer.cxx.

Member Function Documentation

template<typename FilterSettingsType >
FilterSettingsBase& oox::xls::FilterColumn::createFilterSettings ( )
inline

Creates and returns the specified filter settings object.

Definition at line 172 of file autofilterbuffer.hxx.

References mxSettings.

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

ApiFilterSettings oox::xls::FilterColumn::finalizeImport ( sal_Int32  nMaxCount)

Returns converted UNO API filter settings representing all filter settings of this column.

Definition at line 518 of file autofilterbuffer.cxx.

References oox::xls::ApiFilterSettings::maFilterFields, mnColId, and mxSettings.

void oox::xls::FilterColumn::importFilterColumn ( const AttributeList rAttribs)

Imports auto filter column settings from the filterColumn element.

Definition at line 502 of file autofilterbuffer.cxx.

References oox::AttributeList::getBool(), oox::AttributeList::getInteger(), mbHiddenButton, mbShowButton, and mnColId.

Referenced by oox::xls::FilterColumnContext::onStartElement(), and oox::xls::FilterColumnContext::onStartRecord().

void oox::xls::FilterColumn::importFilterColumn ( SequenceInputStream rStrm)

Imports auto filter column settings from the FILTERCOLUMN record.

Definition at line 509 of file autofilterbuffer.cxx.

References oox::getFlag(), mbHiddenButton, mbShowButton, mnColId, oox::BinaryInputStream::readInt32(), and oox::BinaryInputStream::readuInt16().

Member Data Documentation

bool oox::xls::FilterColumn::mbHiddenButton
private

Definition at line 183 of file autofilterbuffer.hxx.

Referenced by importFilterColumn().

bool oox::xls::FilterColumn::mbShowButton
private

Definition at line 184 of file autofilterbuffer.hxx.

Referenced by importFilterColumn().

sal_Int32 oox::xls::FilterColumn::mnColId
private

Definition at line 182 of file autofilterbuffer.hxx.

Referenced by finalizeImport(), and importFilterColumn().

std::shared_ptr< FilterSettingsBase > oox::xls::FilterColumn::mxSettings
private

Definition at line 181 of file autofilterbuffer.hxx.

Referenced by createFilterSettings(), and finalizeImport().


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