sc/source/ui/inc/editable.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: editable.hxx,v $
  10  * $Revision: 1.4.32.1 $
  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_EDITABLE_HXX
  32 #define SC_EDITABLE_HXX
  33
  34 #include "address.hxx"
  35 #include <tools/solar.h>
  36
  37 class ScDocument;
  38 class ScViewFunc;
  39 class ScMarkData;
  40 class ScRange;
  41
  42
  43 class ScEditableTester
  44 {
  45     BOOL        bIsEditable;
  46     BOOL        bOnlyMatrix;
  47
  48 public:
  49             // no test in ctor
  50             ScEditableTester();
  51
  52             // calls TestBlock
  53             ScEditableTester( ScDocument* pDoc, SCTAB nTab,
  54                         SCCOL nStartCol, SCROW nStartRow, SCCOL nEndCol, SCROW nEndRow );
  55
  56             // calls TestSelectedBlock
  57             ScEditableTester( ScDocument* pDoc,
  58                         SCCOL nStartCol, SCROW nStartRow, SCCOL nEndCol, SCROW nEndRow,
  59                         const ScMarkData& rMark );
  60
  61             // calls TestRange
  62             ScEditableTester( ScDocument* pDoc, const ScRange& rRange );
  63
  64             // calls TestSelection
  65             ScEditableTester( ScDocument* pDoc, const ScMarkData& rMark );
  66
  67             // calls TestView
  68             ScEditableTester( ScViewFunc* pView );
  69
  70             ~ScEditableTester() {}
  71
  72             // Several calls to the Test... methods check if *all* of the ranges
  73             // are editable. For several independent checks, Reset() has to be used.
  74     void        TestBlock( ScDocument* pDoc, SCTAB nTab,
  75                         SCCOL nStartCol, SCROW nStartRow, SCCOL nEndCol, SCROW nEndRow );
  76     void        TestSelectedBlock( ScDocument* pDoc,
  77                         SCCOL nStartCol, SCROW nStartRow, SCCOL nEndCol, SCROW nEndRow,
  78                         const ScMarkData& rMark );
  79     void        TestRange( ScDocument* pDoc, const ScRange& rRange );
  80     void        TestSelection( ScDocument* pDoc, const ScMarkData& rMark );
  81     void        TestView( ScViewFunc* pView );
  82
  83     BOOL        IsEditable() const                      { return bIsEditable; }
  84     BOOL        IsFormatEditable() const        { return bIsEditable || bOnlyMatrix; }
  85     USHORT      GetMessageId() const;
  86 };
  87
  88 #endif
  89