include/svx/SmartTagItem.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_SVX_SMARTTAGITEM_HXX
  20 #define INCLUDED_SVX_SMARTTAGITEM_HXX
  21
  22 #include <svl/poolitem.hxx>
  23 #include <com/sun/star/uno/Reference.hxx>
  24 #include <com/sun/star/uno/Sequence.hxx>
  25 #include <com/sun/star/smarttags/XSmartTagAction.hpp>
  26 #include <svx/svxdllapi.h>
  27
  28 namespace com { namespace sun { namespace star { namespace container {
  29     class XStringKeyMap;
  30 } } } }
  31
  32 namespace com { namespace sun { namespace star { namespace text {
  33     class XTextRange;
  34 } } } }
  35
  36 namespace com { namespace sun { namespace star { namespace frame {
  37     class XController;
  38 } } } }
  39
  40 // class SvxSmartTagItem -----------------------------------------------------
  41
  42 class SVX_DLLPUBLIC SvxSmartTagItem : public SfxPoolItem
  43 {
  44     const css::uno::Sequence < css::uno::Sequence< css::uno::Reference< css::smarttags::XSmartTagAction > > > maActionComponentsSequence;
  45     const css::uno::Sequence < css::uno::Sequence< sal_Int32 > > maActionIndicesSequence;
  46     const css::uno::Sequence< css::uno::Reference< css::container::XStringKeyMap > > maStringKeyMaps;
  47     const css::uno::Reference<css::text::XTextRange> mxRange;
  48     const css::uno::Reference<css::frame::XController> mxController;
  49     const css::lang::Locale maLocale;
  50     const OUString maApplicationName;
  51     const OUString maRangeText;
  52
  53 public:
  54     static SfxPoolItem* CreateDefault();
  55
  56     SvxSmartTagItem( const sal_uInt16 nId,
  57                      const css::uno::Sequence < css::uno::Sequence< css::uno::Reference< css::smarttags::XSmartTagAction > > >& rActionComponentsSequence,
  58                      const css::uno::Sequence < css::uno::Sequence< sal_Int32 > >& rActionIndicesSequence,
  59                      const css::uno::Sequence< css::uno::Reference< css::container::XStringKeyMap > >& rStringKeyMaps,
  60                      const css::uno::Reference<css::text::XTextRange>& rRange,
  61                      const css::uno::Reference<css::frame::XController>& rController,
  62                      const css::lang::Locale& rLocale,
  63                      const OUString& rApplicationName,
  64                      const OUString& rRangeText );
  65
  66     // "purely virtual methods" from the SfxPoolItem
  67     virtual bool             operator==( const SfxPoolItem& ) const override;
  68     virtual SfxPoolItem*     Clone( SfxItemPool *pPool = nullptr ) const override;
  69     virtual SfxPoolItem*     Create(SvStream &, sal_uInt16) const override; // leer
  70     virtual SvStream&        Store(SvStream &, sal_uInt16 nItemVersion) const override; // leer
  71     virtual bool             QueryValue( css::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const override;
  72     virtual bool             PutValue( const css::uno::Any& rVal, sal_uInt8 nMemberId ) override;
  73
  74     const css::uno::Sequence < css::uno::Sequence< css::uno::Reference< css::smarttags::XSmartTagAction > > >& GetActionComponentsSequence() const { return maActionComponentsSequence; }
  75     const css::uno::Sequence < css::uno::Sequence< sal_Int32 > >& GetActionIndicesSequence() const { return maActionIndicesSequence; }
  76     const css::uno::Sequence< css::uno::Reference< css::container::XStringKeyMap > >& GetStringKeyMaps() const { return maStringKeyMaps; }
  77     const css::uno::Reference<css::text::XTextRange>& GetTextRange() const { return mxRange; }
  78     const css::uno::Reference<css::frame::XController>& GetController() const { return mxController; }
  79     const css::lang::Locale& GetLocale() const { return maLocale; }
  80     const OUString& GetApplicationName() const { return maApplicationName; }
  81     const OUString& GetRangeText() const { return maRangeText; }
  82 };
  83
  84 #endif // INCLUDED_SVX_SMARTTAGITEM_HXX
  85
  86
  87 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */