/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the Collabora Office 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_SVX_HLNKITEM_HXX
#define INCLUDED_SVX_HLNKITEM_HXX

#include <rtl/ustring.hxx>
#include <svl/poolitem.hxx>
#include <sfx2/sfxsids.hrc>
#include <svl/macitem.hxx>
#include <svx/svxdllapi.h>
#include <o3tl/typed_flags_set.hxx>
#include <memory>

enum class HyperDialogEvent {
    NONE                = 0x0000,
    MouseOverObject     = 0x0001,
    MouseClickObject    = 0x0002,
    MouseOutObject      = 0x0004,
};
namespace o3tl {
    template<> struct typed_flags<HyperDialogEvent> : is_typed_flags<HyperDialogEvent, 0x07> {};
}

enum SvxLinkInsertMode
{
    HLINK_DEFAULT,
    HLINK_FIELD,
    HLINK_BUTTON,
    HLINK_HTMLMODE = 0x0080
};

class SVX_DLLPUBLIC SvxHyperlinkItem final : public SfxPoolItem
{
    OUString m_sName;
    OUString m_sURL;
    OUString m_sTarget;
    SvxLinkInsertMode m_eType;
    OUString m_sReplacementText;

    bool m_showName = true;
    bool m_showText = true;

    OUString m_sIntName;
    std::unique_ptr<SvxMacroTableDtor>  m_pMacroTable;

    HyperDialogEvent m_nMacroEvents;

    /// When turning selected text into a hyperlink, ignore m_sName, it's only a hint.
    bool m_bTextIsHint = false;

public:
    static SfxPoolItem* CreateDefault();

    DECLARE_ITEM_TYPE_FUNCTION(SvxHyperlinkItem)
    SvxHyperlinkItem( TypedWhichId<SvxHyperlinkItem> _nWhich = SID_HYPERLINK_GETLINK ):
                SfxPoolItem(_nWhich )
    { m_eType = HLINK_DEFAULT; m_nMacroEvents=HyperDialogEvent::NONE; };
    SvxHyperlinkItem( const SvxHyperlinkItem& rHyperlinkItem );
    SvxHyperlinkItem( TypedWhichId<SvxHyperlinkItem> nWhich, OUString aName, OUString aURL,
                                    OUString aTarget, OUString aIntName,
                                    SvxLinkInsertMode eTyp,
                                    HyperDialogEvent nEvents,
                                    SvxMacroTableDtor const *pMacroTbl,
                                    bool showName = true, bool showText = true,
                                    OUString aReplacementText = OUString(),
                                    bool bTextIsHint = false);

    virtual bool             operator==( const SfxPoolItem& ) const override;
    virtual SvxHyperlinkItem* Clone( SfxItemPool *pPool = nullptr ) const override;
    virtual bool             QueryValue( cpo::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const override;
    virtual bool             PutValue( const cpo::uno::Any& rVal, sal_uInt8 nMemberId ) override;

    const   OUString& GetName() const { return m_sName; }
    void    SetName(const OUString& rName) { m_sName = rName; }

    const   OUString& GetURL() const { return m_sURL; }
    void    SetURL(const OUString& rURL) { m_sURL = rURL; }

    const   OUString& GetIntName () const { return m_sIntName; }
    void    SetIntName(const OUString& rIntName) { m_sIntName = rIntName; }

    const   OUString& GetTargetFrame() const { return m_sTarget; }
    void    SetTargetFrame(const OUString& rTarget) { m_sTarget = rTarget; }

    bool GetShowName() const { return m_showName; }
    void    SetShowName(const bool show) { m_showName = show; }

    bool GetShowText() const { return m_showText; }
    void    SetShowText(const bool show) { m_showText = show; }

    SvxLinkInsertMode GetInsertMode() const { return m_eType; }
    void    SetInsertMode( SvxLinkInsertMode eNew ) { m_eType = eNew; }

    void SetMacro( HyperDialogEvent nEvent, const SvxMacro& rMacro );

    void SetMacroTable( const SvxMacroTableDtor& rTbl );
    const SvxMacroTableDtor* GetMacroTable() const { return m_pMacroTable.get(); }

    void SetMacroEvents (const HyperDialogEvent nEvents) { m_nMacroEvents = nEvents; }
    HyperDialogEvent GetMacroEvents() const { return m_nMacroEvents; }

    const OUString& GetReplacementText() const { return m_sReplacementText; }
    void    SetReplacementText(const OUString& rReplacementText) { m_sReplacementText = rReplacementText; }

    void SetTextIsHint(bool bTextIsHint) { m_bTextIsHint = bTextIsHint; }
    bool GetTextIsHint() const { return m_bTextIsHint; }

};

#endif


/* vim:set shiftwidth=4 softtabstop=4 expandtab: */