sw/inc/fmtornt.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_SW_INC_FMTORNT_HXX
  20 #define INCLUDED_SW_INC_FMTORNT_HXX
  21
  22 #include <com/sun/star/text/HoriOrientation.hpp>
  23 #include <com/sun/star/text/VertOrientation.hpp>
  24 #include <com/sun/star/text/RelOrientation.hpp>
  25 #include "swdllapi.h"
  26 #include "hintids.hxx"
  27 #include "swtypes.hxx"
  28 #include "format.hxx"
  29 #include <svl/poolitem.hxx>
  30
  31 class IntlWrapper;
  32
  33 /// Defines the vertical position of a fly frame.
  34 ///
  35 /// For example: from top (orientation), by 1cm (relative position), to the entire page (relation).
  36 class SW_DLLPUBLIC SwFormatVertOrient final : public SfxPoolItem
  37 {
  38     SwTwips         m_nYPos;  ///< Contains *always* the current RelPos.
  39     sal_Int16       m_eOrient;
  40     sal_Int16       m_eRelation;
  41 public:
  42     SwFormatVertOrient( SwTwips nY = 0, sal_Int16 eVert = css::text::VertOrientation::NONE,
  43                      sal_Int16 eRel = css::text::RelOrientation::PRINT_AREA );
  44     SwFormatVertOrient(SwFormatVertOrient const &) = default; // SfxPoolItem copy function dichotomy
  45
  46     /// "Pure virtual methods" of SfxPoolItem.
  47     virtual bool            operator==( const SfxPoolItem& ) const override;
  48     virtual SwFormatVertOrient* Clone( SfxItemPool* pPool = nullptr ) const override;
  49     virtual bool GetPresentation( SfxItemPresentation ePres,
  50                                   MapUnit eCoreMetric,
  51                                   MapUnit ePresMetric,
  52                                     OUString &rText,
  53                                     const IntlWrapper& rIntl ) const override;
  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     sal_Int16 GetVertOrient() const { return m_eOrient; }
  58     sal_Int16 GetRelationOrient() const { return m_eRelation; }
  59     void   SetVertOrient( sal_Int16 eNew ) { m_eOrient = eNew; }
  60     void   SetRelationOrient( sal_Int16 eNew ) { m_eRelation = eNew; }
  61
  62     SwTwips GetPos() const { return m_nYPos; }
  63     void    SetPos( SwTwips nNew ) { m_nYPos = nNew; }
  64
  65     void dumpAsXml(xmlTextWriterPtr pWriter) const override;
  66 };
  67
  68 /// Defines the horizontal position of a fly frame.
  69 ///
  70 /// For example: from left (orientation), by 1 cm (relative position), to the entire page
  71 /// (relation).
  72 class SW_DLLPUBLIC SwFormatHoriOrient final : public SfxPoolItem
  73 {
  74     SwTwips         m_nXPos;              ///< Contains *always* the current RelPos.
  75     sal_Int16       m_eOrient;
  76     sal_Int16       m_eRelation;
  77     bool            m_bPosToggle : 1; ///< Flip position on even pages.
  78 public:
  79     SwFormatHoriOrient( SwTwips nX = 0, sal_Int16 eHori = css::text::HoriOrientation::NONE,
  80         sal_Int16 eRel = css::text::RelOrientation::PRINT_AREA, bool bPos = false );
  81     SwFormatHoriOrient(SwFormatHoriOrient const &) = default; // SfxPoolItem copy function dichotomy
  82
  83     /// "Pure virtual methods" of SfxPoolItem.
  84     virtual bool            operator==( const SfxPoolItem& ) const override;
  85     virtual SwFormatHoriOrient* Clone( SfxItemPool* pPool = nullptr ) const override;
  86     virtual bool GetPresentation( SfxItemPresentation ePres,
  87                                   MapUnit eCoreMetric,
  88                                   MapUnit ePresMetric,
  89                                   OUString &rText,
  90                                   const IntlWrapper& rIntl ) const override;
  91     virtual bool QueryValue( css::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const override;
  92     virtual bool PutValue( const css::uno::Any& rVal, sal_uInt8 nMemberId ) override;
  93
  94     sal_Int16 GetHoriOrient() const { return m_eOrient; }
  95     sal_Int16 GetRelationOrient() const { return m_eRelation; }
  96     void SetHoriOrient( sal_Int16 eNew ) { m_eOrient = eNew; }
  97     void SetRelationOrient( sal_Int16 eNew ) { m_eRelation = eNew; }
  98
  99     SwTwips GetPos() const { return m_nXPos; }
 100     void    SetPos( SwTwips nNew ) { m_nXPos = nNew; }
 101
 102     bool IsPosToggle() const { return m_bPosToggle; }
 103     void SetPosToggle( bool bNew ) { m_bPosToggle = bNew; }
 104
 105     void dumpAsXml(xmlTextWriterPtr pWriter) const override;
 106 };
 107
 108 inline const SwFormatVertOrient &SwAttrSet::GetVertOrient(bool bInP) const
 109     { return Get( RES_VERT_ORIENT,bInP); }
 110 inline const SwFormatHoriOrient &SwAttrSet::GetHoriOrient(bool bInP) const
 111     { return Get( RES_HORI_ORIENT,bInP); }
 112
 113 inline const SwFormatVertOrient &SwFormat::GetVertOrient(bool bInP) const
 114     { return m_aSet.GetVertOrient(bInP); }
 115 inline const SwFormatHoriOrient &SwFormat::GetHoriOrient(bool bInP) const
 116     { return m_aSet.GetHoriOrient(bInP); }
 117
 118 namespace sw {
 119
 120     bool GetAtPageRelOrientation(sal_Int16 & rOrientation, bool const isIgnorePrintArea);
 121
 122 }
 123
 124 #endif
 125
 126 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */