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

Settings for a custom filter, specifying one or two comparison operators associated with some values. More...

#include <autofilterbuffer.hxx>

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

Public Member Functions

 CustomFilter (const WorkbookHelper &rHelper)
 
virtual void importAttribs (sal_Int32 nElement, const AttributeList &rAttribs) override
 Imports filter settings from the filters and filter elements. More...
 
virtual void importRecord (sal_Int32 nRecId, SequenceInputStream &rStrm) override
 Imports filter settings from the FILTERS and FILTER records. More...
 
virtual ApiFilterSettings finalizeImport () override
 Returns converted UNO API filter settings representing all filter settings. More...
 
- Public Member Functions inherited from oox::xls::FilterSettingsBase
 FilterSettingsBase (const WorkbookHelper &rHelper)
 
virtual void importAttribs (sal_Int32 nElement, const AttributeList &rAttribs)
 Derived classes import filter settings from the passed attribute list. More...
 
virtual void importRecord (sal_Int32 nRecId, SequenceInputStream &rStrm)
 Derived classes import filter settings from the passed record. More...
 
virtual ApiFilterSettings finalizeImport ()
 Derived classes return converted UNO API filter settings representing all filter settings. 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 Types

typedef ::std::vector< FilterCriterionModelFilterCriterionVector
 

Private Member Functions

void appendCriterion (const FilterCriterionModel &rCriterion)
 Appends the passed filter criterion, if it contains valid settings. More...
 

Private Attributes

FilterCriterionVector maCriteria
 
bool mbAnd
 

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

Settings for a custom filter, specifying one or two comparison operators associated with some values.

Definition at line 155 of file autofilterbuffer.hxx.

Member Typedef Documentation

◆ FilterCriterionVector

Definition at line 173 of file autofilterbuffer.hxx.

Constructor & Destructor Documentation

◆ CustomFilter()

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

Definition at line 505 of file autofilterbuffer.cxx.

Member Function Documentation

◆ appendCriterion()

void oox::xls::CustomFilter::appendCriterion ( const FilterCriterionModel rCriterion)
private

Appends the passed filter criterion, if it contains valid settings.

Definition at line 617 of file autofilterbuffer.cxx.

References maCriteria, oox::xls::FilterCriterionModel::maValue, oox::xls::FilterCriterionModel::mnOperator, and XML_TOKEN_INVALID.

Referenced by importAttribs(), and importRecord().

◆ finalizeImport()

ApiFilterSettings oox::xls::CustomFilter::finalizeImport ( )
overridevirtual

Returns converted UNO API filter settings representing all filter settings.

Reimplemented from oox::xls::FilterSettingsBase.

Definition at line 550 of file autofilterbuffer.cxx.

References oox::xls::ApiFilterSettings::appendField(), maCriteria, mbAnd, and oox::xls::ApiFilterSettings::mobNeedsRegExp.

◆ importAttribs()

void oox::xls::CustomFilter::importAttribs ( sal_Int32  nElement,
const AttributeList rAttribs 
)
overridevirtual

◆ importRecord()

void oox::xls::CustomFilter::importRecord ( sal_Int32  nRecId,
SequenceInputStream rStrm 
)
overridevirtual

Imports filter settings from the FILTERS and FILTER records.

Reimplemented from oox::xls::FilterSettingsBase.

Definition at line 532 of file autofilterbuffer.cxx.

References appendCriterion(), oox::xls::BIFF12_ID_CUSTOMFILTER, oox::xls::BIFF12_ID_CUSTOMFILTERS, mbAnd, oox::xls::FilterCriterionModel::readBiffData(), and rStrm.

Member Data Documentation

◆ maCriteria

FilterCriterionVector oox::xls::CustomFilter::maCriteria
private

Definition at line 175 of file autofilterbuffer.hxx.

Referenced by appendCriterion(), and finalizeImport().

◆ mbAnd

bool oox::xls::CustomFilter::mbAnd
private

Definition at line 176 of file autofilterbuffer.hxx.

Referenced by finalizeImport(), importAttribs(), and importRecord().


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