office-gobmx/include/svl/macitem.hxx
Noel Grandin 8bd9eb8334 loplugin:unusedmethods unused return value in include/svl
Change-Id: I759fe8769daccea07c2157bfb5912df8ba285534
2016-01-13 08:44:46 +02:00

171 lines
5.8 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_SVL_MACITEM_HXX
#define INCLUDED_SVL_MACITEM_HXX
// class SvxMacroItem ----------------------------------------------------
#include <rtl/ustring.hxx>
#include <svl/svldllapi.h>
#include <svl/poolitem.hxx>
#include <map>
class SvStream;
#define SVX_MACRO_LANGUAGE_JAVASCRIPT "JavaScript"
#define SVX_MACRO_LANGUAGE_STARBASIC "StarBasic"
#define SVX_MACRO_LANGUAGE_SF "Script"
enum ScriptType
{
STARBASIC,
JAVASCRIPT,
EXTENDED_STYPE
};
class SVL_DLLPUBLIC SvxMacro
{
OUString aMacName;
OUString aLibName;
ScriptType eType;
public:
SvxMacro( const OUString &rMacName, const OUString &rLanguage);
SvxMacro( const OUString &rMacName, const OUString &rLibName,
ScriptType eType); // = STARBASIC removes
const OUString &GetLibName() const { return aLibName; }
const OUString &GetMacName() const { return aMacName; }
OUString GetLanguage()const;
ScriptType GetScriptType() const { return eType; }
bool HasMacro() const { return !aMacName.isEmpty(); }
SvxMacro& operator=( const SvxMacro& rBase );
};
inline SvxMacro::SvxMacro( const OUString &rMacName, const OUString &rLibName,
ScriptType eTyp )
: aMacName( rMacName ), aLibName( rLibName ), eType( eTyp )
{}
// Macro Table, destroys the pointers in the DTor!
typedef std::map<sal_uInt16, SvxMacro> SvxMacroTable;
#define SVX_MACROTBL_VERSION31 0
#define SVX_MACROTBL_VERSION40 1
#define SVX_MACROTBL_AKTVERSION SVX_MACROTBL_VERSION40
class SVL_DLLPUBLIC SvxMacroTableDtor
{
private:
SvxMacroTable aSvxMacroTable;
public:
inline SvxMacroTableDtor() {}
inline SvxMacroTableDtor( const SvxMacroTableDtor &rCpy ) : aSvxMacroTable(rCpy.aSvxMacroTable) { }
SvxMacroTableDtor& operator=( const SvxMacroTableDtor &rCpy );
bool operator==( const SvxMacroTableDtor& rOther ) const;
void Read( SvStream &, sal_uInt16 nVersion = SVX_MACROTBL_AKTVERSION );
SvStream& Write( SvStream & ) const;
static sal_uInt16 GetVersion() { return SVX_MACROTBL_AKTVERSION; }
SvxMacroTable::iterator begin() { return aSvxMacroTable.begin(); }
SvxMacroTable::const_iterator begin() const { return aSvxMacroTable.begin(); }
SvxMacroTable::iterator end() { return aSvxMacroTable.end(); }
SvxMacroTable::const_iterator end () const { return aSvxMacroTable.end(); }
SvxMacroTable::size_type size() const { return aSvxMacroTable.size(); }
bool empty() const { return aSvxMacroTable.empty(); }
// returns NULL if no entry exists, or a pointer to the internal value
const SvxMacro* Get(sal_uInt16 nEvent) const;
// returns NULL if no entry exists, or a pointer to the internal value
SvxMacro* Get(sal_uInt16 nEvent);
// return true if the key exists
bool IsKeyValid(sal_uInt16 nEvent) const;
// This stores a copy of the rMacro parameter
SvxMacro& Insert(sal_uInt16 nEvent, const SvxMacro& rMacro);
// If the entry exists, remove it from the map and release it's storage
void Erase(sal_uInt16 nEvent);
};
/*
This item describes a Macro table.
*/
class SVL_DLLPUBLIC SvxMacroItem: public SfxPoolItem
{
public:
static SfxPoolItem* CreateDefault();
explicit inline SvxMacroItem ( const sal_uInt16 nId );
// "pure virtual methods" of SfxPoolItem
virtual bool operator==( const SfxPoolItem& ) const override;
virtual bool GetPresentation( SfxItemPresentation ePres,
SfxMapUnit eCoreMetric,
SfxMapUnit ePresMetric,
OUString &rText,
const IntlWrapper * = nullptr ) const override;
virtual SfxPoolItem* Clone( SfxItemPool *pPool = nullptr ) const override;
virtual SfxPoolItem* Create(SvStream &, sal_uInt16) const override;
virtual SvStream& Store(SvStream &, sal_uInt16 nItemVersion ) const override;
virtual sal_uInt16 GetVersion( sal_uInt16 nFileFormatVersion ) const override;
inline const SvxMacroTableDtor& GetMacroTable() const { return aMacroTable;}
inline void SetMacroTable( const SvxMacroTableDtor& rTbl ) { aMacroTable = rTbl; }
inline const SvxMacro& GetMacro( sal_uInt16 nEvent ) const;
inline bool HasMacro( sal_uInt16 nEvent ) const;
void SetMacro( sal_uInt16 nEvent, const SvxMacro& );
private:
SvxMacroTableDtor aMacroTable;
inline SvxMacroItem( const SvxMacroItem& );
SvxMacroItem &operator=( const SvxMacroItem & ) = delete;
};
inline SvxMacroItem::SvxMacroItem( const sal_uInt16 nId )
: SfxPoolItem( nId )
{}
inline SvxMacroItem::SvxMacroItem( const SvxMacroItem &rCpy )
: SfxPoolItem( rCpy ),
aMacroTable( rCpy.GetMacroTable() )
{}
inline bool SvxMacroItem::HasMacro( sal_uInt16 nEvent ) const
{
return aMacroTable.IsKeyValid( nEvent );
}
inline const SvxMacro& SvxMacroItem::GetMacro( sal_uInt16 nEvent ) const
{
return *(aMacroTable.Get(nEvent));
}
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */