Phoenix Logo

phoenix_title wx.adv.CalendarDateAttr

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

The objects of this class are used with wx.adv.CalendarCtrl.


class_hierarchy Class Hierarchy

Inheritance diagram for class CalendarDateAttr:


method_summary Methods Summary

__init__ Constructor for specifying all wx.adv.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 wx.adv.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. any) border is set.
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 wx.adv.CalendarCtrl.
SetTextColour Sets the text (foreground) colour to use.

api Class API



class wx.adv.CalendarDateAttr(object)

Possible constructors:

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

CalendarDateAttr(border, colBorder=NullColour)

CalendarDateAttr is a custom attributes for a calendar date.


Methods



__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 wx.adv.CalendarDateAttr properties.

Parameters:



__init__ (self, border, colBorder=NullColour)

Constructor using default properties except the given border.

Parameters:





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: wx.adv.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 wx.adv.CalendarCtrl.Mark .

Return type: wx.adv.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 (wx.Colour) –


SetBorder(self, border)

Sets the border to use.

Parameters:border (CalendarDateBorder) –


SetBorderColour(self, col)

Sets the border colour to use.

Parameters:col (wx.Colour) –


SetFont(self, font)

Sets the font to use.

Parameters:font (wx.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 wx.adv.CalendarCtrl.

Parameters:m (wx.adv.CalendarDateAttr) –


SetTextColour(self, 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