.. include:: headings.inc



.. currentmodule:: adv



.. _adv.CalendarDateAttr:

==========================================================================================================================================
|phoenix_title|  **CalendarDateAttr**
==========================================================================================================================================

:ref:`adv.CalendarDateAttr`  is a custom attributes for a calendar date.          

The objects of this class are used with :ref:`adv.CalendarCtrl`. 







         



.. seealso:: :ref:`adv.CalendarCtrl`    







|

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

Inheritance diagram for class **CalendarDateAttr**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/adv.CalendarDateAttr_inheritance.png" alt="Inheritance diagram of CalendarDateAttr" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="adv.CalendarDateAttr.html" title="adv.CalendarDateAttr  is a custom attributes for a calendar date." alt="" coords="7,5,127,35"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~CalendarDateAttr.__init__`                                               Constructor for specifying all :ref:`adv.CalendarDateAttr`  properties.
:meth:`~CalendarDateAttr.GetBackgroundColour`                                    Returns the background colour set for the calendar date.
:meth:`~CalendarDateAttr.GetBorder`                                              Returns the border set for the calendar date.
:meth:`~CalendarDateAttr.GetBorderColour`                                        Returns the border colour set for the calendar date.
:meth:`~CalendarDateAttr.GetFont`                                                Returns the font set for the calendar date.
:meth:`~CalendarDateAttr.GetMark`                                                Used (internally) by the generic :meth:`CalendarCtrl.Mark` .
:meth:`~CalendarDateAttr.GetTextColour`                                          Returns the text colour set for the calendar date.
:meth:`~CalendarDateAttr.HasBackgroundColour`                                    Returns ``True`` if a non-default text background colour is set.
:meth:`~CalendarDateAttr.HasBorder`                                              Returns ``True`` if a non-default (i.e.
:meth:`~CalendarDateAttr.HasBorderColour`                                        Returns ``True`` if a non-default border colour is set.
:meth:`~CalendarDateAttr.HasFont`                                                Returns ``True`` if a non-default font is set.
:meth:`~CalendarDateAttr.HasTextColour`                                          Returns ``True`` if a non-default text foreground colour is set.
:meth:`~CalendarDateAttr.IsHoliday`                                              Returns ``True`` if this calendar day is displayed as a holiday.
:meth:`~CalendarDateAttr.SetBackgroundColour`                                    Sets the text background colour to use.
:meth:`~CalendarDateAttr.SetBorder`                                              Sets the border to use.
:meth:`~CalendarDateAttr.SetBorderColour`                                        Sets the border colour to use.
:meth:`~CalendarDateAttr.SetFont`                                                Sets the font to use.
:meth:`~CalendarDateAttr.SetHoliday`                                             If `holiday`  is ``True``, this calendar day will be displayed as a holiday.
:meth:`~CalendarDateAttr.SetMark`                                                Set the attributes that will be used to Mark() days on the generic :ref:`adv.CalendarCtrl`.
:meth:`~CalendarDateAttr.SetTextColour`                                          Sets the text (foreground) colour to use.
================================================================================ ================================================================================


|


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

================================================================================ ================================================================================
:attr:`~CalendarDateAttr.BackgroundColour`                                       See :meth:`~CalendarDateAttr.GetBackgroundColour` and :meth:`~CalendarDateAttr.SetBackgroundColour`
:attr:`~CalendarDateAttr.Border`                                                 See :meth:`~CalendarDateAttr.GetBorder` and :meth:`~CalendarDateAttr.SetBorder`
:attr:`~CalendarDateAttr.BorderColour`                                           See :meth:`~CalendarDateAttr.GetBorderColour` and :meth:`~CalendarDateAttr.SetBorderColour`
:attr:`~CalendarDateAttr.Font`                                                   See :meth:`~CalendarDateAttr.GetFont` and :meth:`~CalendarDateAttr.SetFont`
:attr:`~CalendarDateAttr.TextColour`                                             See :meth:`~CalendarDateAttr.GetTextColour` and :meth:`~CalendarDateAttr.SetTextColour`
================================================================================ ================================================================================


|


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

.. class:: CalendarDateAttr(object)

   CalendarDateAttr is a custom attributes for a calendar date.
   
   **Possible constructors**::

       CalendarDateAttr(colText=NullColour, colBack=NullColour,
                        colBorder=NullColour, font=NullFont, border=CAL_BORDER_NONE)
       
       CalendarDateAttr(border, colBorder=NullColour)
       



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



      |overload| **Overloaded Implementations**:

      **~~~**

      
      **__init__** `(self, colText=NullColour, colBack=NullColour, colBorder=NullColour, font=NullFont, border=CAL_BORDER_NONE)`
      
      Constructor for specifying all :ref:`adv.CalendarDateAttr`  properties.                  
      
      
      :param `colText`: 
      :type `colText`: Colour
      :param `colBack`: 
      :type `colBack`: Colour
      :param `colBorder`: 
      :type `colBorder`: Colour
      :param `font`: 
      :type `font`: Font
      :param `border`: 
      :type `border`: CalendarDateBorder
      
      
      
      
      
      
      **~~~**

      
      **__init__** `(self, border, colBorder=NullColour)`
      
      Constructor using default properties except the given border.                  
      
      
      :param `border`: 
      :type `border`: CalendarDateBorder
      :param `colBorder`: 
      :type `colBorder`: Colour
      
      
      
      
      
      
      **~~~**






   .. method:: GetBackgroundColour(self)

      Returns the background colour set for the calendar date.                  

      :rtype: :ref:`Colour`








   .. method:: GetBorder(self)

      Returns the border set for the calendar date.                  

      :rtype: `CalendarDateBorder`








   .. method:: GetBorderColour(self)

      Returns the border colour set for the calendar date.                  

      :rtype: :ref:`Colour`








   .. method:: GetFont(self)

      Returns the font set for the calendar date.                  

      :rtype: :ref:`Font`








   .. staticmethod:: GetMark()

      Used (internally) by the generic :meth:`CalendarCtrl.Mark` .                  

      :rtype: :ref:`adv.CalendarDateAttr`








   .. method:: GetTextColour(self)

      Returns the text colour set for the calendar date.                  

      :rtype: :ref:`Colour`








   .. method:: HasBackgroundColour(self)

      Returns ``True`` if a non-default text background colour is set.                  

      :rtype: `bool`








   .. method:: HasBorder(self)

      Returns ``True`` if a non-default (i.e.                  

      any) border is set.                  

      :rtype: `bool`








   .. method:: HasBorderColour(self)

      Returns ``True`` if a non-default border colour is set.                  

      :rtype: `bool`








   .. method:: HasFont(self)

      Returns ``True`` if a non-default font is set.                  

      :rtype: `bool`








   .. method:: HasTextColour(self)

      Returns ``True`` if a non-default text foreground colour is set.                  

      :rtype: `bool`








   .. method:: IsHoliday(self)

      Returns ``True`` if this calendar day is displayed as a holiday.                  

      :rtype: `bool`








   .. method:: SetBackgroundColour(self, colBack)

      Sets the text background colour to use.                  


      :param `colBack`: 
      :type `colBack`: Colour







   .. method:: SetBorder(self, border)

      Sets the border to use.                  


      :param `border`: 
      :type `border`: CalendarDateBorder







   .. method:: SetBorderColour(self, col)

      Sets the border colour to use.                  


      :param `col`: 
      :type `col`: Colour







   .. method:: SetFont(self, font)

      Sets the font to use.                  


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







   .. method:: SetHoliday(self, holiday)

      If `holiday`  is ``True``, this calendar day will be displayed as a holiday.                  


      :param `holiday`: 
      :type `holiday`: bool







   .. staticmethod:: SetMark(m)

      Set the attributes that will be used to Mark() days on the generic :ref:`adv.CalendarCtrl`.                  


      :param `m`: 
      :type `m`: adv.CalendarDateAttr







   .. method:: SetTextColour(self, colText)

      Sets the text (foreground) colour to use.                  


      :param `colText`: 
      :type `colText`: Colour







   .. attribute:: BackgroundColour

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


   .. attribute:: Border

      See :meth:`~CalendarDateAttr.GetBorder` and :meth:`~CalendarDateAttr.SetBorder`


   .. attribute:: BorderColour

      See :meth:`~CalendarDateAttr.GetBorderColour` and :meth:`~CalendarDateAttr.SetBorderColour`


   .. attribute:: Font

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


   .. attribute:: TextColour

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