wxCalendarDateAttr (wx v2.5.4)

Copy Markdown View Source

wxCalendarDateAttr is a custom attributes for a calendar date.

The objects of this class are used with wxCalendarCtrl.

See: wxCalendarCtrl

wxWidgets docs: wxCalendarDateAttr

Summary

Functions

Destroys the object

Returns the background colour set for the calendar date.

Returns the border set for the calendar date.

Returns the border colour set for the calendar date.

Returns the font set for the calendar date.

Returns the text colour set for the calendar date.

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

Returns true if a non-default (i.e. any) border is set.

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

Returns true if a non-default font is set.

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

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

Constructor for specifying all wxCalendarDateAttr properties.

Constructor using default properties except the given border.

Sets the text background colour to use.

Sets the border to use.

Sets the border colour to use.

Sets the font to use.

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

Sets the text (foreground) colour to use.

Types

wxCalendarDateAttr()

-type wxCalendarDateAttr() :: wx:wx_object().

Functions

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

Destroys the object

getBackgroundColour(This :: wxCalendarDateAttr()) -> wx:wx_colour4()

Returns the background colour set for the calendar date.

getBorder(This :: wxCalendarDateAttr()) -> wx:wx_enum()

Returns the border set for the calendar date.

getBorderColour(This :: wxCalendarDateAttr()) -> wx:wx_colour4()

Returns the border colour set for the calendar date.

getFont(This :: wxCalendarDateAttr()) -> wxFont:wxFont()

Returns the font set for the calendar date.

getTextColour(This :: wxCalendarDateAttr()) -> wx:wx_colour4()

Returns the text colour set for the calendar date.

hasBackgroundColour(This :: wxCalendarDateAttr()) -> boolean()

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

hasBorder(This :: wxCalendarDateAttr()) -> boolean()

Returns true if a non-default (i.e. any) border is set.

hasBorderColour(This :: wxCalendarDateAttr()) -> boolean()

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

hasFont(This :: wxCalendarDateAttr()) -> boolean()

Returns true if a non-default font is set.

hasTextColour(This :: wxCalendarDateAttr()) -> boolean()

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

isHoliday(This :: wxCalendarDateAttr()) -> boolean()

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

new() ≡ new([])

new/1

-spec new() -> wxCalendarDateAttr().
-spec 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 :: wx:wx_enum(), Options :: [Option]) -> Result

Types

Result = wxCalendarDateAttr()
Option = {colBorder, wx:wx_colour()}

Constructor using default properties except the given border.

setBackgroundColour(This, ColBack) -> ok

Types

This = wxCalendarDateAttr()
ColBack = wx:wx_colour()

Sets the text background colour to use.

setBorder(This :: wxCalendarDateAttr(), Border :: wx:wx_enum()) -> ok

Sets the border to use.

setBorderColour(This :: wxCalendarDateAttr(), Col :: wx:wx_colour()) -> ok

Sets the border colour to use.

setFont(This :: wxCalendarDateAttr(), Font :: wxFont:wxFont()) -> ok

Sets the font to use.

setHoliday(This :: wxCalendarDateAttr(), Holiday :: boolean()) -> ok

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

setTextColour(This :: wxCalendarDateAttr(), ColText :: wx:wx_colour()) -> ok

Sets the text (foreground) colour to use.