include/svl/macitem.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 #ifndef INCLUDED_SVL_MACITEM_HXX
  20 #define INCLUDED_SVL_MACITEM_HXX
  21
  22 // class SvxMacroItem ----------------------------------------------------
  23
  24 #include <rtl/ustring.hxx>
  25 #include <svl/svldllapi.h>
  26 #include <svl/poolitem.hxx>
  27 #include <map>
  28
  29 class SvStream;
  30
  31 #define SVX_MACRO_LANGUAGE_JAVASCRIPT "JavaScript"
  32 #define SVX_MACRO_LANGUAGE_STARBASIC "StarBasic"
  33 #define SVX_MACRO_LANGUAGE_SF "Script"
  34
  35 enum ScriptType
  36 {
  37     STARBASIC,
  38     JAVASCRIPT,
  39     EXTENDED_STYPE
  40 };
  41
  42 class SVL_DLLPUBLIC SvxMacro
  43 {
  44     OUString aMacName;
  45     OUString aLibName;
  46     ScriptType eType;
  47
  48 public:
  49
  50     SvxMacro( const OUString &rMacName, const OUString &rLanguage);
  51
  52     SvxMacro( const OUString &rMacName, const OUString &rLibName,
  53                 ScriptType eType); //  = STARBASIC removes
  54
  55     const OUString &GetLibName() const        { return aLibName; }
  56     const OUString &GetMacName() const        { return aMacName; }
  57     OUString GetLanguage()const;
  58
  59     ScriptType GetScriptType() const        { return eType; }
  60
  61     bool HasMacro() const { return !aMacName.isEmpty(); }
  62
  63     SvxMacro& operator=( const SvxMacro& rBase );
  64 };
  65
  66 inline SvxMacro::SvxMacro( const OUString &rMacName, const OUString &rLibName,
  67                             ScriptType eTyp )
  68     : aMacName( rMacName ), aLibName( rLibName ), eType( eTyp )
  69 {}
  70
  71 // Macro Table, destroys the pointers in the DTor!
  72 typedef std::map<sal_uInt16, SvxMacro> SvxMacroTable;
  73
  74 #define SVX_MACROTBL_VERSION31  0
  75 #define SVX_MACROTBL_VERSION40  1
  76
  77 #define SVX_MACROTBL_AKTVERSION SVX_MACROTBL_VERSION40
  78
  79 class SVL_DLLPUBLIC SvxMacroTableDtor
  80 {
  81 private:
  82     SvxMacroTable aSvxMacroTable;
  83 public:
  84     inline SvxMacroTableDtor() {}
  85     inline SvxMacroTableDtor( const SvxMacroTableDtor &rCpy ) : aSvxMacroTable(rCpy.aSvxMacroTable) { }
  86
  87     SvxMacroTableDtor& operator=( const SvxMacroTableDtor &rCpy );
  88     bool operator==( const SvxMacroTableDtor& rOther ) const;
  89
  90     void        Read( SvStream &, sal_uInt16 nVersion = SVX_MACROTBL_AKTVERSION );
  91     SvStream&   Write( SvStream & ) const;
  92
  93     static sal_uInt16 GetVersion() { return SVX_MACROTBL_AKTVERSION; }
  94
  95     SvxMacroTable::iterator begin() { return aSvxMacroTable.begin(); }
  96     SvxMacroTable::const_iterator begin() const { return aSvxMacroTable.begin(); }
  97     SvxMacroTable::iterator end() { return aSvxMacroTable.end(); }
  98     SvxMacroTable::const_iterator end () const { return aSvxMacroTable.end(); }
  99     SvxMacroTable::size_type size() const { return aSvxMacroTable.size(); }
 100     bool empty() const { return aSvxMacroTable.empty(); }
 101
 102     // returns NULL if no entry exists, or a pointer to the internal value
 103     const SvxMacro* Get(sal_uInt16 nEvent) const;
 104     // returns NULL if no entry exists, or a pointer to the internal value
 105     SvxMacro* Get(sal_uInt16 nEvent);
 106     // return true if the key exists
 107     bool IsKeyValid(sal_uInt16 nEvent) const;
 108     // This stores a copy of the rMacro parameter
 109     SvxMacro& Insert(sal_uInt16 nEvent, const SvxMacro& rMacro);
 110     // If the entry exists, remove it from the map and release it's storage
 111     void Erase(sal_uInt16 nEvent);
 112 };
 113
 114
 115 /*
 116 This item describes a Macro table.
 117 */
 118
 119 class SVL_DLLPUBLIC SvxMacroItem: public SfxPoolItem
 120 {
 121 public:
 122     static SfxPoolItem* CreateDefault();
 123
 124     explicit inline SvxMacroItem ( const sal_uInt16 nId );
 125
 126     // "pure virtual methods" of SfxPoolItem
 127     virtual bool            operator==( const SfxPoolItem& ) const override;
 128     virtual bool GetPresentation( SfxItemPresentation ePres,
 129                                     SfxMapUnit eCoreMetric,
 130                                     SfxMapUnit ePresMetric,
 131                                     OUString &rText,
 132                                     const IntlWrapper * = nullptr ) const override;
 133     virtual SfxPoolItem*    Clone( SfxItemPool *pPool = nullptr ) const override;
 134     virtual SfxPoolItem*    Create(SvStream &, sal_uInt16) const override;
 135     virtual SvStream&       Store(SvStream &, sal_uInt16 nItemVersion ) const override;
 136     virtual sal_uInt16          GetVersion( sal_uInt16 nFileFormatVersion ) const override;
 137
 138     inline const SvxMacroTableDtor& GetMacroTable() const { return aMacroTable;}
 139     inline void SetMacroTable( const SvxMacroTableDtor& rTbl ) { aMacroTable = rTbl; }
 140
 141     inline const SvxMacro& GetMacro( sal_uInt16 nEvent ) const;
 142     inline bool HasMacro( sal_uInt16 nEvent ) const;
 143            void SetMacro( sal_uInt16 nEvent, const SvxMacro& );
 144
 145 private:
 146     SvxMacroTableDtor aMacroTable;
 147
 148     inline SvxMacroItem( const SvxMacroItem& );
 149     SvxMacroItem &operator=( const SvxMacroItem & ) = delete;
 150 };
 151
 152 inline SvxMacroItem::SvxMacroItem( const sal_uInt16 nId )
 153     : SfxPoolItem( nId )
 154 {}
 155 inline SvxMacroItem::SvxMacroItem( const SvxMacroItem &rCpy )
 156     : SfxPoolItem( rCpy ),
 157     aMacroTable( rCpy.GetMacroTable() )
 158 {}
 159
 160 inline bool SvxMacroItem::HasMacro( sal_uInt16 nEvent ) const
 161 {
 162     return aMacroTable.IsKeyValid( nEvent );
 163 }
 164 inline const SvxMacro& SvxMacroItem::GetMacro( sal_uInt16 nEvent ) const
 165 {
 166     return *(aMacroTable.Get(nEvent));
 167 }
 168
 169 #endif
 170
 171 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */