/* -*- 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_SW_INC_FMTINFMT_HXX
#define INCLUDED_SW_INC_FMTINFMT_HXX
#include <svl/poolitem.hxx>
#include "swdllapi.h"
#include <memory>
#include "calbck.hxx"
#include "names.hxx"
class SvxMacro;
class SvxMacroTableDtor;
class SwTextINetFormat;
enum class SvMacroItemId : sal_uInt16;
/// SfxPoolItem subclass that contains data about an inserted hyperlink / URL in Writer text. Its
/// location is tracked by the wrapping SwTextINetFormat.
class SW_DLLPUBLIC SwFormatINetFormat final
:
public SfxPoolItem
,
public sw::BroadcasterMixin
{
friend class SwTextINetFormat;
OUString msURL;
///< URL.
OUString msTargetFrame;
///< Target frame for URL.
UIName msINetFormatName;
UIName msVisitedFormatName;
OUString msHyperlinkName;
///< Name of the link.
std::unique_ptr<SvxMacroTableDtor> mpMacroTable;
SwTextINetFormat* mpTextAttr;
///< My TextAttribute.
sal_uInt16 mnINetFormatId;
sal_uInt16 mnVisitedFormatId;
public:
DECLARE_ITEM_TYPE_FUNCTION(SwFormatINetFormat)
SwFormatINetFormat( OUString aURL, OUString aTarget );
SwFormatINetFormat(
const SwFormatINetFormat& rAttr );
SwFormatINetFormat();
///< For TypeInfo.
virtual ~SwFormatINetFormat() override;
static SfxPoolItem* CreateDefault();
/// "Pure virtual methods" of SfxPoolItem.
virtual bool operator==(
const SfxPoolItem& )
const override;
virtual SwFormatINetFormat* Clone( SfxItemPool* pPool = nullptr )
const override;
virtual bool GetPresentation( SfxItemPresentation ePres,
MapUnit eCoreMetric,
MapUnit ePresMetric,
OUString &rText,
const IntlWrapper& rIntl )
const override;
virtual bool QueryValue( css::uno::Any& rVal, sal_uInt8 nMemberId = 0 )
const override;
virtual bool PutValue(
const css::uno::Any& rVal, sal_uInt8 nMemberId ) override;
const SwTextINetFormat* GetTextINetFormat()
const
{
return mpTextAttr;
}
const OUString& GetValue()
const
{
return msURL;
}
const OUString& GetName()
const
{
return msHyperlinkName;
}
void SetName(
const OUString& rNm )
{
msHyperlinkName = rNm;
}
const OUString& GetTargetFrame()
const
{
return msTargetFrame;
}
void SetINetFormatAndId(
const UIName& rNm,
const sal_uInt16 nId )
{
msINetFormatName = rNm;
mnINetFormatId = nId;
}
const UIName& GetINetFormat()
const
{
return msINetFormatName;
}
sal_uInt16 GetINetFormatId()
const
{
return mnINetFormatId;
}
void SetVisitedFormatAndId(
const UIName& rNm,
const sal_uInt16 nId )
{
msVisitedFormatName = rNm;
mnVisitedFormatId = nId;
}
const UIName& GetVisitedFormat()
const
{
return msVisitedFormatName;
}
sal_uInt16 GetVisitedFormatId()
const
{
return mnVisitedFormatId;
}
/// Set a new MacroTable or clear the current one.
void SetMacroTable(
const SvxMacroTableDtor* pTable );
const SvxMacroTableDtor* GetMacroTable()
const
{
return mpMacroTable.get();
}
/// Macro getter and setter.
void SetMacro( SvMacroItemId nEvent,
const SvxMacro& rMacro );
const SvxMacro* GetMacro( SvMacroItemId nEvent )
const;
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
