wxRuby Documentation Home

Wx::CalendarDateAttr

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

Derived from

No base class

Constants

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

enum CalendarDateBorder { CAL_BORDER_NONE, // no border (default) CAL_BORDER_SQUARE, // a rectangular border CAL_BORDER_ROUND // a round border }

See also

CalendarCtrl

Methods

CalendarDateAttr.new

CalendarDateAttr.new(%(arg-type)Colour% colText, Colour colBack = NullColour, Colour colBorder = NullColour, Font font = NullFont, CalendarDateBorder border = CAL_BORDER_NONE) CalendarDateAttr.new(%(arg-type)CalendarDateBorder% border, Colour colBorder = NullColour)

The constructors.

CalendarDateAttr#set_text_colour

set_text_colour(%(arg-type)Colour% colText)

Sets the text (foreground) colour to use.

CalendarDateAttr#set_background_colour

set_background_colour(%(arg-type)Colour% colBack)

Sets the text background colour to use.

CalendarDateAttr#set_border_colour

set_border_colour(%(arg-type)Colour% col)

Sets the border colour to use.

CalendarDateAttr#set_font

set_font(%(arg-type)Font% font)

Sets the font to use.

CalendarDateAttr#set_border

set_border(%(arg-type)CalendarDateBorder% border)

Sets the border kind

CalendarDateAttr#set_holiday

set_holiday(%(arg-type)Boolean% holiday)

Display the date with this attribute as a holiday.

CalendarDateAttr#has_text_colour

Boolean has_text_colour()

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

CalendarDateAttr#has_background_colour

Boolean has_background_colour()

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

CalendarDateAttr#has_border_colour

Boolean has_border_colour()

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

CalendarDateAttr#has_font

Boolean has_font()

Returns true if this attribute specifies a non default font.

CalendarDateAttr#has_border

Boolean has_border()

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

CalendarDateAttr#is_holiday

Boolean is_holiday()

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

CalendarDateAttr#get_text_colour

Colour get_text_colour()

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

CalendarDateAttr#get_background_colour

Colour get_background_colour()

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

CalendarDateAttr#get_border_colour

Colour get_border_colour()

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

CalendarDateAttr#get_font

Font get_font()

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

CalendarDateAttr#get_border

CalendarDateBorder get_border()

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

[This page automatically generated from the Textile source at 2023-06-03 08:07:42 +0000]