****************************
wx.calendar.CalendarDateAttr
****************************

Inheritance diagram for `wx.calendar.CalendarDateAttr`:

|

.. inheritance-diagram:: wx.calendar.CalendarDateAttr

|

Description
===========

`wx.calendar.CalendarDateAttr` is a custom attributes for a calendar date. 

The objects of this class are used with `wx.calendar.CalendarCtrl <wx.calendar.CalendarCtrl.html>`_.


.. seealso:: `wx.calendar.CalendarCtrl <wx.calendar.CalendarCtrl.html>`_


Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `GetBackgroundColour <#GetBackgroundColour>`_ 
* `GetBorder <#GetBorder>`_ 
* `GetBorderColour <#GetBorderColour>`_ 
* `GetFont <#GetFont>`_ 
* `GetTextColour <#GetTextColour>`_ 
* `HasBackgroundColour <#HasBackgroundColour>`_ 
* `HasBorder <#HasBorder>`_ 
* `HasBorderColour <#HasBorderColour>`_ 
* `HasFont <#HasFont>`_ 
* `HasTextColour <#HasTextColour>`_ 
* `IsHoliday <#IsHoliday>`_ 
* `SetBackgroundColour <#SetBackgroundColour>`_ 
* `SetBorder <#SetBorder>`_ 
* `SetBorderColour <#SetBorderColour>`_ 
* `SetFont <#SetFont>`_ 
* `SetHoliday <#SetHoliday>`_ 
* `SetTextColour <#SetTextColour>`_ 

Properties Summary
^^^^^^^^^^^^^^^^^^

* `BackgroundColour <#BackgroundColour>`_ 
* `Border <#Border>`_ 
* `BorderColour <#BorderColour>`_ 
* `Font <#Font>`_ 
* `TextColour <#TextColour>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(colText=wx.NullColour, colBack=wx.NullColour, colBorder=wx.NullColour, font=wx.NullFont, border=wx.calendar.CAL_BORDER_NONE)

   Create a `wx.calendar.CalendarDateAttr`.
   
   **Parameters:**

   * `colText` (`wx.Colour <../Widgets/wx.Colour.html>`_)
   * `colBack` (`wx.Colour <../Widgets/wx.Colour.html>`_)
   * `colBorder` (`wx.Colour <../Widgets/wx.Colour.html>`_)
   * `font` (`wx.Font <../Widgets/wx.Font.html>`_)
   * `border` (int)

   |

   **Returns:**

   `wx.calendar.CalendarDateAttr <wx.calendar.CalendarDateAttr.html>`_

--------

.. method:: GetBackgroundColour()

   Returns the background colour to use for the item with this attribute.

   |  

   **Returns:**

   `wx.Colour <../Widgets/wx.Colour.html>`_
 

--------

.. method:: GetBorder()

   Returns the border to use for the item with this attribute.

   The returns value is one of these flags:

   =================================  ================================
   Border Flag                        Description
   =================================  ================================
   ``wx.calendar.CAL_BORDER_NONE``    No border (default).
   ``wx.calendar.CAL_BORDER_SQUARE``  A rectangular border.
   ``wx.calendar.CAL_BORDER_ROUND``   A round border.
   =================================  ================================

   |  

   **Returns:**

   `int` 

--------

.. method:: GetBorderColour()

   Returns the border colour to use for the item with this attribute.

   |  

   **Returns:**

   `wx.Colour <../Widgets/wx.Colour.html>`_
 

--------

.. method:: GetFont()

   Returns the font to use for the item with this attribute.

   |  

   **Returns:**

   `wx.Font <../Widgets/wx.Font.html>`_
 

--------

.. method:: GetTextColour()

   Returns the text colour to use for the item with this attribute.

   |  

   **Returns:**

   `wx.Colour <../Widgets/wx.Colour.html>`_
 

--------

.. method:: HasBackgroundColour()

   Returns ``True`` if this attribute specifies a non-default text background colour.

   |  

   **Returns:**

   `bool` 

--------

.. method:: HasBorder()

   Returns ``True`` if this attribute specifies a non-default (i.e. any) border.

   |  

   **Returns:**

   `bool` 

--------

.. method:: HasBorderColour()

   Returns ``True`` if this attribute specifies a non-default border colour.

   |  

   **Returns:**

   `bool` 

--------

.. method:: HasFont()

   Returns ``True`` if this attribute specifies a non-default font.

   |  

   **Returns:**

   `bool` 

--------

.. method:: HasTextColour()

   Returns ``True`` if this item has a non-default text foreground colour.

   |  

   **Returns:**

   `bool` 

--------

.. method:: IsHoliday()

   Returns ``True`` if this attribute specifies that this item should be displayed as a holiday.

   |  

   **Returns:**

   `bool` 

--------

.. method:: SetBackgroundColour(colBack)

   Sets the text background colour to use.

   **Parameters:**

   * `colBack` (`wx.Colour <../Widgets/wx.Colour.html>`_) 

--------

.. method:: SetBorder(border)

   Sets the border kind, see `GetBorder <#GetBorder>`_ for the available border flags.

   **Parameters:**

   * `border` (int) 


.. seealso:: `GetBorder <#GetBorder>`_

--------

.. method:: SetBorderColour(col)

   Sets the border colour to use.

   **Parameters:**

   * `col` (`wx.Colour <../Widgets/wx.Colour.html>`_) 

--------

.. method:: SetFont(font)

   Sets the font to use.

   **Parameters:**

   * `font` (`wx.Font <../Widgets/wx.Font.html>`_) 

--------

.. method:: SetHoliday(holiday)

   Display the date with this attribute as a holiday.

   **Parameters:**

   * `holiday` (bool) 

--------

.. method:: SetTextColour(colText)

   Sets the text (foreground) colour to use.

   **Parameters:**

   * `colText` (`wx.Colour <../Widgets/wx.Colour.html>`_) 

--------

Properties
^^^^^^^^^^


.. attribute:: BackgroundColour

   See `GetBackgroundColour <#GetBackgroundColour>`_ and `SetBackgroundColour <#SetBackgroundColour>`_

.. attribute:: Border

   See `GetBorder <#GetBorder>`_ and `SetBorder <#SetBorder>`_

.. attribute:: BorderColour

   See `GetBorderColour <#GetBorderColour>`_ and `SetBorderColour <#SetBorderColour>`_

.. attribute:: Font

   See `GetFont <#GetFont>`_ and `SetFont <#SetFont>`_

.. attribute:: TextColour

   See `GetTextColour <#GetTextColour>`_ and `SetTextColour <#SetTextColour>`_