include/editeng/frmdiritem.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_FRMDIRITEM_HXX
  20 #define INCLUDED_EDITENG_FRMDIRITEM_HXX
  21
  22 #include <svl/intitem.hxx>
  23 #include <editeng/frmdir.hxx>
  24 #include <editeng/editengdllapi.h>
  25
  26 // class SvxFrameDirectionItem ----------------------------------------------
  27
  28 /* [Description]
  29
  30     This item defines a frame direction, which place the content inside
  31     a frame. It exist different kind of directions which are used to the
  32     layout text for Western, CJK and CTL languages.
  33 */
  34
  35 class EDITENG_DLLPUBLIC SvxFrameDirectionItem : public SfxUInt16Item
  36 {
  37 public:
  38     static SfxPoolItem* CreateDefault();
  39
  40     SvxFrameDirectionItem( SvxFrameDirection nValue /*= FRMDIR_HORI_LEFT_TOP*/,
  41                             sal_uInt16 nWhich  );
  42     virtual ~SvxFrameDirectionItem() override;
  43
  44     virtual SfxPoolItem*    Clone( SfxItemPool *pPool = nullptr ) const override;
  45     virtual SfxPoolItem*    Create(SvStream &, sal_uInt16) const override;
  46     virtual SvStream&       Store(SvStream & rStrm, sal_uInt16 nIVer) const override;
  47     virtual sal_uInt16          GetVersion( sal_uInt16 nFileVersion ) const override;
  48     virtual bool            operator==( const SfxPoolItem& ) const override;
  49
  50     virtual bool GetPresentation( SfxItemPresentation ePres,
  51                                   MapUnit eCoreMetric,
  52                                   MapUnit ePresMetric,
  53                                   OUString &rText,
  54                                   const IntlWrapper * = nullptr ) const override;
  55
  56     virtual bool            QueryValue( css::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const override;
  57     virtual bool            PutValue( const css::uno::Any& rVal, sal_uInt8 nMemberId ) override;
  58
  59     inline SvxFrameDirectionItem& operator=( const SvxFrameDirectionItem& rItem )
  60     {
  61         SetValue( rItem.GetValue() );
  62         return *this;
  63     }
  64 };
  65
  66 #endif // INCLUDED_EDITENG_FRMDIRITEM_HXX
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */