sc/source/filter/inc/excscen.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: excscen.hxx,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef SC_EXCSCEN_HXX
  32 #define SC_EXCSCEN_HXX
  33
  34 #include <tools/solar.h>
  35 #include <tools/list.hxx>
  36 #include <tools/string.hxx>
  37
  38
  39 struct RootData;
  40 class XclImpRoot;
  41 class XclImpStream;
  42 class ScDocument;
  43
  44
  45
  46 class ExcScenarioCell
  47 {
  48 private:
  49     String                                              aValue;
  50 public:
  51     const UINT16                                nCol;
  52     const UINT16                                nRow;
  53
  54                                 ExcScenarioCell( const UINT16 nC, const UINT16 nR );
  55     void                                                SetValue( const String& rVal );
  56     inline const String&                GetValue( void ) const;
  57 };
  58
  59
  60
  61
  62 class ExcScenario : protected List
  63 {
  64 private:
  65     friend class ExcScenarioList;
  66 protected:
  67     String*                                             pName;
  68     String*                                             pComment;
  69     String*                                             pUserName;
  70     UINT8                                               nProtected;
  71
  72     const UINT16                                nTab;
  73
  74     void                        Apply( const XclImpRoot& rRoot, const BOOL bLast = FALSE );
  75 public:
  76                                 ExcScenario( XclImpStream& rIn, const RootData& rRoot );
  77     virtual                                             ~ExcScenario();
  78 };
  79
  80
  81
  82
  83 class ExcScenarioList : protected List
  84 {
  85 private:
  86     UINT16                                              nLastScenario;
  87     inline ExcScenario*                 _First( void )  { return ( ExcScenario* ) List::First(); }
  88     inline ExcScenario*                 _Next( void )   { return ( ExcScenario* ) List::Next(); }
  89     inline ExcScenario*                 _Last( void )   { return ( ExcScenario* ) List::Last(); }
  90     inline ExcScenario*                 _Prev( void )   { return ( ExcScenario* ) List::Prev(); }
  91 protected:
  92 public:
  93                                 ExcScenarioList( void );
  94     virtual                                             ~ExcScenarioList();
  95
  96     inline void                                 Append( ExcScenario* pNew );
  97
  98     inline void                                 SetLast( const UINT16 nIndex4Last );
  99
 100     inline const ExcScenario*   First( void );
 101     inline const ExcScenario*   Next( void );
 102
 103     using List::Count;
 104
 105     void                        Apply( const XclImpRoot& rRoot );
 106 };
 107
 108
 109
 110
 111 inline const String& ExcScenarioCell::GetValue( void ) const
 112 {
 113     return aValue;
 114 }
 115
 116
 117
 118
 119 inline ExcScenarioList::ExcScenarioList( void )
 120 {
 121     nLastScenario = 0;
 122 }
 123
 124
 125 inline void ExcScenarioList::Append( ExcScenario* p )
 126 {
 127     List::Insert( p, LIST_APPEND );
 128 }
 129
 130
 131 inline const ExcScenario* ExcScenarioList::First( void )
 132 {
 133     return ( const ExcScenario* ) List::First();
 134 }
 135
 136
 137 inline const ExcScenario* ExcScenarioList::Next( void )
 138 {
 139     return ( const ExcScenario* ) List::Next();
 140 }
 141
 142
 143 inline void ExcScenarioList::SetLast( const UINT16 n )
 144 {
 145     nLastScenario = n;
 146 }
 147
 148
 149 #endif
 150