sc/source/filter/inc/xename.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_FILTER_INC_XENAME_HXX
  21 #define INCLUDED_SC_SOURCE_FILTER_INC_XENAME_HXX
  22
  23 #include "xerecord.hxx"
  24 #include "xlname.hxx"
  25 #include "xlformula.hxx"
  26 #include "xeroot.hxx"
  27 #include <boost/shared_ptr.hpp>
  28
  29 class ScRangeList;
  30 class XclExpNameManagerImpl;
  31
  32 /** Manager that stores all internal defined names (NAME records) of the document. */
  33 class XclExpNameManager : public XclExpRecordBase, protected XclExpRoot
  34 {
  35 public:
  36     explicit            XclExpNameManager( const XclExpRoot& rRoot );
  37     virtual             ~XclExpNameManager();
  38
  39     /** Creates NAME records for built-in and user defined names. */
  40     void                Initialize();
  41
  42     /** Inserts the Calc name with the passed index and returns the Excel NAME index. */
  43     sal_uInt16          InsertName( SCTAB nTab, sal_uInt16 nScNameIdx );
  44     /** Inserts the Calc database range with the passed index and returns the Excel NAME index. */
  45     sal_uInt16          InsertDBRange( sal_uInt16 nScDBRangeIdx );
  46
  47     /** Inserts a new built-in defined name, referring to the passed sheet range. */
  48     sal_uInt16          InsertBuiltInName( sal_Unicode cBuiltIn, const ScRange& rRange );
  49     /** Inserts a new built-in defined name, referring to the passed sheet range list. */
  50     sal_uInt16          InsertBuiltInName( sal_Unicode cBuiltIn, const ScRangeList& rRangeList );
  51
  52     /** Inserts a new defined name. Sets another unused name, if rName already exists. */
  53     sal_uInt16          InsertUniqueName( const OUString& rName, XclTokenArrayRef xTokArr, SCTAB nScTab );
  54     /** Returns index of an existing name, or creates a name without definition. */
  55     sal_uInt16          InsertRawName( const OUString& rName );
  56     /** Searches or inserts a defined name describing a macro name.
  57         @param bVBasic  true = Visual Basic macro, false = Sheet macro.
  58         @param bFunc  true = Macro function; false = Macro procedure. */
  59     sal_uInt16          InsertMacroCall( const OUString& rMacroName, bool bVBasic, bool bFunc, bool bHidden = false );
  60
  61     /** Returns the Calc sheet of a local defined name, or SCTAB_GLOBAL for global defined names. */
  62     const OUString&     GetOrigName( sal_uInt16 nNameIdx ) const;
  63     /** Returns the Calc sheet of a local defined name, or SCTAB_GLOBAL for global defined names. */
  64     SCTAB               GetScTab( sal_uInt16 nNameIdx ) const;
  65     /** Returns true, if the specified defined name is volatile. */
  66     bool                IsVolatile( sal_uInt16 nNameIdx ) const;
  67
  68     /** Writes the entire list of NAME records. */
  69     virtual void        Save( XclExpStream& rStrm ) SAL_OVERRIDE;
  70     virtual void        SaveXml( XclExpXmlStream& rStrm ) SAL_OVERRIDE;
  71
  72 private:
  73     typedef boost::shared_ptr< XclExpNameManagerImpl > XclExpNameMgrImplRef;
  74     XclExpNameMgrImplRef mxImpl;
  75 };
  76
  77 #endif
  78
  79 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */