oox/inc/drawingml/lineproperties.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_OOX_INC_DRAWINGML_LINEPROPERTIES_HXX
  21 #define INCLUDED_OOX_INC_DRAWINGML_LINEPROPERTIES_HXX
  22
  23 #include <utility>
  24 #include <vector>
  25
  26 #include <com/sun/star/drawing/LineCap.hpp>
  27 #include <com/sun/star/drawing/LineJoint.hpp>
  28 #include <com/sun/star/drawing/LineStyle.hpp>
  29 #include <oox/helper/helper.hxx>
  30 #include <sal/types.h>
  31
  32 #include <drawingml/fillproperties.hxx>
  33
  34 namespace oox { class GraphicHelper; }
  35
  36 namespace oox::drawingml {
  37
  38 class ShapePropertyMap;
  39
  40 struct LineArrowProperties
  41 {
  42     OptValue< sal_Int32 > moArrowType;
  43     OptValue< sal_Int32 > moArrowWidth;
  44     OptValue< sal_Int32 > moArrowLength;
  45
  46     /** Overwrites all members that are explicitly set in rSourceProps. */
  47     void                assignUsed( const LineArrowProperties& rSourceProps );
  48 };
  49
  50 struct LineProperties
  51 {
  52     typedef ::std::pair< sal_Int32, sal_Int32 > DashStop;
  53     typedef ::std::vector< DashStop >           DashStopVector;
  54
  55     LineArrowProperties maStartArrow;       /// Start line arrow style.
  56     LineArrowProperties maEndArrow;         /// End line arrow style.
  57     FillProperties      maLineFill;         /// Line fill (solid, gradient, ...).
  58     DashStopVector      maCustomDash;       /// User-defined line dash style.
  59     OptValue< sal_Int32 > moLineWidth;      /// Line width (EMUs).
  60     OptValue< sal_Int32 > moPresetDash;     /// Preset dash (OOXML token).
  61     OptValue< sal_Int32 > moLineCompound;   /// Line compound type (OOXML token).
  62     OptValue< sal_Int32 > moLineCap;        /// Line cap (OOXML token).
  63     OptValue< sal_Int32 > moLineJoint;      /// Line joint type (OOXML token).
  64
  65     /** Overwrites all members that are explicitly set in rSourceProps. */
  66     void                assignUsed( const LineProperties& rSourceProps );
  67
  68     /** Writes the properties to the passed property map. */
  69     void                pushToPropMap(
  70                             ShapePropertyMap& rPropMap,
  71                             const GraphicHelper& rGraphicHelper,
  72                             ::Color nPhClr = API_RGB_TRANSPARENT ) const;
  73
  74     /** Calculates the line style attribute from the internal state of the object */
  75     css::drawing::LineStyle  getLineStyle() const;
  76     /** Calculates the line cap attribute from the internal state of the object */
  77     css::drawing::LineCap  getLineCap() const;
  78     /** Calculates the line joint attribute from the internal state of the object */
  79     css::drawing::LineJoint  getLineJoint() const;
  80     /** Calculates the line width attribute from the internal state of the object */
  81     sal_Int32           getLineWidth() const;
  82 };
  83
  84 } // namespace oox::drawingml
  85
  86 #endif
  87
  88 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */