include/editeng/paravertalignitem.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_PARAVERTALIGNITEM_HXX
  20 #define INCLUDED_EDITENG_PARAVERTALIGNITEM_HXX
  21
  22 #include <svl/intitem.hxx>
  23 #include <editeng/editengdllapi.h>
  24
  25 // class SvxParaVertAlignItem ----------------------------------------------
  26
  27 /* [Description]
  28
  29     This item defines the character alignment in the lines of a paragraph.
  30      Currently the alignment can be none (i.e. baseline), top, center or bottom.
  31
  32 */
  33
  34 class EDITENG_DLLPUBLIC SvxParaVertAlignItem : public SfxUInt16Item
  35 {
  36 public:
  37     enum class Align { Automatic, Baseline, Top, Center, Bottom };
  38     static SfxPoolItem* CreateDefault();
  39
  40     SvxParaVertAlignItem( Align nValue /*= 0*/,
  41                        const sal_uInt16 nId  );
  42
  43     virtual SfxPoolItem*    Clone( SfxItemPool *pPool = nullptr ) const override;
  44     virtual SfxPoolItem*    Create(SvStream &, sal_uInt16) const override;
  45     virtual SvStream&       Store(SvStream & rStrm, sal_uInt16 nIVer) const override;
  46     virtual sal_uInt16          GetVersion( sal_uInt16 nFileVersion ) const override;
  47
  48     virtual bool GetPresentation( SfxItemPresentation ePres,
  49                                   MapUnit eCoreMetric,
  50                                   MapUnit ePresMetric,
  51                                   OUString &rText,
  52                                   const IntlWrapper * = nullptr ) const override;
  53
  54     virtual bool            QueryValue( css::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const override;
  55     virtual bool            PutValue( const css::uno::Any& rVal, sal_uInt8 nMemberId ) override;
  56
  57     Align                   GetValue() const { return (Align) SfxUInt16Item::GetValue(); }
  58     void                    SetValue(Align n) { SfxUInt16Item::SetValue((sal_uInt16)n); }
  59
  60     SvxParaVertAlignItem& operator=( const SvxParaVertAlignItem& rItem )
  61     {
  62         SetValue( rItem.GetValue() );
  63         return *this;
  64     }
  65
  66     virtual bool            operator==( const SfxPoolItem& ) const override;
  67
  68 };
  69
  70 #endif
  71
  72 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */