binfilter/inc/bf_sc/validat.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: validat.hxx,v $
  10  * $Revision: 1.8 $
  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_VALIDAT_HXX
  32 #define SC_VALIDAT_HXX
  33
  34 #ifndef SC_CONDITIO_HXX
  35 #include "conditio.hxx"
  36 #endif
  37 namespace binfilter {
  38
  39 class ScPatternAttr;
  40 class ScTokenArray;
  41
  42 enum ScValidationMode
  43 {
  44     SC_VALID_ANY,
  45     SC_VALID_WHOLE,
  46     SC_VALID_DECIMAL,
  47     SC_VALID_DATE,
  48     SC_VALID_TIME,
  49     SC_VALID_TEXTLEN,
  50     SC_VALID_LIST,
  51     SC_VALID_CUSTOM
  52 };
  53
  54 enum ScValidErrorStyle
  55 {
  56     SC_VALERR_STOP,
  57     SC_VALERR_WARNING,
  58     SC_VALERR_INFO,
  59     SC_VALERR_MACRO
  60 };
  61
  62 //
  63 //      Eintrag fuer Gueltigkeit (es gibt nur eine Bedingung)
  64 //
  65
  66 class ScValidationData : public ScConditionEntry
  67 {
  68     sal_uInt32                  nKey;                           // Index in Attributen
  69
  70     ScValidationMode    eDataMode;
  71     BOOL                                bShowInput;
  72     BOOL                                bShowError;
  73     ScValidErrorStyle   eErrorStyle;
  74     String                              aInputTitle;
  75     String                              aInputMessage;
  76     String                              aErrorTitle;
  77     String                              aErrorMessage;
  78
  79     BOOL                                bIsUsed;                        // temporaer beim Speichern
  80
  81
  82 public:
  83             ScValidationData( ScValidationMode eMode, ScConditionMode eOper,
  84                                 const String& rExpr1, const String& rExpr2,
  85                                 ScDocument* pDocument, const ScAddress& rPos,
  86                                 BOOL bCompileEnglish = FALSE, BOOL bCompileXML = FALSE );
  87             ScValidationData( const ScValidationData& r );
  88             ScValidationData( ScDocument* pDocument, const ScValidationData& r );
  89             ScValidationData( SvStream& rStream, ScMultipleReadHeader& rHdr,
  90                                 ScDocument* pDocument );
  91             ~ScValidationData();
  92
  93     void                        Store(SvStream& rStream, ScMultipleWriteHeader& rHdr) const;
  94
  95     ScValidationData* Clone() const             // echte Kopie
  96                     { return new ScValidationData( GetDocument(), *this ); }
  97     ScValidationData* Clone(ScDocument* pNew) const
  98                     { return new ScValidationData( pNew, *this ); }
  99
 100     void                        ResetInput();
 101     void                        ResetError();
 102     void                        SetInput( const String& rTitle, const String& rMsg );
 103     void                        SetError( const String& rTitle, const String& rMsg,
 104                                 ScValidErrorStyle eStyle );
 105
 106     BOOL                        GetInput( String& rTitle, String& rMsg ) const
 107                         { rTitle = aInputTitle; rMsg = aInputMessage; return bShowInput; }
 108     BOOL                        GetErrMsg( String& rTitle, String& rMsg, ScValidErrorStyle& rStyle ) const;
 109
 110     BOOL                        HasErrMsg() const               { return bShowError; }
 111
 112     ScValidationMode GetDataMode() const        { return eDataMode; }
 113
 114
 115     BOOL                        IsDataValid( ScBaseCell* pCell, const ScAddress& rPos ) const;
 116
 117                     // TRUE -> Abbruch
 118
 119     BOOL                        IsEmpty() const;
 120     sal_uInt32          GetKey() const                  { return nKey; }
 121     void                        SetKey(sal_uInt32 nNew)         { nKey = nNew; }        // nur wenn nicht eingefuegt!
 122
 123     void                        SetUsed(BOOL bSet)              { bIsUsed = bSet; }
 124     BOOL                        IsUsed() const                  { return bIsUsed; }
 125
 126     BOOL                        EqualEntries( const ScValidationData& r ) const;        // fuer Undo
 127
 128     //  sortiert (per PTRARR) nach Index
 129     //  operator== nur fuer die Sortierung
 130     BOOL operator ==( const ScValidationData& r ) const { return nKey == r.nKey; }
 131     BOOL operator < ( const ScValidationData& r ) const { return nKey <  r.nKey; }
 132 };
 133
 134 //
 135 //      Liste der Bedingungen:
 136 //
 137
 138 typedef ScValidationData* ScValidationDataPtr;
 139
 140 SV_DECL_PTRARR_SORT(ScValidationEntries_Impl, ScValidationDataPtr,
 141                         SC_COND_GROW, SC_COND_GROW)//STRIP008 ;
 142
 143 class ScValidationDataList : public ScValidationEntries_Impl
 144 {
 145 public:
 146         ScValidationDataList() {}
 147         ScValidationDataList(const ScValidationDataList& rList);
 148         ~ScValidationDataList() {}
 149
 150     void        InsertNew( ScValidationData* pNew )
 151                 { if (!Insert(pNew)) delete pNew; }
 152
 153     ScValidationData* GetData( sal_uInt32 nKey );
 154
 155     void        Load( SvStream& rStream, ScDocument* pDocument );
 156     void        Store( SvStream& rStream ) const;
 157     void        ResetUsed();
 158
 159     void        CompileXML();
 160
 161 };
 162
 163 } //namespace binfilter
 164 #endif
 165
 166