src/sp-stop.h

   1 #ifndef SEEN_SP_STOP_H
   2 #define SEEN_SP_STOP_H
   3
   4 /** \file
   5  * SPStop: SVG <stop> implementation.
   6  */
   7 /*
   8  * Authors?
   9  */
  10
  11 #include <glib/gtypes.h>
  12 #include <glibmm/ustring.h>
  13 #include "sp-object.h"
  14 #include "color.h"
  15
  16 class SPObjectClass;
  17 class SPColor;
  18
  19 struct SPStop;
  20 struct SPStopClass;
  21
  22 #define SP_TYPE_STOP (sp_stop_get_type())
  23 #define SP_STOP(o) (G_TYPE_CHECK_INSTANCE_CAST((o), SP_TYPE_STOP, SPStop))
  24 #define SP_STOP_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), SP_TYPE_STOP, SPStopClass))
  25 #define SP_IS_STOP(o) (G_TYPE_CHECK_INSTANCE_TYPE((o), SP_TYPE_STOP))
  26 #define SP_IS_STOP_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE((k), SP_TYPE_STOP))
  27
  28 GType sp_stop_get_type();
  29
  30 /** Gradient stop. */
  31 struct SPStop : public SPObject {
  32     /// \todo fixme: Should be SPSVGPercentage
  33     gfloat offset;
  34
  35     bool currentColor;
  36
  37     /** \note
  38      * N.B.\ Meaningless if currentColor is true.  Use sp_stop_get_rgba32 or sp_stop_get_color
  39      * (currently static in sp-gradient.cpp) if you want the effective color.
  40      */
  41     SPColor specified_color;
  42
  43     /// \todo fixme: Implement SPSVGNumber or something similar.
  44     gfloat opacity;
  45
  46
  47     static SPColor readStopColor( Glib::ustring const &styleStr, guint32 dfl = 0 );
  48
  49     SPStop* getNextStop();
  50     SPStop* getPrevStop();
  51
  52     SPColor getEffectiveColor() const;
  53 };
  54
  55 /// The SPStop vtable.
  56 struct SPStopClass {
  57     SPObjectClass parent_class;
  58 };
  59
  60 guint32 sp_stop_get_rgba32(SPStop const *);
  61
  62
  63 #endif /* !SEEN_SP_STOP_H */
  64
  65 /*
  66   Local Variables:
  67   mode:c++
  68   c-file-style:"stroustrup"
  69   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
  70   indent-tabs-mode:nil
  71   fill-column:99
  72   End:
  73 */
  74 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :