wx.calendar.CalendarDateAttr

Inheritance diagram for 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.

See also

wx.calendar.CalendarCtrl

Methods Summary

• __init__
• GetBackgroundColour
• GetBorder
• GetBorderColour
• GetFont
• GetTextColour
• HasBackgroundColour
• HasBorder
• HasBorderColour
• HasFont
• HasTextColour
• IsHoliday
• SetBackgroundColour
• SetBorder
• SetBorderColour
• SetFont
• SetHoliday
• SetTextColour

Properties Summary

• BackgroundColour
• Border
• BorderColour
• Font
• TextColour

Class API

Methods

__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)
• colBack (wx.Colour)
• colBorder (wx.Colour)
• font (wx.Font)
• border (int)

Returns:

wx.calendar.CalendarDateAttr

---

GetBackgroundColour()

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

Returns:

wx.Colour

---

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

---

GetBorderColour()

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

Returns:

wx.Colour

---

GetFont()

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

Returns:

wx.Font

---

GetTextColour()

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

Returns:

wx.Colour

---

HasBackgroundColour()

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

Returns:

bool

---

HasBorder()

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

Returns:

bool

---

HasBorderColour()

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

Returns:

bool

---

HasFont()

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

Returns:

bool

---

HasTextColour()

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

Returns:

bool

---

IsHoliday()

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

Returns:

bool

---

SetBackgroundColour(colBack)

Sets the text background colour to use.

Parameters:

• colBack (wx.Colour)

---

SetBorder(border)

Sets the border kind, see GetBorder for the available border flags.

Parameters:

• border (int)

See also

GetBorder

---

SetBorderColour(col)

Sets the border colour to use.

Parameters:

• col (wx.Colour)

---

SetFont(font)

Sets the font to use.

Parameters:

• font (wx.Font)

---

SetHoliday(holiday)

Display the date with this attribute as a holiday.

Parameters:

• holiday (bool)

---

SetTextColour(colText)

Sets the text (foreground) colour to use.

Parameters:

• colText (wx.Colour)

---

Properties

BackgroundColour

See GetBackgroundColour and SetBackgroundColour

Border

See GetBorder and SetBorder

BorderColour

See GetBorderColour and SetBorderColour

Font

See GetFont and SetFont

TextColour

See GetTextColour and SetTextColour