include/editeng/formatbreakitem.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef INCLUDED_EDITENG_FORMATBREAKITEM_HXX
  20 #define INCLUDED_EDITENG_FORMATBREAKITEM_HXX
  21
  22 #include <svl/eitem.hxx>
  23 #include <editeng/svxenum.hxx>
  24 #include <editeng/editengdllapi.h>
  25
  26
  27 // class SvxFormatBreakItem -------------------------------------------------
  28
  29 /*  [Description]
  30
  31     This item describes a wrap-attribute
  32     Automatic?, Page or column break, before or after?
  33 */
  34 constexpr sal_uInt16 FMTBREAK_NOAUTO = 0x0001;
  35
  36 class EDITENG_DLLPUBLIC SvxFormatBreakItem final : public SfxEnumItem<SvxBreak>
  37 {
  38 public:
  39     static SfxPoolItem* CreateDefault();
  40
  41     inline SvxFormatBreakItem( const SvxBreak eBrk /*= SvxBreak::NONE*/,
  42                             const sal_uInt16 nWhich );
  43     SvxFormatBreakItem(SvxFormatBreakItem const &) = default; // SfxPoolItem copy function dichotomy
  44
  45     // "pure virtual Methods" from SfxPoolItem
  46     virtual bool            operator==( const SfxPoolItem& ) const override;
  47     virtual bool            QueryValue( css::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const override;
  48     virtual bool            PutValue( const css::uno::Any& rVal, sal_uInt8 nMemberId ) override;
  49
  50     virtual bool GetPresentation( SfxItemPresentation ePres,
  51                                   MapUnit eCoreMetric,
  52                                   MapUnit ePresMetric,
  53                                   OUString &rText, const IntlWrapper& ) const override;
  54     static OUString          GetValueTextByPos( sal_uInt16 nPos );
  55
  56     virtual SvxFormatBreakItem* Clone( SfxItemPool *pPool = nullptr ) const override;
  57     virtual sal_uInt16       GetValueCount() const override;
  58
  59     SvxBreak                 GetBreak() const { return GetValue(); }
  60 };
  61
  62
  63 inline SvxFormatBreakItem::SvxFormatBreakItem( const SvxBreak eBreak,
  64                                          const sal_uInt16 _nWhich ) :
  65     SfxEnumItem( _nWhich, eBreak )
  66 {}
  67
  68
  69 #endif
  70
  71 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */