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_HLNKITEM_HXX
20 #define INCLUDED_SVX_HLNKITEM_HXX
21 
22 #include <rtl/ustring.hxx>
23 #include <svl/poolitem.hxx>
24 #include <sfx2/sfxsids.hrc>
25 #include <svl/macitem.hxx>
26 #include <svx/svxdllapi.h>
27 #include <o3tl/typed_flags_set.hxx>
28 #include <memory>
29 
30 enum class HyperDialogEvent {
31     NONE                = 0x0000,
32     MouseOverObject     = 0x0001,
33     MouseClickObject    = 0x0002,
34     MouseOutObject      = 0x0004,
35 };
36 namespace o3tl {
37     template<> struct typed_flags<HyperDialogEvent> : is_typed_flags<HyperDialogEvent, 0x07> {};
38 }
39 
40 enum SvxLinkInsertMode
41 {
42     HLINK_DEFAULT,
43     HLINK_FIELD,
44     HLINK_BUTTON,
45     HLINK_HTMLMODE = 0x0080
46 };
47 
48 class SVX_DLLPUBLIC SvxHyperlinkItem : public SfxPoolItem
49 {
50     OUString sName;
51     OUString sURL;
52     OUString sTarget;
53     SvxLinkInsertMode eType;
54 
55     OUString sIntName;
56     std::unique_ptr<SvxMacroTableDtor>  pMacroTable;
57 
58     HyperDialogEvent nMacroEvents;
59 
60 public:
61     static SfxPoolItem* CreateDefault();
62 
SvxHyperlinkItem(sal_uInt16 _nWhich=SID_HYPERLINK_GETLINK)63     SvxHyperlinkItem( sal_uInt16 _nWhich = SID_HYPERLINK_GETLINK ):
64                 SfxPoolItem(_nWhich) { eType = HLINK_DEFAULT; nMacroEvents=HyperDialogEvent::NONE; };
65     SvxHyperlinkItem( const SvxHyperlinkItem& rHyperlinkItem );
66     SvxHyperlinkItem( sal_uInt16 nWhich, const OUString& rName, const OUString& rURL,
67                                     const OUString& rTarget, const OUString& rIntName,
68                                     SvxLinkInsertMode eTyp,
69                                     HyperDialogEvent nEvents,
70                                     SvxMacroTableDtor const *pMacroTbl );
71 
72     virtual bool             operator==( const SfxPoolItem& ) const override;
73     virtual SfxPoolItem*     Clone( SfxItemPool *pPool = nullptr ) const override;
74     virtual bool             QueryValue( css::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const override;
75     virtual bool             PutValue( const css::uno::Any& rVal, sal_uInt8 nMemberId ) override;
76 
GetName() const77     const   OUString& GetName() const { return sName; }
SetName(const OUString & rName)78     void    SetName(const OUString& rName) { sName = rName; }
79 
GetURL() const80     const   OUString& GetURL() const { return sURL; }
SetURL(const OUString & rURL)81     void    SetURL(const OUString& rURL) { sURL = rURL; }
82 
GetIntName() const83     const   OUString& GetIntName () const { return sIntName; }
SetIntName(const OUString & rIntName)84     void    SetIntName(const OUString& rIntName) { sIntName = rIntName; }
85 
GetTargetFrame() const86     const   OUString& GetTargetFrame() const { return sTarget; }
SetTargetFrame(const OUString & rTarget)87     void    SetTargetFrame(const OUString& rTarget) { sTarget = rTarget; }
88 
GetInsertMode() const89     SvxLinkInsertMode GetInsertMode() const { return eType; }
SetInsertMode(SvxLinkInsertMode eNew)90     void    SetInsertMode( SvxLinkInsertMode eNew ) { eType = eNew; }
91 
92     void SetMacro( HyperDialogEvent nEvent, const SvxMacro& rMacro );
93 
94     void SetMacroTable( const SvxMacroTableDtor& rTbl );
GetMacroTable() const95     const SvxMacroTableDtor* GetMacroTable() const { return pMacroTable.get(); }
96 
SetMacroEvents(const HyperDialogEvent nEvents)97     void SetMacroEvents (const HyperDialogEvent nEvents) { nMacroEvents = nEvents; }
GetMacroEvents() const98     HyperDialogEvent GetMacroEvents() const { return nMacroEvents; }
99 
100 };
101 
102 #endif
103 
104 
105 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
106