include/editeng/keepitem.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_KEEPITEM_HXX
  20 #define INCLUDED_EDITENG_KEEPITEM_HXX
  21
  22 #include <svl/eitem.hxx>
  23 #include <editeng/editengdllapi.h>
  24
  25
  26 // class SvxFormatKeepItem ------------------------------------------------
  27
  28 /*  [Description]
  29
  30     This item describes a logical variable "keep paragraphs together?".
  31 */
  32
  33 class EDITENG_DLLPUBLIC SvxFormatKeepItem final : public SfxBoolItem
  34 {
  35 public:
  36     static SfxPoolItem* CreateDefault();
  37
  38     inline SvxFormatKeepItem( const bool bKeep /*= false*/,
  39                            const sal_uInt16 _nWhich  );
  40     SvxFormatKeepItem(SvxFormatKeepItem const &) = default; // SfxPoolItem copy function dichotomy
  41
  42     // "pure virtual Methods" from SfxPoolItem
  43     virtual SvxFormatKeepItem* Clone( SfxItemPool *pPool = nullptr ) const override;
  44
  45     virtual bool GetPresentation( SfxItemPresentation ePres,
  46                                   MapUnit eCoreMetric,
  47                                   MapUnit ePresMetric,
  48                                   OUString &rText, const IntlWrapper& ) const override;
  49
  50     void dumpAsXml(xmlTextWriterPtr pWriter) const override;
  51 };
  52
  53 inline SvxFormatKeepItem::SvxFormatKeepItem( const bool bKeep, const sal_uInt16 _nWhich ) :
  54     SfxBoolItem( _nWhich, bKeep )
  55 {}
  56
  57 #endif
  58
  59 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */