include/svx/sdr/attribute/sdrtextattribute.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
  20 #ifndef INCLUDED_SVX_SDR_ATTRIBUTE_SDRTEXTATTRIBUTE_HXX
  21 #define INCLUDED_SVX_SDR_ATTRIBUTE_SDRTEXTATTRIBUTE_HXX
  22
  23 #include <sal/types.h>
  24 #include <svx/xenum.hxx>
  25 #include <editeng/outlobj.hxx>
  26 #include <svx/sdtaitm.hxx>
  27 #include <o3tl/cow_wrapper.hxx>
  28
  29 // predefines
  30
  31 class SdrText;
  32
  33 namespace drawinglayer { namespace animation {
  34     class AnimationEntryList;
  35 }}
  36
  37 namespace drawinglayer { namespace attribute {
  38     class SdrFormTextAttribute;
  39 }}
  40
  41 namespace drawinglayer { namespace attribute {
  42     class ImpSdrTextAttribute;
  43 }}
  44
  45
  46 namespace drawinglayer
  47 {
  48     namespace attribute
  49     {
  50         class SdrTextAttribute
  51         {
  52         public:
  53             typedef o3tl::cow_wrapper< ImpSdrTextAttribute > ImplType;
  54
  55         private:
  56             ImplType mpSdrTextAttribute;
  57
  58         public:
  59             /// constructors/assignmentoperator/destructor
  60             SdrTextAttribute(
  61                 const SdrText& rSdrText,
  62                 const OutlinerParaObject& rOutlinerParaObject,
  63                 XFormTextStyle eFormTextStyle,
  64                 sal_Int32 aTextLeftDistance,
  65                 sal_Int32 aTextUpperDistance,
  66                 sal_Int32 aTextRightDistance,
  67                 sal_Int32 aTextLowerDistance,
  68                 SdrTextHorzAdjust aSdrTextHorzAdjust,
  69                 SdrTextVertAdjust aSdrTextVertAdjust,
  70                 bool bContour,
  71                 bool bFitToSize,
  72                 bool bAutoFit,
  73                 bool bHideContour,
  74                 bool bBlink,
  75                 bool bScroll,
  76                 bool bInEditMode,
  77                 bool bFixedCellHeight,
  78                 bool bWrongSpell,
  79                 bool bChainable);
  80
  81             SdrTextAttribute();
  82             SdrTextAttribute(const SdrTextAttribute& rCandidate);
  83             SdrTextAttribute(SdrTextAttribute&& rCandidate) noexcept;
  84             SdrTextAttribute& operator=(const SdrTextAttribute& rCandidate);
  85             SdrTextAttribute& operator=(SdrTextAttribute&& rCandidate) noexcept;
  86             ~SdrTextAttribute();
  87
  88             // checks if the incarnation is default constructed
  89             bool isDefault() const;
  90
  91             // compare operator
  92             bool operator==(const SdrTextAttribute& rCandidate) const;
  93
  94             // data read access
  95             const SdrText& getSdrText() const;
  96             const OutlinerParaObject& getOutlinerParaObject() const;
  97             bool isContour() const;
  98             bool isFitToSize() const;
  99             bool isAutoFit() const;
 100             bool isHideContour() const;
 101             bool isBlink() const;
 102             bool isScroll() const;
 103             bool isInEditMode() const;
 104             bool isFixedCellHeight() const;
 105             const SdrFormTextAttribute& getSdrFormTextAttribute() const;
 106             sal_Int32 getTextLeftDistance() const;
 107             sal_Int32 getTextUpperDistance() const;
 108             sal_Int32 getTextRightDistance() const;
 109             sal_Int32 getTextLowerDistance() const;
 110             SdrTextHorzAdjust getSdrTextHorzAdjust() const;
 111             SdrTextVertAdjust getSdrTextVertAdjust() const;
 112
 113             bool isChainable() const;
 114
 115
 116             // helpers: animation timing generators
 117             void getBlinkTextTiming(
 118                 drawinglayer::animation::AnimationEntryList& rAnimList) const;
 119             void getScrollTextTiming(
 120                 drawinglayer::animation::AnimationEntryList& rAnimList,
 121                 double fFrameLength,
 122                 double fTextLength) const;
 123         };
 124     } // end of namespace attribute
 125 } // end of namespace drawinglayer
 126
 127
 128 #endif // INCLUDED_SVX_SDR_ATTRIBUTE_SDRTEXTATTRIBUTE_HXX
 129
 130 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */