sw/source/uibase/inc/frmmgr.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_SOURCE_UIBASE_INC_FRMMGR_HXX
  20 #define INCLUDED_SW_SOURCE_UIBASE_INC_FRMMGR_HXX
  21
  22 #include <swtypes.hxx>
  23 #include <editeng/boxitem.hxx>
  24 #include <editeng/shaditem.hxx>
  25 #include <tools/gen.hxx>
  26 #include <fmtfsize.hxx>
  27 #include <fmtornt.hxx>
  28 #include <fmtanchr.hxx>
  29 #include <swdllapi.h>
  30
  31 class   SwWrtShell;
  32 struct  SvxSwFrameValidation;
  33 struct  SwPosition;
  34
  35 class   SwFormatCol;
  36 class SvGlobalName;
  37
  38 constexpr SwTwips DFLT_WIDTH = o3tl::toTwips(20, o3tl::Length::mm);
  39 constexpr SwTwips DFLT_HEIGHT = o3tl::toTwips(5, o3tl::Length::mm);
  40
  41 enum class Frmmgr_Type
  42 {
  43     NONE    = 0x00,
  44     TEXT    = 0x01,
  45     GRF     = 0x02,
  46     OLE     = 0x04,
  47     ENVELP  = 0x10
  48 };
  49
  50 class SwFlyFrameAttrMgr
  51 {
  52     SfxItemSet  m_aSet;
  53     Point       m_aAbsPos;
  54     SwWrtShell* m_pOwnSh;
  55
  56     bool    m_bAbsPos,
  57             m_bNewFrame;
  58     bool    m_bIsInVertical;
  59     // #mongolianlayout#
  60     bool    m_bIsInVerticalL2R;
  61
  62     // internal calculation for borders
  63     SwTwips           CalcTopSpace();
  64     SwTwips           CalcBottomSpace();
  65     SwTwips           CalcLeftSpace();
  66     SwTwips           CalcRightSpace();
  67
  68     void UpdateFlyFrame_(); // post-treatment after insert or update
  69
  70 public:
  71     SW_DLLPUBLIC SwFlyFrameAttrMgr( bool bNew, SwWrtShell* pSh, Frmmgr_Type nType, const SvGlobalName* pName );
  72
  73     //CopyCtor for dialogs to check the metrics
  74     SW_DLLPUBLIC SwFlyFrameAttrMgr( bool bNew, SwWrtShell *pSh, SfxItemSet aSet );
  75
  76     SW_DLLPUBLIC void SetAnchor(RndStdIds eId);
  77     inline RndStdIds    GetAnchor()  const;
  78
  79     void                SetHorzOrientation(sal_Int16 eOrient);
  80     void                SetVertOrientation(sal_Int16 eOrient);
  81
  82     // absolute position
  83     void                SetAbsPos(const Point& rLPoint);
  84
  85     // anchor's relative position
  86     void                SetPos(const Point& rLPoint);
  87     inline Point        GetPos() const;
  88
  89     // size
  90     void                SetSize(const Size& rLSize);
  91     inline const Size&  GetSize() const;
  92
  93     void                SetHeightSizeType(SwFrameSize eType);
  94
  95     // rotation
  96     void                SetRotation(Degree10 nOld, Degree10 nNew, const Size& rUnrotatedSize);
  97
  98     // space to content
  99     void                SetLRSpace( tools::Long nLeft,
 100                                     tools::Long nRight );
 101     void                SetULSpace( tools::Long nTop,
 102                                     tools::Long nBottom );
 103
 104     void                SetCol( const SwFormatCol &rCol);
 105
 106     // change and query attributes
 107     void                UpdateAttrMgr();
 108     void                UpdateFlyFrame();
 109
 110     // create new frame
 111     void                InsertFlyFrame();
 112     SW_DLLPUBLIC void   InsertFlyFrame(RndStdIds      eAnchorType,
 113                                    const Point    &rPos,
 114                                    const Size     &rSize);
 115
 116     // check and change metrics
 117     SW_DLLPUBLIC void   ValidateMetrics(SvxSwFrameValidation& rVal,
 118                             const SwFormatAnchor* pToCharContentPos,
 119                             bool bOnlyPercentRefValue = false);
 120
 121     void                DelAttr(sal_uInt16 nId);
 122
 123     // reach out the set
 124     const SfxItemSet &GetAttrSet() const { return m_aSet; }
 125     SfxItemSet &GetAttrSet()       { return m_aSet; }
 126     void                     SetAttrSet(const SfxItemSet& rSet);
 127     void SetFrameSizeFromTable();
 128     /// Checks if we have a table selection and that covers exactly 1 full table.
 129     SW_DLLPUBLIC static const SwTableFormat* SingleTableSelected(SwWrtShell& rWrtShell);
 130
 131     inline const SwFormatVertOrient &GetVertOrient() const;
 132     inline const SwFormatHoriOrient &GetHoriOrient() const;
 133     inline const SvxShadowItem   &GetShadow() const;
 134     inline const SvxBoxItem      &GetBox() const;
 135     inline const SwFormatFrameSize    &GetFrameSize() const;
 136
 137     tools::Long CalcWidthBorder()  { return CalcLeftSpace()+CalcRightSpace(); }
 138     tools::Long CalcHeightBorder() { return CalcTopSpace()+CalcBottomSpace(); }
 139 };
 140
 141 inline const Size& SwFlyFrameAttrMgr::GetSize() const
 142 {
 143     return m_aSet.Get(RES_FRM_SIZE).GetSize();
 144 }
 145
 146 inline const SwFormatVertOrient &SwFlyFrameAttrMgr::GetVertOrient() const
 147 {
 148     return m_aSet.Get(RES_VERT_ORIENT);
 149 }
 150 inline const SwFormatHoriOrient &SwFlyFrameAttrMgr::GetHoriOrient() const
 151 {
 152     return m_aSet.Get(RES_HORI_ORIENT);
 153 }
 154 inline const SwFormatFrameSize& SwFlyFrameAttrMgr::GetFrameSize() const
 155 {
 156     return m_aSet.Get(RES_FRM_SIZE);
 157 }
 158 inline const SvxShadowItem &SwFlyFrameAttrMgr::GetShadow() const
 159 {
 160     return m_aSet.Get(RES_SHADOW);
 161 }
 162 inline const SvxBoxItem &SwFlyFrameAttrMgr::GetBox() const
 163 {
 164     return m_aSet.Get(RES_BOX);
 165 }
 166 inline Point SwFlyFrameAttrMgr::GetPos() const
 167 {
 168     return Point( GetHoriOrient().GetPos(), GetVertOrient().GetPos() );
 169 }
 170 inline RndStdIds SwFlyFrameAttrMgr::GetAnchor()  const
 171 {
 172     return m_aSet.Get(RES_ANCHOR).GetAnchorId();
 173 }
 174
 175 #endif
 176
 177 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */