include/editeng/hyphenzoneitem.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_HYPHENZONEITEM_HXX
  20 #define INCLUDED_EDITENG_HYPHENZONEITEM_HXX
  21
  22 #include <svl/poolitem.hxx>
  23 #include <editeng/editengdllapi.h>
  24
  25 // class SvxHyphenZoneItem -----------------------------------------------
  26
  27 /*  [Description]
  28
  29     This item describes a hyphenation attribute  (automatic?, number of
  30     characters at the end of the line and start).
  31 */
  32
  33 class EDITENG_DLLPUBLIC SvxHyphenZoneItem final : public SfxPoolItem
  34 {
  35     bool      bHyphen  : 1;
  36     bool      bPageEnd : 1;
  37     bool      bNoCapsHyphenation : 1;
  38     bool      bNoLastWordHyphenation : 1;
  39     sal_uInt8 nMinLead;
  40     sal_uInt8 nMinTrail;
  41     sal_uInt8 nMaxHyphens;      // max. consecutive lines with hyphenation
  42     sal_uInt8 nMinWordLength;   // hyphenate only words with at least nMinWordLength characters
  43     sal_uInt16 nTextHyphenZone; // don't force hyphenation at line end, allow this extra white space
  44
  45 public:
  46     static SfxPoolItem* CreateDefault();
  47
  48     SvxHyphenZoneItem( const bool bHyph /*= false*/,
  49                        const sal_uInt16 nId  );
  50
  51     // "pure virtual Methods" from SfxPoolItem
  52     virtual bool            operator==( const SfxPoolItem& ) const override;
  53     virtual bool            QueryValue( css::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const override;
  54     virtual bool            PutValue( const css::uno::Any& rVal, sal_uInt8 nMemberId ) override;
  55
  56     virtual bool GetPresentation( SfxItemPresentation ePres,
  57                                   MapUnit eCoreMetric,
  58                                   MapUnit ePresMetric,
  59                                   OUString &rText, const IntlWrapper& ) const override;
  60
  61     virtual SvxHyphenZoneItem* Clone( SfxItemPool *pPool = nullptr ) const override;
  62
  63     void SetHyphen( const bool bNew ) { bHyphen = bNew; }
  64     bool IsHyphen() const { return bHyphen; }
  65
  66     void SetPageEnd( const bool bNew ) { bPageEnd = bNew; }
  67     bool IsPageEnd() const { return bPageEnd; }
  68
  69     void SetNoCapsHyphenation( const bool bNew ) { bNoCapsHyphenation = bNew; }
  70     bool IsNoCapsHyphenation() const { return bNoCapsHyphenation; }
  71     void SetNoLastWordHyphenation( const bool bNew ) { bNoLastWordHyphenation = bNew; }
  72     bool IsNoLastWordHyphenation() const { return bNoLastWordHyphenation; }
  73
  74     sal_uInt8 &GetMinLead() { return nMinLead; }
  75     sal_uInt8 GetMinLead() const { return nMinLead; }
  76
  77     sal_uInt8 &GetMinTrail() { return nMinTrail; }
  78     sal_uInt8 GetMinTrail() const { return nMinTrail; }
  79
  80     sal_uInt8 &GetMaxHyphens() { return nMaxHyphens; }
  81     sal_uInt8 GetMaxHyphens() const { return nMaxHyphens; }
  82
  83     sal_uInt8 &GetMinWordLength() { return nMinWordLength; }
  84     sal_uInt8 GetMinWordLength() const { return nMinWordLength; }
  85
  86     sal_uInt16 &GetTextHyphenZone() { return nTextHyphenZone; }
  87     sal_uInt16 GetTextHyphenZone() const { return nTextHyphenZone; }
  88 };
  89
  90 #endif
  91
  92 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */