SfxPoolItem subclass that wraps a URL. More...

#include <fmturl.hxx>

Inheritance diagram for SwFormatURL:

Collaboration diagram for SwFormatURL:

Public Member Functions
	SwFormatURL ()

	SwFormatURL (const SwFormatURL &)

virtual	~SwFormatURL () override

virtual bool	operator== (const SfxPoolItem &) const override
	"Pure virtual methods" of SfxPoolItem. More...

virtual SwFormatURL *	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

void	SetTargetFrameName (const OUString &rStr)

void	SetURL (const OUString &rURL, bool bServerMap)

void	SetMap (const ImageMap *pM)
	Pointer will be copied. More...

const OUString &	GetTargetFrameName () const

const OUString &	GetURL () const

bool	IsServerMap () const

const ImageMap *	GetMap () const

ImageMap *	GetMap ()

const OUString &	GetName () const

void	SetName (const OUString &rNm)

Public Member Functions inherited from SfxPoolItem
void	AddRef (sal_uInt32 n=1) const

virtual	~SfxPoolItem ()

void	SetWhich (sal_uInt16 nId)

sal_uInt16	Which () const

T &	StaticWhichCast (TypedWhichId< T > nId)

const T &	StaticWhichCast (TypedWhichId< T > nId) const

T *	DynamicWhichCast (TypedWhichId< T > nId)

const T *	DynamicWhichCast (TypedWhichId< T > nId) const

virtual bool	operator== (const SfxPoolItem &) const=0

bool	operator!= (const SfxPoolItem &rItem) const

virtual bool	operator< (const SfxPoolItem &) const

virtual bool	IsSortable () const

virtual bool	HasLookup () const

virtual lookup_iterator	Lookup (lookup_iterator, lookup_iterator end) const

virtual bool	GetPresentation (SfxItemPresentation ePresentation, MapUnit eCoreMetric, MapUnit ePresentationMetric, OUString &rText, const IntlWrapper &rIntlWrapper) const

virtual void	ScaleMetrics (tools::Long lMult, tools::Long lDiv)

virtual bool	HasMetrics () const

virtual bool	QueryValue (css::uno::Any &rVal, sal_uInt8 nMemberId=0) const

virtual bool	PutValue (const css::uno::Any &rVal, sal_uInt8 nMemberId)

virtual SfxPoolItem *	Clone (SfxItemPool *pPool=nullptr) const=0

std::unique_ptr< SfxPoolItem >	CloneSetWhich (sal_uInt16 nNewWhich) const

std::unique_ptr< T >	CloneSetWhich (TypedWhichId< T > nId) const

sal_uInt32	GetRefCount () const

SfxItemKind	GetKind () const

virtual void	dumpAsXml (xmlTextWriterPtr pWriter) const

virtual boost::property_tree::ptree	dumpAsJSON () const

virtual bool	IsVoidItem () const

Private Attributes
OUString	m_sTargetFrameName
	Target frame for URL. More...

OUString	m_sURL
	Simple URL. More...

OUString	m_sName
	Name of the anchor. More...

std::unique_ptr< ImageMap >	m_pMap
	ClientSide images. More...

bool	m_bIsServerMap
	A ServerSideImageMap with the URL. More...

Additional Inherited Members
Public Types inherited from SfxPoolItem
typedef std::vector< SfxPoolItem * >::const_iterator	lookup_iterator

Protected Member Functions inherited from SfxPoolItem
	SfxPoolItem (sal_uInt16 nWhich=0)

	SfxPoolItem (const SfxPoolItem &rCopy)

Detailed Description

SfxPoolItem subclass that wraps a URL.

Definition at line 32 of file fmturl.hxx.

Constructor & Destructor Documentation

◆ SwFormatURL() [1/2]

SwFormatURL::SwFormatURL ( )

Definition at line 1830 of file atrfrm.cxx.

Referenced by Clone().

◆ SwFormatURL() [2/2]

SwFormatURL::SwFormatURL ( const SwFormatURL & rURL )

Definition at line 1836 of file atrfrm.cxx.

References GetMap(), GetName(), GetURL(), m_pMap, m_sName, and m_sURL.

◆ ~SwFormatURL()

