.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2020 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc

.. currentmodule:: wx.lib.graphics

.. highlight:: python



.. _wx.lib.graphics.GraphicsGradientStops:

==========================================================================================================================================
|phoenix_title|  **wx.lib.graphics.GraphicsGradientStops**
==========================================================================================================================================

An ordered collection of gradient color stops
(i.e. a :class:`GraphicsGradientStop`) for a gradient brush. There is
always at least the starting stop and the ending stop in the collection.



|

|class_hierarchy| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>GraphicsGradientStops</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.lib.graphics.GraphicsGradientStops_inheritance.svg" alt="Inheritance diagram of GraphicsGradientStops" usemap="#dummy" class="inheritance"/></center>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.graphics.GraphicsGradientStops.html" title="An ordered collection of gradient color stops" alt="" coords="5,5,310,34"/> </map> 
   </p>
   </div>

|


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

================================================================================ ================================================================================
:meth:`~wx.lib.graphics.GraphicsGradientStops.__init__`                          Initialize self.  See help(type(self)) for accurate signature.
:meth:`~wx.lib.graphics.GraphicsGradientStops.Add`                               Add a new color to the collection. ``args`` may be either a gradient stop,
:meth:`~wx.lib.graphics.GraphicsGradientStops.GetCount`                          
:meth:`~wx.lib.graphics.GraphicsGradientStops.GetEndColour`                      
:meth:`~wx.lib.graphics.GraphicsGradientStops.GetStartColour`                    
:meth:`~wx.lib.graphics.GraphicsGradientStops.Item`                              
:meth:`~wx.lib.graphics.GraphicsGradientStops.SetEndColour`                      
:meth:`~wx.lib.graphics.GraphicsGradientStops.SetStartColour`                    
================================================================================ ================================================================================


|


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

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


|


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


.. class:: GraphicsGradientStops(object)

   An ordered collection of gradient color stops
   (i.e. a :class:`GraphicsGradientStop`) for a gradient brush. There is
   always at least the starting stop and the ending stop in the collection.

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

      Initialize self.  See help(type(self)) for accurate signature.


   .. 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`