diff options
Diffstat (limited to 'oox/inc/oox/xls/condformatbuffer.hxx')
| -rw-r--r-- | oox/inc/oox/xls/condformatbuffer.hxx | 195 |
1 files changed, 195 insertions, 0 deletions
diff --git a/oox/inc/oox/xls/condformatbuffer.hxx b/oox/inc/oox/xls/condformatbuffer.hxx new file mode 100644 index 000000000000..08d318e0a3c3 --- /dev/null +++ b/oox/inc/oox/xls/condformatbuffer.hxx @@ -0,0 +1,195 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef OOX_XLS_CONDFORMATBUFFER_HXX +#define OOX_XLS_CONDFORMATBUFFER_HXX + +#include <com/sun/star/sheet/ConditionOperator2.hpp> +#include "oox/xls/formulaparser.hxx" +#include "oox/xls/worksheethelper.hxx" + +namespace com { namespace sun { namespace star { + namespace sheet { class XSheetConditionalEntries; } +} } } + +namespace oox { +namespace xls { + +// ============================================================================ + +/** Model for a single rule in a conditional formatting. */ +struct CondFormatRuleModel +{ + typedef ::std::vector< TokensFormulaContext > ContextVector; + + ContextVector maFormulas; /// Formulas for rule conditions. + ::rtl::OUString maText; /// Text for 'contains' rules. + sal_Int32 mnPriority; /// Priority of this rule. + sal_Int32 mnType; /// Type of the rule. + sal_Int32 mnOperator; /// In cell-is rules: Comparison operator. + sal_Int32 mnTimePeriod; /// In time-period rules: Type of time period. + sal_Int32 mnRank; /// In top-10 rules: True = bottom, false = top. + sal_Int32 mnStdDev; /// In average rules: Number of std deviations. + sal_Int32 mnDxfId; /// Differential formatting identifier. + bool mbStopIfTrue; /// True = stop evaluating rules, if this rule is true. + bool mbBottom; /// In top-10 rules: True = bottom, false = top. + bool mbPercent; /// In top-10 rules: True = percent, false = rank. + bool mbAboveAverage; /// In average rules: True = above average, false = below. + bool mbEqualAverage; /// In average rules: True = include average, false = exclude. + + explicit CondFormatRuleModel(); + + /** Sets the passed BIFF operator for condition type cellIs. */ + void setBiffOperator( sal_Int32 nOperator ); + + /** Sets the passed BIFF12 text comparison type and operator. */ + void setBiff12TextType( sal_Int32 nOperator ); +}; + +// ============================================================================ + +class CondFormat; + +/** Represents a single rule in a conditional formatting. */ +class CondFormatRule : public WorksheetHelper +{ +public: + explicit CondFormatRule( const CondFormat& rCondFormat ); + + /** Imports rule settings from the cfRule element. */ + void importCfRule( const AttributeList& rAttribs ); + /** Appends a new condition formula string. */ + void appendFormula( const ::rtl::OUString& rFormula ); + + /** Imports rule settings from a CFRULE record. */ + void importCfRule( SequenceInputStream& rStrm ); + + /** Imports rule settings from a CFRULE record. */ + void importCfRule( BiffInputStream& rStrm, sal_Int32 nPriority ); + + /** Creates a conditional formatting rule in the Calc document. */ + void finalizeImport( + const ::com::sun::star::uno::Reference< ::com::sun::star::sheet::XSheetConditionalEntries >& rxEntries ); + + /** Returns the priority of this rule. */ + inline sal_Int32 getPriority() const { return maModel.mnPriority; } + +private: + const CondFormat& mrCondFormat; + CondFormatRuleModel maModel; +}; + +typedef ::boost::shared_ptr< CondFormatRule > CondFormatRuleRef; + +// ============================================================================ + +/** Model for a conditional formatting object. */ +struct CondFormatModel +{ + ApiCellRangeList maRanges; /// Cell ranges for this conditional format. + bool mbPivot; /// Conditional formatting belongs to pivot table. + + explicit CondFormatModel(); +}; + +// ============================================================================ + +/** Represents a conditional formatting object with a list of affected cell ranges. */ +class CondFormat : public WorksheetHelper +{ +public: + explicit CondFormat( const WorksheetHelper& rHelper ); + + /** Imports settings from the conditionalFormatting element. */ + void importConditionalFormatting( const AttributeList& rAttribs ); + /** Imports a conditional formatting rule from the cfRule element. */ + CondFormatRuleRef importCfRule( const AttributeList& rAttribs ); + + /** Imports settings from the CONDFORMATTING record. */ + void importCondFormatting( SequenceInputStream& rStrm ); + /** Imports a conditional formatting rule from the CFRULE record. */ + void importCfRule( SequenceInputStream& rStrm ); + + /** Imports settings from the CFHEADER record. */ + void importCfHeader( BiffInputStream& rStrm ); + + /** Creates the conditional formatting in the Calc document. */ + void finalizeImport(); + + /** Returns the cell ranges this conditional formatting belongs to. */ + inline const ApiCellRangeList& getRanges() const { return maModel.maRanges; } + +private: + CondFormatRuleRef createRule(); + void insertRule( CondFormatRuleRef xRule ); + +private: + typedef RefMap< sal_Int32, CondFormatRule > CondFormatRuleMap; + + CondFormatModel maModel; /// Model of this conditional formatting. + CondFormatRuleMap maRules; /// Maps formatting rules by priority. +}; + +typedef ::boost::shared_ptr< CondFormat > CondFormatRef; + +// ============================================================================ + +class CondFormatBuffer : public WorksheetHelper +{ +public: + explicit CondFormatBuffer( const WorksheetHelper& rHelper ); + + /** Imports settings from the conditionalFormatting element. */ + CondFormatRef importConditionalFormatting( const AttributeList& rAttribs ); + /** Imports settings from the CONDFORMATTING record. */ + CondFormatRef importCondFormatting( SequenceInputStream& rStrm ); + /** Imports settings from the CFHEADER record. */ + void importCfHeader( BiffInputStream& rStrm ); + + /** Creates all conditional formattings in the Calc document. */ + void finalizeImport(); + + /** Converts an OOXML condition operator token to the API constant. */ + static sal_Int32 convertToApiOperator( sal_Int32 nToken ); + +private: + CondFormatRef createCondFormat(); + +private: + typedef RefVector< CondFormat > CondFormatVec; + CondFormatVec maCondFormats; /// All conditional formattings in a sheet. +}; + +// ============================================================================ + +} // namespace xls +} // namespace oox + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
\ No newline at end of file |