.. wxPython Phoenix documentation

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

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

.. include:: headings.inc



.. _wx.BrushList:

==========================================================================================================================================
|phoenix_title|  **wx.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 `wx.TheBrushList`     . 








         



.. seealso:: :ref:`wx.Brush`    







|

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

.. raw:: html

   <div class="collabsible-wrapper">
      <input id="collapsible-inheritance" class="collapsible-checkbox" type="checkbox">
      <label for="collapsible-inheritance" tabindex="0" title="Show inheritance diagram" class="collapsible-label">Inheritance diagram for class <strong>BrushList</strong>:</label>
      <div class="collapsible-content">
         <p class="graphviz">
            <center><img src="_static/images/inheritance/wx.BrushList_inheritance.svg" alt="Inheritance diagram of BrushList" usemap="#dummy" class="inheritance invert-in-dark-mode"/></center>
            <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.BrushList.html" title="A brush list is a list containing all brushes which have been created." alt="" coords="5,5,125,34"/> </map> 
         </p>
      </div>
   </div>
   <script type="text/javascript" src="_static/inheritancetoggle.js"></script>



|


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

================================================================================ ================================================================================
:meth:`~wx.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:: wx.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`: wx.Colour
      :param `style`: Brush style. See :ref:`wx.BrushStyle`  for a list of styles.   
      :type `style`: wx.BrushStyle








      :rtype: :ref:`wx.Brush`




                  




