wxCalendarDateAttr

wxCalendarDateAttr is a custom attributes for a calendar date. The objects of this class are used with wxCalendarCtrl.

Derived from

No base class

Constants

Here are the possible kinds of borders which may be used to decorate a date:

enum wxCalendarDateBorder
{
    wxCAL_BORDER_NONE,          // no border (default)
    wxCAL_BORDER_SQUARE,        // a rectangular border
    wxCAL_BORDER_ROUND          // a round border
}

See also

wxCalendarCtrl

Include files

<wx/calctrl.h>

wxCalendarDateAttr::wxCalendarDateAttr

wxCalendarDateAttr(void)

wxCalendarDateAttr(const wxColour& colText, const wxColour& colBack = wxNullColour, const wxColour& colBorder = wxNullColour, const wxFont& font = wxNullFont, wxCalendarDateBorder border = wxCAL_BORDER_NONE)

wxCalendarDateAttr(wxCalendarDateBorder border, const wxColour& colBorder = wxNullColour)

The constructors.

wxCalendarDateAttr::SetTextColour

void SetTextColour(const wxColour& colText)

Sets the text (foreground) colour to use.

wxCalendarDateAttr::SetBackgroundColour

void SetBackgroundColour(const wxColour& colBack)

Sets the text background colour to use.

wxCalendarDateAttr::SetBorderColour

void SetBorderColour(const wxColour& col)

Sets the border colour to use.

wxCalendarDateAttr::SetFont

void SetFont(const wxFont& font)

Sets the font to use.

wxCalendarDateAttr::SetBorder

void SetBorder(wxCalendarDateBorder border)

Sets the border kind

wxCalendarDateAttr::SetHoliday

void SetHoliday(bool holiday)

Display the date with this attribute as a holiday.

wxCalendarDateAttr::HasTextColour

bool HasTextColour(void) const

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

wxCalendarDateAttr::HasBackgroundColour

bool HasBackgroundColour(void) const

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

wxCalendarDateAttr::HasBorderColour

bool HasBorderColour(void) const

Returns true if this attribute specifies a non default border colour.

wxCalendarDateAttr::HasFont

bool HasFont(void) const

Returns true if this attribute specifies a non default font.

wxCalendarDateAttr::HasBorder

bool HasBorder(void) const

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

wxCalendarDateAttr::IsHoliday

bool IsHoliday(void) const

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

wxCalendarDateAttr::GetTextColour

const wxColour& GetTextColour(void) const

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

wxCalendarDateAttr::GetBackgroundColour

const wxColour& GetBackgroundColour(void) const

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

wxCalendarDateAttr::GetBorderColour

const wxColour& GetBorderColour(void) const

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

wxCalendarDateAttr::GetFont

const wxFont& GetFont(void) const

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

wxCalendarDateAttr::GetBorder

wxCalendarDateBorder GetBorder(void) const

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