sc/inc/sheetlimits.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
   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 <salhelper/simplereferenceobject.hxx>
  23 #include "address.hxx"
  24
  25 // Because some stuff needs this info, and those objects lifetimes sometimes exceeds the lifetime
  26 // of the ScDocument.
  27 struct ScSheetLimits final : public salhelper::SimpleReferenceObject
  28 {
  29     const SCCOL mnMaxCol; /// Maximum addressable column
  30     const SCROW mnMaxRow; /// Maximum addressable row
  31
  32     ScSheetLimits(SCCOL nMaxCol, SCROW nMaxRow)
  33         : mnMaxCol(nMaxCol)
  34         , mnMaxRow(nMaxRow)
  35     {
  36     }
  37
  38     SC_DLLPUBLIC static ScSheetLimits CreateDefault();
  39
  40     [[nodiscard]] bool ValidCol(SCCOL nCol) const { return ::ValidCol(nCol, mnMaxCol); }
  41     [[nodiscard]] bool ValidRow(SCROW nRow) const { return ::ValidRow(nRow, mnMaxRow); }
  42     [[nodiscard]] bool ValidColRow(SCCOL nCol, SCROW nRow) const
  43     {
  44         return ::ValidColRow(nCol, nRow, mnMaxCol, mnMaxRow);
  45     }
  46     [[nodiscard]] bool ValidColRowTab(SCCOL nCol, SCROW nRow, SCTAB nTab) const
  47     {
  48         return ::ValidColRowTab(nCol, nRow, nTab, mnMaxCol, mnMaxRow);
  49     }
  50     [[nodiscard]] bool ValidRange(const ScRange& rRange) const
  51     {
  52         return ::ValidRange(rRange, mnMaxCol, mnMaxRow);
  53     }
  54     [[nodiscard]] bool ValidAddress(const ScAddress& rAddress) const
  55     {
  56         return ::ValidAddress(rAddress, mnMaxCol, mnMaxRow);
  57     }
  58     [[nodiscard]] SCCOL SanitizeCol(SCCOL nCol) const { return ::SanitizeCol(nCol, mnMaxCol); }
  59     [[nodiscard]] SCROW SanitizeRow(SCROW nRow) const { return ::SanitizeRow(nRow, mnMaxRow); }
  60
  61     // equivalent of MAXROW in address.hxx
  62     SCROW MaxRow() const { return mnMaxRow; }
  63     // equivalent of MAXCOL in address.hxx
  64     SCCOL MaxCol() const { return mnMaxCol; }
  65     // equivalent of MAXROWCOUNT in address.hxx
  66     SCROW GetMaxRowCount() const { return mnMaxRow + 1; }
  67     // equivalent of MAXCOLCOUNT in address.hxx
  68     SCCOL GetMaxColCount() const { return mnMaxCol + 1; }
  69     // max row number as string
  70     OUString MaxRowAsString() const
  71     {
  72         return mnMaxRow == MAXROW ? OUString(MAXROW_STRING) : OUString(MAXROW_JUMBO_STRING);
  73     }
  74     // mac col as string ("AMJ" or "XFD")
  75     OUString MaxColAsString() const
  76     {
  77         return mnMaxCol == MAXCOL ? OUString(MAXCOL_STRING) : OUString(MAXCOL_JUMBO_STRING);
  78     }
  79 };
  80
  81 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */