.. include:: headings.inc



.. _BrushList:

==========================================================================================================================================
|phoenix_title|  **BrushList**
==========================================================================================================================================

A brush list is a list containing all brushes which have been created.          

The application should not construct its own brush list: it should use the object pointer ``TheBrushList`` 







         



.. seealso:: :ref:`Brush`    







|

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

Inheritance diagram for class **BrushList**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/BrushList_inheritance.png" alt="Inheritance diagram of BrushList" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="BrushList.html" title="A brush list is a list containing all brushes which have been created." alt="" coords="5,5,96,35"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~BrushList.FindOrCreateBrush`                                             Finds a brush with the specified attributes and returns it, else creates a new brush, adds it to the brush list, and returns it.
================================================================================ ================================================================================


|


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

.. class:: BrushList(object)

   A brush list is a list containing all brushes which have been created.



   .. method:: FindOrCreateBrush(self, colour, style=BRUSHSTYLE_SOLID)

      Finds a brush with the specified attributes and returns it, else creates a new brush, adds it to the brush list, and returns it.                  




      :param `colour`: Colour object.   
      :type `colour`: Colour
      :param `style`: Brush style. See :ref:`BrushStyle`   for a list of styles.   
      :type `style`: BrushStyle








      :rtype: :ref:`Brush`