.. include:: headings.inc

.. currentmodule:: lib.graphics

.. highlight:: python



.. _lib.graphics.GraphicsGradientStops:

==========================================================================================================================================
|phoenix_title|  **GraphicsGradientStops**
==========================================================================================================================================

An ordered collection of gradient color stops for a gradient brush. There
is always at least the starting stop and the ending stop in the collection.



|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **GraphicsGradientStops**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.graphics.GraphicsGradientStops_inheritance.png" alt="Inheritance diagram of GraphicsGradientStops" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="lib.graphics.GraphicsGradientStops.html" title="An ordered collection of gradient color stops for a gradient brush. There" alt="" coords="125,5,384,35"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~lib.graphics.GraphicsGradientStops.__init__`                             
:meth:`~lib.graphics.GraphicsGradientStops.Add`                                  Add a new color to the collection. args may be either a gradient stop,
:meth:`~lib.graphics.GraphicsGradientStops.GetCount`                             
:meth:`~lib.graphics.GraphicsGradientStops.GetEndColour`                         
:meth:`~lib.graphics.GraphicsGradientStops.GetStartColour`                       
:meth:`~lib.graphics.GraphicsGradientStops.Item`                                 
:meth:`~lib.graphics.GraphicsGradientStops.SetEndColour`                         
:meth:`~lib.graphics.GraphicsGradientStops.SetStartColour`                       
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~lib.graphics.GraphicsGradientStops.Count`                                
:attr:`~lib.graphics.GraphicsGradientStops.EndColour`                            
:attr:`~lib.graphics.GraphicsGradientStops.StartColour`                          
================================================================================ ================================================================================


|


|api| Class API
===============
   

.. class:: GraphicsGradientStops(object)

   An ordered collection of gradient color stops for a gradient brush. There
   is always at least the starting stop and the ending stop in the collection.

   .. method:: __init__(self, startColour=TransparentColour, endColour=TransparentColour)


   .. method:: Add(self, \*args)

      Add a new color to the collection. args may be either a gradient stop,
      or a colour and position.


   .. method:: GetCount(self)


   .. method:: GetEndColour(self)


   .. method:: GetStartColour(self)


   .. method:: Item(self, n)


   .. method:: SetEndColour(self, col)


   .. method:: SetStartColour(self, col)


   .. attribute:: Count

      See :meth:`~GraphicsGradientStops.GetCount` 


   .. attribute:: EndColour

      See :meth:`~GraphicsGradientStops.SetEndColour` , :meth:`~GraphicsGradientStops.GetEndColour` 


   .. attribute:: StartColour

      See :meth:`~GraphicsGradientStops.SetStartColour` , :meth:`~GraphicsGradientStops.GetStartColour`