wxCalendarDateAttr(3)

NAME
wxCalendarDateAttr - wxCalendarDateAttr is a custom attributes for a calendar date.

DESCRIPTION

The objects of this class are used with wxCalendarCtrl.

See: wxCalendarCtrl

wxWidgets docs: wxCalendarDateAttr

DATA TYPES

wxCalendarDateAttr() :: wx:wx_object().

FUNCTIONS

destroy(This :: wxCalendarDateAttr()) -> ok.

    Destroys the object
getBackgroundColour(This) -> wx:wx_colour4() when This :: wxCalendarDateAttr().

    Returns the background colour set for the calendar date.
getBorder(This) -> wx:wx_enum() when This :: wxCalendarDateAttr().

    Returns the border set for the calendar date.
getBorderColour(This) -> wx:wx_colour4() when This :: wxCalendarDateAttr().

    Returns the border colour set for the calendar date.
getFont(This) -> wxFont:wxFont() when This :: wxCalendarDateAttr().

    Returns the font set for the calendar date.
getTextColour(This) -> wx:wx_colour4() when This :: wxCalendarDateAttr().

    Returns the text colour set for the calendar date.
hasBackgroundColour(This) -> boolean() when This :: wxCalendarDateAttr().

    Returns true if a non-default text background colour is set.
hasBorder(This) -> boolean() when This :: wxCalendarDateAttr().

    Returns true if a non-default (i.e. any) border is set.
hasBorderColour(This) -> boolean() when This :: wxCalendarDateAttr().

    Returns true if a non-default border colour is set.
hasFont(This) -> boolean() when This :: wxCalendarDateAttr().

    Returns true if a non-default font is set.
hasTextColour(This) -> boolean() when This :: wxCalendarDateAttr().

    Returns true if a non-default text foreground colour is set.
isHoliday(This) -> boolean() when This :: wxCalendarDateAttr().

    Returns true if this calendar day is displayed as a holiday.
new(Border) -> wxCalendarDateAttr() when Border :: wx:wx_enum(); ([Option]) -> wxCalendarDateAttr() when Option :: {colText, wx:wx_colour()} | {colBack, wx:wx_colour()} | {colBorder, wx:wx_colour()} | {font, wxFont:wxFont()} | {border, wx:wx_enum()}.

    Constructor for specifying all wxCalendarDateAttr properties.
new(Border, [Option]) -> wxCalendarDateAttr() when Border :: wx:wx_enum(), Option :: {colBorder, wx:wx_colour()}.

    Constructor using default properties except the given border.
setBackgroundColour(This, ColBack) -> ok when This :: wxCalendarDateAttr(), ColBack :: wx:wx_colour().

    Sets the text background colour to use.
setBorder(This, Border) -> ok when This :: wxCalendarDateAttr(), Border :: wx:wx_enum().

    Sets the border to use.
setBorderColour(This, Col) -> ok when This :: wxCalendarDateAttr(), Col :: wx:wx_colour().

    Sets the border colour to use.
setFont(This, Font) -> ok when This :: wxCalendarDateAttr(), Font :: wxFont:wxFont().

    Sets the font to use.
setHoliday(This, Holiday) -> ok when This :: wxCalendarDateAttr(), Holiday :: boolean().

    If holiday is true, this calendar day will be displayed as a holiday.
setTextColour(This, ColText) -> ok when This :: wxCalendarDateAttr(), ColText :: wx:wx_colour().

    Sets the text (foreground) colour to use.