LibreOffice Module sc (master)  1
xename.hxx
Go to the documentation of this file.
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 "xlformula.hxx"
25 #include "xeroot.hxx"
26 #include <memory>
27 
28 class ScRangeList;
30 
33 {
34 public:
35  explicit XclExpNameManager( const XclExpRoot& rRoot );
36  virtual ~XclExpNameManager() override;
37 
39  void Initialize();
40 
42  sal_uInt16 InsertName( SCTAB nTab, sal_uInt16 nScNameIdx, SCTAB nCurrTab );
43 
45  sal_uInt16 InsertBuiltInName( sal_Unicode cBuiltIn, const ScRange& rRange );
47  sal_uInt16 InsertBuiltInName( sal_Unicode cBuiltIn, const ScRangeList& rRangeList );
48 
50  sal_uInt16 InsertUniqueName( const OUString& rName, const XclTokenArrayRef& xTokArr, SCTAB nScTab );
52  sal_uInt16 InsertRawName( const OUString& rName );
56  sal_uInt16 InsertMacroCall( const OUString& rMacroName, bool bVBasic, bool bFunc, bool bHidden = false );
57 
59  const OUString& GetOrigName( sal_uInt16 nNameIdx ) const;
61  SCTAB GetScTab( sal_uInt16 nNameIdx ) const;
63  bool IsVolatile( sal_uInt16 nNameIdx ) const;
64 
66  virtual void Save( XclExpStream& rStrm ) override;
67  virtual void SaveXml( XclExpXmlStream& rStrm ) override;
68 
69 private:
70  typedef std::shared_ptr< XclExpNameManagerImpl > XclExpNameMgrImplRef;
71  XclExpNameMgrImplRef mxImpl;
72 };
73 
74 #endif
75 
76 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
virtual ~XclExpNameManager() override
Definition: xename.cxx:793
This class is used to export Excel record streams.
Definition: xestream.hxx:71
bool IsVolatile(sal_uInt16 nNameIdx) const
Returns true, if the specified defined name is volatile.
Definition: xename.cxx:852
XclExpNameMgrImplRef mxImpl
Definition: xename.hxx:71
virtual void Save(XclExpStream &rStrm) override
Writes the entire list of NAME records.
Definition: xename.cxx:858
SCTAB GetScTab(sal_uInt16 nNameIdx) const
Returns the Calc sheet of a local defined name, or SCTAB_GLOBAL for global defined names...
Definition: xename.cxx:846
sal_uInt16 sal_Unicode
Access to global data from other classes.
Definition: xeroot.hxx:113
sal_uInt16 InsertUniqueName(const OUString &rName, const XclTokenArrayRef &xTokArr, SCTAB nScTab)
Inserts a new defined name.
Definition: xename.cxx:824
Base class for all Excel records.
Definition: xerecord.hxx:39
virtual void SaveXml(XclExpXmlStream &rStrm) override
Definition: xename.cxx:863
Manager that stores all internal defined names (NAME records) of the document.
Definition: xename.hxx:32
sal_uInt16 InsertRawName(const OUString &rName)
Returns index of an existing name, or creates a name without definition.
Definition: xename.cxx:830
const OUString & GetOrigName(sal_uInt16 nNameIdx) const
Returns the Calc sheet of a local defined name, or SCTAB_GLOBAL for global defined names...
Definition: xename.cxx:840
std::shared_ptr< XclExpNameManagerImpl > XclExpNameMgrImplRef
Definition: xename.hxx:70
std::shared_ptr< XclTokenArray > XclTokenArrayRef
Definition: xlformula.hxx:417
sal_uInt16 InsertBuiltInName(sal_Unicode cBuiltIn, const ScRange &rRange)
Inserts a new built-in defined name, referring to the passed sheet range.
Definition: xename.cxx:807
Implementation class of the name manager.
Definition: xename.cxx:115
sal_uInt16 InsertMacroCall(const OUString &rMacroName, bool bVBasic, bool bFunc, bool bHidden=false)
Searches or inserts a defined name describing a macro name.
Definition: xename.cxx:835
void Initialize()
Creates NAME records for built-in and user defined names.
Definition: xename.cxx:797
XclExpNameManager(const XclExpRoot &rRoot)
Definition: xename.cxx:787
sal_uInt16 InsertName(SCTAB nTab, sal_uInt16 nScNameIdx, SCTAB nCurrTab)
Inserts the Calc name with the passed index and returns the Excel NAME index.
Definition: xename.cxx:802
void SvStream & rStrm
sal_Int16 SCTAB
Definition: types.hxx:23