.. include:: headings.inc



.. _ListItemAttr:

==========================================================================================================================================
|phoenix_title|  **ListItemAttr**
==========================================================================================================================================

Represents the attributes (color, font, .          

..) of a ListCtrl's :ref:`ListItem`. 







         



.. seealso:: :ref:`ListCtrl Overview <listctrl overview>`, :ref:`ListCtrl`, :ref:`ListItem`    







|

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

Inheritance diagram for class **ListItemAttr**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/ListItemAttr_inheritance.png" alt="Inheritance diagram of ListItemAttr" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="ListItemAttr.html" title="Represents the attributes (color, font, ." alt="" coords="7,5,108,35"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~ListItemAttr.__init__`                                                   Default Constructor.
:meth:`~ListItemAttr.GetBackgroundColour`                                        Returns the currently set background color.
:meth:`~ListItemAttr.GetFont`                                                    Returns the currently set font.
:meth:`~ListItemAttr.GetTextColour`                                              Returns the currently set text color.
:meth:`~ListItemAttr.HasBackgroundColour`                                        Returns ``True`` if the currently set background color is valid.
:meth:`~ListItemAttr.HasFont`                                                    Returns ``True`` if the currently set font is valid.
:meth:`~ListItemAttr.HasTextColour`                                              Returns ``True`` if the currently set text color is valid.
:meth:`~ListItemAttr.SetBackgroundColour`                                        Sets a new background color.
:meth:`~ListItemAttr.SetFont`                                                    Sets a new font.
:meth:`~ListItemAttr.SetTextColour`                                              Sets a new text color.
================================================================================ ================================================================================


|


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

================================================================================ ================================================================================
:attr:`~ListItemAttr.BackgroundColour`                                           See :meth:`~ListItemAttr.GetBackgroundColour` and :meth:`~ListItemAttr.SetBackgroundColour`
:attr:`~ListItemAttr.Font`                                                       See :meth:`~ListItemAttr.GetFont` and :meth:`~ListItemAttr.SetFont`
:attr:`~ListItemAttr.TextColour`                                                 See :meth:`~ListItemAttr.GetTextColour` and :meth:`~ListItemAttr.SetTextColour`
================================================================================ ================================================================================


|


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

.. class:: ListItemAttr(object)

   Represents the attributes (color, font, .
   
   **Possible constructors**::

       ListItemAttr()
       
       ListItemAttr(colText, colBack, font)
       



   .. method:: __init__(self, *args, **kw)



      |overload| **Overloaded Implementations**:

      **~~~**

      
      **__init__** `(self)`
      
      Default Constructor.                   
      
      
      
      
      **~~~**

      
      **__init__** `(self, colText, colBack, font)`
      
      Construct a :ref:`ListItemAttr`  with the specified foreground and background colors and font.                  
      
      
      :param `colText`: 
      :type `colText`: Colour
      :param `colBack`: 
      :type `colBack`: Colour
      :param `font`: 
      :type `font`: Font
      
      
      
      
      
      
      **~~~**






   .. method:: GetBackgroundColour(self)

      Returns the currently set background color.                  

      :rtype: :ref:`Colour`








   .. method:: GetFont(self)

      Returns the currently set font.                  

      :rtype: :ref:`Font`








   .. method:: GetTextColour(self)

      Returns the currently set text color.                  

      :rtype: :ref:`Colour`








   .. method:: HasBackgroundColour(self)

      Returns ``True`` if the currently set background color is valid.                  

      :rtype: `bool`








   .. method:: HasFont(self)

      Returns ``True`` if the currently set font is valid.                  

      :rtype: `bool`








   .. method:: HasTextColour(self)

      Returns ``True`` if the currently set text color is valid.                  

      :rtype: `bool`








   .. method:: SetBackgroundColour(self, colour)

      Sets a new background color.                  


      :param `colour`: 
      :type `colour`: Colour







   .. method:: SetFont(self, font)

      Sets a new font.                  


      :param `font`: 
      :type `font`: Font







   .. method:: SetTextColour(self, colour)

      Sets a new text color.                  


      :param `colour`: 
      :type `colour`: Colour







   .. attribute:: BackgroundColour

      See :meth:`~ListItemAttr.GetBackgroundColour` and :meth:`~ListItemAttr.SetBackgroundColour`


   .. attribute:: Font

      See :meth:`~ListItemAttr.GetFont` and :meth:`~ListItemAttr.SetFont`


   .. attribute:: TextColour

      See :meth:`~ListItemAttr.GetTextColour` and :meth:`~ListItemAttr.SetTextColour`