SwFormatURL::~SwFormatURL ( )

overridevirtual

Definition at line 1847 of file atrfrm.cxx.

Member Function Documentation

◆ Clone()

SwFormatURL * SwFormatURL::Clone ( SfxItemPool * pPool = nullptr ) const

overridevirtual

Implements SfxPoolItem.

Definition at line 1869 of file atrfrm.cxx.

References SwFormatURL().

Referenced by SwFrameURLPage::FillItemSet().

◆ GetMap() [1/2]

ImageMap * SwFormatURL::GetMap ( )

inline

Definition at line 68 of file fmturl.hxx.

◆ GetMap() [2/2]

const ImageMap * SwFormatURL::GetMap ( ) const

inline

Definition at line 67 of file fmturl.hxx.

Referenced by SwVirtFlyDrawObj::CheckMacroHit(), SwTransferable::GetData(), SwEditWin::GetDropDestination(), SwFrameFormat::GetIMapObject(), SwTransferable::GetSotDestination(), SwVirtFlyDrawObj::HasMacro(), SwFEShell::IsURLGrfAtPos(), lcl_PaintReplacement(), lcl_UpdateIMapDlg(), operator==(), SwTransferable::PrepareForCopy(), SwDPage::RequestHelp(), SwCursorShell::SelectNxtPrvHyperlink(), SwTransferable::SetDataForDragAndDrop(), and SwFormatURL().

◆ GetName()

const OUString & SwFormatURL::GetName ( ) const

inline

Definition at line 70 of file fmturl.hxx.

References m_sName.

Referenced by operator==(), OutHTML_ImageStart(), SwTransferable::PasteAsHyperlink(), SwTransferable::PasteFileName(), SwBasicEscherEx::PreWriteHyperlinkWithinFly(), and QueryValue().

◆ GetPresentation()

bool SwFormatURL::GetPresentation	(	SfxItemPresentation	ePres,
		MapUnit	eCoreMetric,
		MapUnit	ePresMetric,
		OUString &	rText,
		const IntlWrapper &	rIntl
	)		const

overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 502 of file attrdesc.cxx.

References m_bIsServerMap, m_pMap, m_sTargetFrameName, and m_sURL.

◆ GetTargetFrameName()

const OUString & SwFormatURL::GetTargetFrameName ( ) const

inline

Definition at line 64 of file fmturl.hxx.

Referenced by SwTransferable::GetData(), SwFEShell::IsURLGrfAtPos(), operator==(), WW8Export::OutGrf(), OutHTML_ImageStart(), SwTransferable::PrepareForCopy(), QueryValue(), SwTransferable::SetDataForDragAndDrop(), and SwBasicEscherEx::WriteHyperlinkWithinFly().

◆ GetURL()

const OUString & SwFormatURL::GetURL ( ) const

inline

Definition at line 65 of file fmturl.hxx.

References m_sURL.

Referenced by SwVirtFlyDrawObj::CheckMacroHit(), SwEnhancedPDFExportHelper::EnhancedPDFExport(), SwTransferable::GetData(), SwVirtFlyDrawObj::HasMacro(), SwFEShell::IsURLGrfAtPos(), lcl_PaintReplacement(), operator==(), WW8Export::OutGrf(), OutHTML_ImageStart(), SwTransferable::PrepareForCopy(), SwBasicEscherEx::PreWriteHyperlinkWithinFly(), QueryValue(), SwDPage::RequestHelp(), SwCursorShell::SelectNxtPrvHyperlink(), SwTransferable::SetDataForDragAndDrop(), and SwBasicEscherEx::WriteHyperlinkWithinFly().

◆ IsServerMap()

bool SwFormatURL::IsServerMap ( ) const

inline

Definition at line 66 of file fmturl.hxx.

Referenced by SwFEShell::IsURLGrfAtPos(), operator==(), OutHTML_ImageStart(), QueryValue(), and SwDPage::RequestHelp().

◆ operator==()

bool SwFormatURL::operator== ( const SfxPoolItem & rAttr ) const

overridevirtual

"Pure virtual methods" of SfxPoolItem.

Implements SfxPoolItem.

Definition at line 1851 of file atrfrm.cxx.

References GetMap(), GetName(), GetTargetFrameName(), GetURL(), IsServerMap(), m_bIsServerMap, m_pMap, m_sName, m_sTargetFrameName, and m_sURL.

◆ PutValue()

bool SwFormatURL::PutValue	(	const css::uno::Any &	rVal,
		sal_uInt8	nMemberId
	)

overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 1927 of file atrfrm.cxx.

References uno::Any::hasValue(), m_bIsServerMap, m_pMap, MID_URL_CLIENTMAP, MID_URL_HYPERLINKNAME, MID_URL_SERVERMAP, MID_URL_TARGET, MID_URL_URL, SetName(), SetTargetFrameName(), SetURL(), and SvUnoImageMap_fillImageMap().

◆ QueryValue()

bool SwFormatURL::QueryValue	(	css::uno::Any &	rVal,
		sal_uInt8	nMemberId = `0`
	)		const

overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 1885 of file atrfrm.cxx.

References GetName(), GetTargetFrameName(), GetURL(), IsServerMap(), m_pMap, MID_URL_CLIENTMAP, MID_URL_HYPERLINKNAME, MID_URL_SERVERMAP, MID_URL_TARGET, MID_URL_URL, SvUnoImageMap_createInstance(), and sw_GetSupportedMacroItems().

◆ SetMap()

void SwFormatURL::SetMap ( const ImageMap * pM )

Pointer will be copied.

Definition at line 1880 of file atrfrm.cxx.

References m_pMap.

◆ SetName()

void SwFormatURL::SetName ( const OUString & rNm )

inline

Definition at line 71 of file fmturl.hxx.

References m_sName.

Referenced by SwTransferable::PasteAsHyperlink(), SwTransferable::PasteFileName(), and PutValue().

◆ SetTargetFrameName()

void SwFormatURL::SetTargetFrameName ( const OUString & rStr )

inline

Definition at line 60 of file fmturl.hxx.

Referenced by PutValue().

◆ SetURL()

void SwFormatURL::SetURL	(	const OUString &	rURL,
		bool	bServerMap
	)

Definition at line 1874 of file atrfrm.cxx.

References m_bIsServerMap, and m_sURL.

Referenced by SwTransferable::PasteAsHyperlink(), SwTransferable::PasteFileName(), and PutValue().

Member Data Documentation

◆ m_bIsServerMap

bool SwFormatURL::m_bIsServerMap

private

A ServerSideImageMap with the URL.

Definition at line 40 of file fmturl.hxx.

Referenced by GetPresentation(), operator==(), PutValue(), and SetURL().

◆ m_pMap

std::unique_ptr<ImageMap> SwFormatURL::m_pMap

private

ClientSide images.

Definition at line 38 of file fmturl.hxx.

Referenced by GetPresentation(), operator==(), PutValue(), QueryValue(), SetMap(), and SwFormatURL().

◆ m_sName

OUString SwFormatURL::m_sName

private

Name of the anchor.

Definition at line 36 of file fmturl.hxx.

Referenced by operator==().

◆ m_sTargetFrameName

OUString SwFormatURL::m_sTargetFrameName

private

Target frame for URL.

Definition at line 34 of file fmturl.hxx.

Referenced by GetPresentation(), and operator==().

◆ m_sURL

OUString SwFormatURL::m_sURL

private

Simple URL.

Definition at line 35 of file fmturl.hxx.

Referenced by GetPresentation(), operator==(), and SetURL().

The documentation for this class was generated from the following files:

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SwFormatURL() [1/2]

◆ SwFormatURL() [2/2]

◆ ~SwFormatURL()

Member Function Documentation

◆ Clone()

◆ GetMap() [1/2]

◆ GetMap() [2/2]

◆ GetName()

◆ GetPresentation()

◆ GetTargetFrameName()

◆ GetURL()

◆ IsServerMap()

◆ operator==()

◆ PutValue()

◆ QueryValue()

◆ SetMap()

◆ SetName()

◆ SetTargetFrameName()

◆ SetURL()

Member Data Documentation

◆ m_bIsServerMap

◆ m_pMap

◆ m_sName

◆ m_sTargetFrameName

◆ m_sURL