offapi/com/sun/star/awt/Gradient.idl

   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 __com_sun_star_awt_Gradient_idl__
  20 #define __com_sun_star_awt_Gradient_idl__
  21
  22 #include <com/sun/star/awt/GradientStyle.idl>
  23
  24 #include <com/sun/star/util/Color.idl>
  25
  26
  27
  28  module com {  module sun {  module star {  module awt {
  29
  30
  31 /** Describes a gradient between two colors. Many aspects of the
  32  *  gradient are undefined, like the algorithm and color space to use
  33  *  to interpolate between the colors and what "intensity" means.
  34  */
  35 published struct Gradient
  36 {
  37
  38     /** specifies the style of the gradient.
  39      */
  40     com::sun::star::awt::GradientStyle Style;
  41
  42
  43     /** specifies the color at the start point of the gradient.
  44      */
  45     com::sun::star::util::Color StartColor;
  46
  47
  48     /** specifies the color at the end point of the gradient.
  49      */
  50     com::sun::star::util::Color EndColor;
  51
  52
  53     /** angle of the gradient in 1/10 degree.
  54      */
  55     short Angle;
  56
  57
  58     /** per cent of the total width where just the start color is used.
  59      */
  60     short Border;
  61
  62
  63     /** Specifies the X-coordinate, where the gradient begins,
  64      *  whatever that means. Possibly means the *center* of the
  65      *  ELLIPTICAL, SQUARE and RECT style gradients?
  66      */
  67     short XOffset;
  68
  69
  70     /** Specifies the Y-coordinate, where the gradient begins. See
  71         previous field.
  72      */
  73     short YOffset;
  74
  75
  76     /** Specifies the intensity at the start point of the gradient. What that means is undefined.
  77      */
  78     short StartIntensity;
  79
  80
  81     /** specifies the intensity at the end point of the gradient.
  82      */
  83     short EndIntensity;
  84
  85
  86     /** Specifies the number of steps of change color. What that means
  87      *  is undefined.
  88      */
  89     short StepCount;
  90
  91 };
  92
  93
  94 }; }; }; };
  95
  96 #endif
  97
  98 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */