sc/inc/reftokenhelper.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_INC_REFTOKENHELPER_HXX
  21 #define INCLUDED_SC_INC_REFTOKENHELPER_HXX
  22
  23 #include "token.hxx"
  24
  25 #include <vector>
  26
  27 class ScDocument;
  28 class ScRange;
  29 class ScRangeList;
  30
  31 namespace ScRefTokenHelper
  32 {
  33     /**
  34      * Compile an array of reference tokens from a data source range string.
  35      * The source range may consist of multiple ranges separated by ';'s.
  36      */
  37     void compileRangeRepresentation(
  38         ::std::vector<ScTokenRef>& rRefTokens, const OUString& rRangeStr, ScDocument* pDoc,
  39         const sal_Unicode cSep, ::formula::FormulaGrammar::Grammar eGrammar, bool bOnly3DRef = false);
  40
  41     bool getRangeFromToken(ScRange& rRange, const ScTokenRef& pToken, const ScAddress& rPos, bool bExternal = false);
  42
  43     void getRangeListFromTokens(ScRangeList& rRangeList, const ::std::vector<ScTokenRef>& pTokens, const ScAddress& rPos);
  44
  45     /**
  46      * Create a double reference token from a range object.
  47      */
  48     void getTokenFromRange(ScTokenRef& pToken, const ScRange& rRange);
  49
  50     void getTokensFromRangeList(::std::vector<ScTokenRef>& pTokens, const ScRangeList& rRanges);
  51
  52     bool SC_DLLPUBLIC isRef(const ScTokenRef& pToken);
  53     bool SC_DLLPUBLIC isExternalRef(const ScTokenRef& pToken);
  54
  55     bool SC_DLLPUBLIC intersects(
  56         const ::std::vector<ScTokenRef>& rTokens, const ScTokenRef& pToken, const ScAddress& rPos);
  57
  58     void SC_DLLPUBLIC join(::std::vector<ScTokenRef>& rTokens, const ScTokenRef& pToken, const ScAddress& rPos);
  59
  60     bool getDoubleRefDataFromToken(ScComplexRefData& rData, const ScTokenRef& pToken);
  61
  62     ScTokenRef createRefToken(const ScAddress& rAddr);
  63     ScTokenRef createRefToken(const ScRange& rRange);
  64 };
  65
  66 #endif
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */