sc/source/filter/inc/scenariobuffer.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #pragma once
  21
  22 #include <oox/helper/refmap.hxx>
  23 #include <oox/helper/refvector.hxx>
  24 #include "workbookhelper.hxx"
  25
  26 namespace oox { class AttributeList; }
  27 namespace oox { class SequenceInputStream; }
  28
  29 namespace oox::xls {
  30
  31 struct ScenarioCellModel
  32 {
  33     ScAddress maPos;
  34     OUString            maValue;
  35     sal_Int32           mnNumFmtId;
  36     bool                mbDeleted;
  37
  38     explicit            ScenarioCellModel();
  39 };
  40
  41 struct ScenarioModel
  42 {
  43     OUString     maName;             /// Name of the scenario.
  44     OUString     maComment;          /// Comment.
  45     OUString     maUser;             /// Name of user created the scenario.
  46     bool                mbLocked;           /// True = input cell values locked.
  47     bool                mbHidden;           /// True = scenario is hidden.
  48     bool                mbActive;
  49
  50     explicit            ScenarioModel();
  51 };
  52
  53 class Scenario : public WorkbookHelper
  54 {
  55 public:
  56     explicit            Scenario( const WorkbookHelper& rHelper, sal_Int16 nSheet, bool bIsActive );
  57
  58     /** Imports a scenario definition from a scenario element. */
  59     void                importScenario( const AttributeList& rAttribs );
  60     /** Imports a new cell for this scenario from an inputCells element. */
  61     void                importInputCells( const AttributeList& rAttribs );
  62
  63     /** Imports a scenario definition from a SCENARIO record. */
  64     void                importScenario( SequenceInputStream& rStrm );
  65     /** Imports a new cell for this scenario from an INPUTCELLS record. */
  66     void                importInputCells( SequenceInputStream& rStrm );
  67
  68     /** Creates the scenario in the Calc document. */
  69     void                finalizeImport();
  70
  71 private:
  72     std::vector< ScenarioCellModel >  maCells;            /// Scenario cells.
  73     ScenarioModel       maModel;            /// Scenario model data.
  74     sal_Int16           mnSheet;            /// Index of the sheet this scenario is based on.
  75 };
  76
  77 struct SheetScenariosModel
  78 {
  79     sal_Int32           mnCurrent;          /// Selected scenario.
  80     sal_Int32           mnShown;            /// Visible scenario.
  81
  82     explicit            SheetScenariosModel();
  83 };
  84
  85 class SheetScenarios : public WorkbookHelper
  86 {
  87 public:
  88     explicit            SheetScenarios( const WorkbookHelper& rHelper, sal_Int16 nSheet );
  89
  90     /** Imports sheet scenario settings from a scenarios element. */
  91     void                importScenarios( const AttributeList& rAttribs );
  92     /** Imports sheet scenario settings from a SCENARIOS record. */
  93     void                importScenarios( SequenceInputStream& rStrm );
  94
  95     /** Creates and returns a new scenario in this collection. */
  96     Scenario&           createScenario();
  97
  98     /** Creates all scenarios in the Calc sheet. */
  99     void                finalizeImport();
 100
 101 private:
 102     typedef RefVector< Scenario > ScenarioVector;
 103     ScenarioVector      maScenarios;
 104     SheetScenariosModel maModel;
 105     sal_Int16           mnSheet;
 106 };
 107
 108 class ScenarioBuffer : public WorkbookHelper
 109 {
 110 public:
 111     explicit            ScenarioBuffer( const WorkbookHelper& rHelper );
 112
 113     /** Creates and returns a scenario collection for the passed sheet. */
 114     SheetScenarios&     createSheetScenarios( sal_Int16 nSheet );
 115
 116     /** Creates all scenarios in the Calc document. */
 117     void                finalizeImport();
 118
 119 private:
 120     typedef RefMap< sal_Int16, SheetScenarios, ::std::greater< sal_Int16 > > SheetScenariosMap;
 121     SheetScenariosMap   maSheetScenarios;
 122 };
 123
 124 } // namespace oox::xls
 125
 126 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */