office-gobmx/sw/inc/fmturl.hxx
Abdulmajeed Al-Abaulrazzaq 4ed62ddb01 Modifying comments to meet doxygen standards
Change-Id: I363ce532c7d11e798c2a5cc67b1b7893dcd0a389
Reviewed-on: https://gerrit.libreoffice.org/596
Reviewed-by: Michael Stahl <mstahl@redhat.com>
Tested-by: Michael Stahl <mstahl@redhat.com>
2012-09-11 17:54:21 +00:00

94 lines
3.5 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef _FMTURL_HXX
#define _FMTURL_HXX
#include <svl/poolitem.hxx>
#include "swdllapi.h"
#include <hintids.hxx>
#include <format.hxx>
class ImageMap;
class IntlWrapper;
// URL, ServerMap und ClientMap
class SW_DLLPUBLIC SwFmtURL: public SfxPoolItem
{
String sTargetFrameName; ///< Target frame for URL.
String sURL; ///< Simple URL.
String sName; ///< Name of the anchor.
ImageMap *pMap; ///< ClientSide images.
sal_Bool bIsServerMap; ///< A ServerSideImageMap with the URL.
SwFmtURL& operator=( const SwFmtURL& );
public:
SwFmtURL();
/// @@@ copy construction allowed, but assigment is not? @@@
SwFmtURL( const SwFmtURL& );
virtual ~SwFmtURL();
/// "Pure virtual methods" of SfxPoolItem.
virtual int operator==( const SfxPoolItem& ) const;
virtual SfxPoolItem* Clone( SfxItemPool* pPool = 0 ) const;
virtual SfxItemPresentation GetPresentation( SfxItemPresentation ePres,
SfxMapUnit eCoreMetric,
SfxMapUnit ePresMetric,
String &rText,
const IntlWrapper* pIntl = 0 ) const;
virtual bool QueryValue( com::sun::star::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const;
virtual bool PutValue( const com::sun::star::uno::Any& rVal, sal_uInt8 nMemberId = 0 );
void SetTargetFrameName( const String& rStr ) { sTargetFrameName = rStr; }
void SetURL( const String &rURL, sal_Bool bServerMap );
void SetMap( const ImageMap *pM ); ///< Pointer will be copied.
const String &GetTargetFrameName()const { return sTargetFrameName; }
const String &GetURL() const { return sURL; }
sal_Bool IsServerMap() const { return bIsServerMap; }
const ImageMap *GetMap() const { return pMap; }
ImageMap *GetMap() { return pMap; }
const String& GetName() const { return sName; }
void SetName( const String& rNm ) { sName = rNm; }
};
inline const SwFmtURL &SwAttrSet::GetURL(sal_Bool bInP) const
{ return (const SwFmtURL&)Get( RES_URL,bInP); }
inline const SwFmtURL &SwFmt::GetURL(sal_Bool bInP) const
{ return aSet.GetURL(bInP); }
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */