include/editeng/orphitem.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_ORPHITEM_HXX
  20 #define INCLUDED_EDITENG_ORPHITEM_HXX
  21
  22 #include <svl/intitem.hxx>
  23 #include <editeng/editengdllapi.h>
  24
  25 /// An orphan line is a paragraph-starting line that is still on the previous page or column (has
  26 /// future, but no past).
  27 ///
  28 /// nL specifies the minimum number of lines, to prevent orphans.
  29 class EDITENG_DLLPUBLIC SvxOrphansItem final : public SfxByteItem
  30 {
  31 public:
  32     static SfxPoolItem* CreateDefault();
  33
  34     SvxOrphansItem( const sal_uInt8 nL /*= 0*/, const sal_uInt16 nId  );
  35
  36     // "pure virtual Methods" from SfxPoolItem
  37     virtual SvxOrphansItem* Clone( SfxItemPool *pPool = nullptr ) const override;
  38
  39     virtual bool GetPresentation( SfxItemPresentation ePres,
  40                                   MapUnit eCoreMetric,
  41                                   MapUnit ePresMetric,
  42                                   OUString &rText, const IntlWrapper& ) const override;
  43 };
  44
  45 #endif
  46
  47 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */