sc/source/ui/inc/editable.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 #ifndef INCLUDED_SC_SOURCE_UI_INC_EDITABLE_HXX
  21 #define INCLUDED_SC_SOURCE_UI_INC_EDITABLE_HXX
  22
  23 #include "address.hxx"
  24
  25 class ScDocument;
  26 class ScViewFunc;
  27 class ScMarkData;
  28 class ScRange;
  29
  30 class ScEditableTester
  31 {
  32     bool mbIsEditable;
  33     bool mbOnlyMatrix;
  34
  35 public:
  36             ScEditableTester();
  37
  38             // calls TestBlock
  39             ScEditableTester( ScDocument* pDoc, SCTAB nTab,
  40                         SCCOL nStartCol, SCROW nStartRow, SCCOL nEndCol, SCROW nEndRow );
  41
  42             // calls TestSelectedBlock
  43             ScEditableTester( ScDocument* pDoc,
  44                         SCCOL nStartCol, SCROW nStartRow, SCCOL nEndCol, SCROW nEndRow,
  45                         const ScMarkData& rMark );
  46
  47             // calls TestRange
  48             ScEditableTester( ScDocument* pDoc, const ScRange& rRange );
  49
  50             // calls TestSelection
  51             ScEditableTester( ScDocument* pDoc, const ScMarkData& rMark );
  52
  53             // calls TestView
  54             ScEditableTester( ScViewFunc* pView );
  55
  56             // Several calls to the Test... methods check if *all* of the ranges
  57             // are editable. For several independent checks, Reset() has to be used.
  58     void    TestBlock( ScDocument* pDoc, SCTAB nTab,
  59                         SCCOL nStartCol, SCROW nStartRow, SCCOL nEndCol, SCROW nEndRow );
  60     void    TestSelectedBlock( ScDocument* pDoc,
  61                         SCCOL nStartCol, SCROW nStartRow, SCCOL nEndCol, SCROW nEndRow,
  62                         const ScMarkData& rMark );
  63     void    TestRange( ScDocument* pDoc, const ScRange& rRange );
  64     void    TestSelection( ScDocument* pDoc, const ScMarkData& rMark );
  65     void    TestView( ScViewFunc* pView );
  66
  67     bool IsEditable() const { return mbIsEditable; }
  68     bool IsFormatEditable() const { return mbIsEditable || mbOnlyMatrix; }
  69     sal_uInt16  GetMessageId() const;
  70 };
  71
  72 #endif
  73
  74 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */