CalendarDateAttr

CalendarDateAttr is a custom attributes for a calendar date.

The objects of this class are used with CalendarCtrl.

See also

CalendarCtrl

Inheritance Diagram

Inheritance diagram for class CalendarDateAttr

Methods Summary

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

Properties Summary

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

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)

Methods

---

__init__(self, *args, **kw)

Overloaded Implementations:

---

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

Constructor for specifying all CalendarDateAttr properties.

Parameters:

• colText (Colour) –
• colBack (Colour) –
• colBorder (Colour) –
• font (Font) –
• border (CalendarDateBorder) –

---

__init__ (self, border, colBorder=NullColour)

Constructor using default properties except the given border.

Parameters:

• border (CalendarDateBorder) –
• colBorder (Colour) –

---

---

GetBackgroundColour(self)

Returns the background colour set for the calendar date.

Return type: Colour

---

GetBorder(self)

Returns the border set for the calendar date.

Return type:CalendarDateBorder

---

GetBorderColour(self)

Returns the border colour set for the calendar date.

Return type: Colour

---

GetFont(self)

Returns the font set for the calendar date.

Return type: Font

---

static GetMark()

Used (internally) by the generic CalendarCtrl.Mark .

Return type: CalendarDateAttr

---

GetTextColour(self)

Returns the text colour set for the calendar date.

Return type: Colour

---

HasBackgroundColour(self)

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

Return type:bool

---

HasBorder(self)

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

any) border is set.

Return type:bool

---

HasBorderColour(self)

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

Return type:bool

---

HasFont(self)

Returns True if a non-default font is set.

Return type:bool

---

HasTextColour(self)

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

Return type:bool

---

IsHoliday(self)

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

Return type:bool

---

SetBackgroundColour(self, colBack)

Sets the text background colour to use.

Parameters:colBack (Colour) –

---

SetBorder(self, border)

Sets the border to use.

Parameters:border (CalendarDateBorder) –

---

SetBorderColour(self, col)

Sets the border colour to use.

Parameters:col (Colour) –

---

SetFont(self, font)

Sets the font to use.

Parameters:font (Font) –

---

SetHoliday(self, holiday)

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

Parameters:holiday (bool) –

---

static SetMark(m)

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

Parameters:m (adv.CalendarDateAttr) –

---

SetTextColour(self, colText)

Sets the text (foreground) colour to use.

Parameters:colText (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