.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.adv.CalendarDateAttr:
==========================================================================================================================================
|phoenix_title| **wx.adv.CalendarDateAttr**
==========================================================================================================================================
:ref:`wx.adv.CalendarDateAttr` is a custom attributes for a calendar date.
The objects of this class are used with :ref:`wx.adv.CalendarCtrl`.
.. seealso:: :ref:`wx.adv.CalendarCtrl`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
CalendarDateAttr:
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.adv.CalendarDateAttr.__init__` Constructor for specifying all :ref:`wx.adv.CalendarDateAttr` properties.
:meth:`~wx.adv.CalendarDateAttr.GetBackgroundColour` Returns the background colour set for the calendar date.
:meth:`~wx.adv.CalendarDateAttr.GetBorder` Returns the border set for the calendar date.
:meth:`~wx.adv.CalendarDateAttr.GetBorderColour` Returns the border colour set for the calendar date.
:meth:`~wx.adv.CalendarDateAttr.GetFont` Returns the font set for the calendar date.
:meth:`~wx.adv.CalendarDateAttr.GetMark` Used (internally) by the generic :meth:`wx.adv.CalendarCtrl.Mark` .
:meth:`~wx.adv.CalendarDateAttr.GetTextColour` Returns the text colour set for the calendar date.
:meth:`~wx.adv.CalendarDateAttr.HasBackgroundColour` Returns ``True`` if a non-default text background colour is set.
:meth:`~wx.adv.CalendarDateAttr.HasBorder` Returns ``True`` if a non-default (i.e. any) border is set.
:meth:`~wx.adv.CalendarDateAttr.HasBorderColour` Returns ``True`` if a non-default border colour is set.
:meth:`~wx.adv.CalendarDateAttr.HasFont` Returns ``True`` if a non-default font is set.
:meth:`~wx.adv.CalendarDateAttr.HasTextColour` Returns ``True`` if a non-default text foreground colour is set.
:meth:`~wx.adv.CalendarDateAttr.IsHoliday` Returns ``True`` if this calendar day is displayed as a holiday.
:meth:`~wx.adv.CalendarDateAttr.SetBackgroundColour` Sets the text background colour to use.
:meth:`~wx.adv.CalendarDateAttr.SetBorder` Sets the border to use.
:meth:`~wx.adv.CalendarDateAttr.SetBorderColour` Sets the border colour to use.
:meth:`~wx.adv.CalendarDateAttr.SetFont` Sets the font to use.
:meth:`~wx.adv.CalendarDateAttr.SetHoliday` If `holiday` is ``True``, this calendar day will be displayed as a holiday.
:meth:`~wx.adv.CalendarDateAttr.SetMark` Set the attributes that will be used to Mark() days on the generic :ref:`wx.adv.CalendarCtrl`.
:meth:`~wx.adv.CalendarDateAttr.SetTextColour` Sets the text (foreground) colour to use.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.adv.CalendarDateAttr.BackgroundColour` See :meth:`~wx.adv.CalendarDateAttr.GetBackgroundColour` and :meth:`~wx.adv.CalendarDateAttr.SetBackgroundColour`
:attr:`~wx.adv.CalendarDateAttr.Border` See :meth:`~wx.adv.CalendarDateAttr.GetBorder` and :meth:`~wx.adv.CalendarDateAttr.SetBorder`
:attr:`~wx.adv.CalendarDateAttr.BorderColour` See :meth:`~wx.adv.CalendarDateAttr.GetBorderColour` and :meth:`~wx.adv.CalendarDateAttr.SetBorderColour`
:attr:`~wx.adv.CalendarDateAttr.Font` See :meth:`~wx.adv.CalendarDateAttr.GetFont` and :meth:`~wx.adv.CalendarDateAttr.SetFont`
:attr:`~wx.adv.CalendarDateAttr.TextColour` See :meth:`~wx.adv.CalendarDateAttr.GetTextColour` and :meth:`~wx.adv.CalendarDateAttr.SetTextColour`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.adv.CalendarDateAttr(object)
**Possible constructors**::
CalendarDateAttr(colText: Colour=NullColour, colBack: Colour=NullColour,
colBorder: Colour=NullColour, font: Font=NullFont, border:
CalendarDateBorder=CAL_BORDER_NONE) -> None
CalendarDateAttr(border : CalendarDateBorder, colBorder:
Colour=NullColour) -> None
CalendarDateAttr is a custom attributes for a calendar date.
.. method:: __init__(self, *args, **kw)
|overload| **Overloaded Implementations:**
:html:`
`
**__init__** `(self, colText: Colour=NullColour, colBack: Colour=NullColour, colBorder: Colour=NullColour, font: Font=NullFont, border: CalendarDateBorder=CAL_BORDER_NONE)`
Constructor for specifying all :ref:`wx.adv.CalendarDateAttr` properties.
:param `colText`:
:type `colText`: wx.Colour
:param `colBack`:
:type `colBack`: wx.Colour
:param `colBorder`:
:type `colBorder`: wx.Colour
:param `font`:
:type `font`: wx.Font
:param `border`:
:type `border`: wx.adv.CalendarDateBorder
:rtype: `None`
:html:`
`
**__init__** `(self, border : CalendarDateBorder, colBorder: Colour=NullColour)`
Constructor using default properties except the given border.
:param `border`:
:type `border`: wx.adv.CalendarDateBorder
:param `colBorder`:
:type `colBorder`: wx.Colour
:rtype: `None`
:html:`
`
.. method:: GetBackgroundColour(self)
Returns the background colour set for the calendar date.
:rtype: `Colour`
.. method:: GetBorder(self)
Returns the border set for the calendar date.
:rtype: :ref:`wx.adv.CalendarDateBorder`
.. method:: GetBorderColour(self)
Returns the border colour set for the calendar date.
:rtype: `Colour`
.. method:: GetFont(self)
Returns the font set for the calendar date.
:rtype: `Font`
.. staticmethod:: GetMark()
Used (internally) by the generic :meth:`wx.adv.CalendarCtrl.Mark` .
:rtype: :ref:`wx.adv.CalendarDateAttr`
.. method:: GetTextColour(self)
Returns the text colour set for the calendar date.
:rtype: `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 : Colour)
Sets the text background colour to use.
:param `colBack`:
:type `colBack`: wx.Colour
:rtype: `None`
.. method:: SetBorder(self, border : CalendarDateBorder)
Sets the border to use.
:param `border`:
:type `border`: wx.adv.CalendarDateBorder
:rtype: `None`
.. method:: SetBorderColour(self, col : Colour)
Sets the border colour to use.
:param `col`:
:type `col`: wx.Colour
:rtype: `None`
.. method:: SetFont(self, font : Font)
Sets the font to use.
:param `font`:
:type `font`: wx.Font
:rtype: `None`
.. method:: SetHoliday(self, holiday : bool)
If `holiday` is ``True``, this calendar day will be displayed as a holiday.
:param `holiday`:
:type `holiday`: bool
:rtype: `None`
.. staticmethod:: SetMark(m : CalendarDateAttr)
Set the attributes that will be used to Mark() days on the generic :ref:`wx.adv.CalendarCtrl`.
:param `m`:
:type `m`: wx.adv.CalendarDateAttr
:rtype: `None`
.. method:: SetTextColour(self, colText : Colour)
Sets the text (foreground) colour to use.
:param `colText`:
:type `colText`: wx.Colour
:rtype: `None`
.. attribute:: BackgroundColour
See :meth:`~wx.adv.CalendarDateAttr.GetBackgroundColour` and :meth:`~wx.adv.CalendarDateAttr.SetBackgroundColour`
.. attribute:: Border
See :meth:`~wx.adv.CalendarDateAttr.GetBorder` and :meth:`~wx.adv.CalendarDateAttr.SetBorder`
.. attribute:: BorderColour
See :meth:`~wx.adv.CalendarDateAttr.GetBorderColour` and :meth:`~wx.adv.CalendarDateAttr.SetBorderColour`
.. attribute:: Font
See :meth:`~wx.adv.CalendarDateAttr.GetFont` and :meth:`~wx.adv.CalendarDateAttr.SetFont`
.. attribute:: TextColour
See :meth:`~wx.adv.CalendarDateAttr.GetTextColour` and :meth:`~wx.adv.CalendarDateAttr.SetTextColour`