office-gobmx/sw/inc/fmtsrnd.hxx
Miklos Vajna 1ab4e9eb63 sw: improve documentation for SwFormatSurround
Mention which item set is expected to contain this and where is the UI.

Change-Id: I63ee57218eb7c4bc9be4430eb90d98bd43739b83
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/157502
Tested-by: Jenkins
Reviewed-by: Miklos Vajna <vmiklos@collabora.com>
2023-10-03 08:17:25 +02:00

73 lines
3.2 KiB
C++

/* -*- 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_FMTSRND_HXX
#define INCLUDED_SW_INC_FMTSRND_HXX
#include "swdllapi.h"
#include <com/sun/star/text/WrapTextMode.hpp>
#include "hintids.hxx"
#include "format.hxx"
#include <svl/eitem.hxx>
class IntlWrapper;
/// Defines the way you want text to wrap around an object. This pool item can appear in a frame
/// styles and in the item set of an sw::SpzFrameFormat. It's Format -> Image -> Properties -> Wrap
/// on the UI.
class SW_DLLPUBLIC SwFormatSurround final : public SfxEnumItem<css::text::WrapTextMode>
{
bool m_bAnchorOnly :1;
bool m_bContour :1;
bool m_bOutside :1;
public:
SwFormatSurround( css::text::WrapTextMode eNew = css::text::WrapTextMode_PARALLEL );
// "Pure virtual Methods" of SfxPoolItem.
virtual bool operator==( const SfxPoolItem& ) const override;
virtual SwFormatSurround* Clone( SfxItemPool* pPool = nullptr ) const override;
virtual sal_uInt16 GetValueCount() 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;
css::text::WrapTextMode GetSurround() const { return GetValue(); }
bool IsAnchorOnly() const { return m_bAnchorOnly; }
bool IsContour() const { return m_bContour; }
bool IsOutside() const { return m_bOutside; }
void SetSurround ( css::text::WrapTextMode eNew ) { SetValue( eNew ); }
void SetAnchorOnly( bool bNew ) { m_bAnchorOnly = bNew; }
void SetContour( bool bNew ) { m_bContour = bNew; }
void SetOutside( bool bNew ) { m_bOutside = bNew; }
void dumpAsXml(xmlTextWriterPtr pWriter) const override;
};
inline const SwFormatSurround &SwAttrSet::GetSurround(bool bInP) const
{ return Get( RES_SURROUND,bInP); }
inline const SwFormatSurround &SwFormat::GetSurround(bool bInP) const
{ return m_aSet.GetSurround(bInP); }
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */