.. 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
.. _wx.GraphicsGradientStop:
==========================================================================================================================================
|phoenix_title| **wx.GraphicsGradientStop**
==========================================================================================================================================
Represents a single gradient stop in a collection of gradient stops as represented by :ref:`wx.GraphicsGradientStops`.
.. versionadded:: 2.9.1
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
GraphicsGradientStop:
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.GraphicsGradientStop.__init__` Creates a stop with the given colour and position.
:meth:`~wx.GraphicsGradientStop.GetColour` Return the stop colour.
:meth:`~wx.GraphicsGradientStop.GetPosition` Return the stop position.
:meth:`~wx.GraphicsGradientStop.SetColour` Change the stop colour.
:meth:`~wx.GraphicsGradientStop.SetPosition` Change the stop position.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.GraphicsGradientStop.Colour` See :meth:`~wx.GraphicsGradientStop.GetColour` and :meth:`~wx.GraphicsGradientStop.SetColour`
:attr:`~wx.GraphicsGradientStop.Position` See :meth:`~wx.GraphicsGradientStop.GetPosition` and :meth:`~wx.GraphicsGradientStop.SetPosition`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.GraphicsGradientStop(object)
**Possible constructors**::
GraphicsGradientStop(col: Colour=TransparentColour, pos: float=0.) ->
None
Represents a single gradient stop in a collection of gradient stops as
represented by GraphicsGradientStops.
.. method:: __init__(self, col: Colour=TransparentColour, pos: float=0.)
Creates a stop with the given colour and position.
:param `col`: The colour of this stop. Note that the alpha component of the colour is honoured thus allowing the background colours to partially show through the gradient.
:type `col`: wx.Colour
:param `pos`: The stop position, must be in ``[0``, ``1]`` range with 0 being the beginning and 1 the end of the gradient.
:type `pos`: float
:rtype: `None`
.. method:: GetColour(self)
Return the stop colour.
:rtype: :ref:`wx.Colour`
.. method:: GetPosition(self)
Return the stop position.
:rtype: `float`
.. method:: SetColour(self, col : Colour)
Change the stop colour.
:param `col`: The new colour.
:type `col`: wx.Colour
:rtype: `None`
.. method:: SetPosition(self, pos : float)
Change the stop position.
:param `pos`: The new position, must always be in ``[0``, ``1]`` range.
:type `pos`: float
:rtype: `None`
.. attribute:: Colour
See :meth:`~wx.GraphicsGradientStop.GetColour` and :meth:`~wx.GraphicsGradientStop.SetColour`
.. attribute:: Position
See :meth:`~wx.GraphicsGradientStop.GetPosition` and :meth:`~wx.GraphicsGradientStop.SetPosition`