xref: /core/include/svx/SmartTagItem.hxx (revision 85f49387)
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::sun::star::container {
29     class XStringKeyMap;
30 }
31 
32 namespace com::sun::star::text {
33     class XTextRange;
34 }
35 
36 namespace com::sun::star::frame {
37     class XController;
38 }
39 class SVX_DLLPUBLIC SvxSmartTagItem final : public SfxPoolItem
40 {
41     const css::uno::Sequence < css::uno::Sequence< css::uno::Reference< css::smarttags::XSmartTagAction > > > maActionComponentsSequence;
42     const css::uno::Sequence < css::uno::Sequence< sal_Int32 > > maActionIndicesSequence;
43     const css::uno::Sequence< css::uno::Reference< css::container::XStringKeyMap > > maStringKeyMaps;
44     const css::uno::Reference<css::text::XTextRange> mxRange;
45     const css::uno::Reference<css::frame::XController> mxController;
46     const css::lang::Locale maLocale;
47     const OUString maApplicationName;
48     const OUString maRangeText;
49 
50 public:
51     static SfxPoolItem* CreateDefault();
52 
53     SvxSmartTagItem( const TypedWhichId<SvxSmartTagItem> nId,
54                      const css::uno::Sequence < css::uno::Sequence< css::uno::Reference< css::smarttags::XSmartTagAction > > >& rActionComponentsSequence,
55                      const css::uno::Sequence < css::uno::Sequence< sal_Int32 > >& rActionIndicesSequence,
56                      const css::uno::Sequence< css::uno::Reference< css::container::XStringKeyMap > >& rStringKeyMaps,
57                      css::uno::Reference<css::text::XTextRange> xRange,
58                      css::uno::Reference<css::frame::XController> xController,
59                      css::lang::Locale aLocale,
60                      OUString aApplicationName,
61                      OUString aRangeText );
62 
63     // "purely virtual methods" from the SfxPoolItem
64     virtual bool             operator==( const SfxPoolItem& ) const override;
65     virtual SvxSmartTagItem* Clone( SfxItemPool *pPool = nullptr ) const override;
66     virtual bool             QueryValue( css::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const override;
67     virtual bool             PutValue( const css::uno::Any& rVal, sal_uInt8 nMemberId ) override;
68 
GetActionComponentsSequence() const69     const css::uno::Sequence < css::uno::Sequence< css::uno::Reference< css::smarttags::XSmartTagAction > > >& GetActionComponentsSequence() const { return maActionComponentsSequence; }
GetActionIndicesSequence() const70     const css::uno::Sequence < css::uno::Sequence< sal_Int32 > >& GetActionIndicesSequence() const { return maActionIndicesSequence; }
GetStringKeyMaps() const71     const css::uno::Sequence< css::uno::Reference< css::container::XStringKeyMap > >& GetStringKeyMaps() const { return maStringKeyMaps; }
GetTextRange() const72     const css::uno::Reference<css::text::XTextRange>& GetTextRange() const { return mxRange; }
GetController() const73     const css::uno::Reference<css::frame::XController>& GetController() const { return mxController; }
GetLocale() const74     const css::lang::Locale& GetLocale() const { return maLocale; }
GetApplicationName() const75     const OUString& GetApplicationName() const { return maApplicationName; }
GetRangeText() const76     const OUString& GetRangeText() const { return maRangeText; }
77 };
78 
79 #endif // INCLUDED_SVX_SMARTTAGITEM_HXX
80 
81 
82 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
83