Class: Wx::CalendarDateAttr

Inherits:
Object
  • Object
show all
Defined in:
lib/wx/doc/gen/calendar_date_attr.rb

Overview

CalendarDateAttr is a custom attributes for a calendar date.

The objects of this class are used with CalendarCtrl.

Category: Data Structures

See Also:

Requires:

  • USE_CALENDARCTRL

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(colText = Wx::NULL_COLOUR, colBack = Wx::NULL_COLOUR, colBorder = Wx::NULL_COLOUR, font = Wx::NULL_FONT, border = Wx::CalendarDateBorder::CAL_BORDER_NONE) ⇒ Wx::CalendarDateAttr #initialize(border, colBorder = Wx::NULL_COLOUR) ⇒ Wx::CalendarDateAttr

Returns a new instance of CalendarDateAttr.

Overloads:

  • #initialize(colText = Wx::NULL_COLOUR, colBack = Wx::NULL_COLOUR, colBorder = Wx::NULL_COLOUR, font = Wx::NULL_FONT, border = Wx::CalendarDateBorder::CAL_BORDER_NONE) ⇒ Wx::CalendarDateAttr

    Constructor for specifying all Wx::CalendarDateAttr properties.

    Parameters:

  • #initialize(border, colBorder = Wx::NULL_COLOUR) ⇒ Wx::CalendarDateAttr

    Constructor using default properties except the given border.

    Parameters:



33
 
# File 'lib/wx/doc/gen/calendar_date_attr.rb', line 33

def initialize(*args) end

Class Method Details

.get_mark ⇒ Wx::CalendarDateAttr

Used (internally) by the generic Wx::CalendarCtrl#mark.

Returns:



128
 
# File 'lib/wx/doc/gen/calendar_date_attr.rb', line 128

def self.get_mark; end

.set_mark(m) ⇒ void

This method returns an undefined value.

Set the attributes that will be used to Mark() days on the generic Wx::CalendarCtrl.

Parameters:



133
 
# File 'lib/wx/doc/gen/calendar_date_attr.rb', line 133

def self.set_mark(m) end

Instance Method Details

#get_background_colour ⇒ Wx::Colour, ... Also known as: background_colour

Returns the background colour set for the calendar date.

Returns:



37
 
# File 'lib/wx/doc/gen/calendar_date_attr.rb', line 37

def get_background_colour; end

#get_border ⇒ Wx::CalendarDateBorder Also known as: border

Returns the border set for the calendar date.

Returns:



42
 
# File 'lib/wx/doc/gen/calendar_date_attr.rb', line 42

def get_border; end

#get_border_colour ⇒ Wx::Colour, ... Also known as: border_colour

Returns the border colour set for the calendar date.

Returns:



47
 
# File 'lib/wx/doc/gen/calendar_date_attr.rb', line 47

def get_border_colour; end

#get_font ⇒ Wx::Font, Wx::FontInfo Also known as: font

Returns the font set for the calendar date.

Returns:



52
 
# File 'lib/wx/doc/gen/calendar_date_attr.rb', line 52

def get_font; end

#get_text_colour ⇒ Wx::Colour, ... Also known as: text_colour

Returns the text colour set for the calendar date.

Returns:



57
 
# File 'lib/wx/doc/gen/calendar_date_attr.rb', line 57

def get_text_colour; end

#has_background_colour ⇒ Boolean Also known as: has_background_colour?

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

Returns:

  • (Boolean) 


62
 
# File 'lib/wx/doc/gen/calendar_date_attr.rb', line 62

def has_background_colour; end

#has_border ⇒ Boolean Also known as: has_border?

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

Returns:

  • (Boolean) 


67
 
# File 'lib/wx/doc/gen/calendar_date_attr.rb', line 67

def has_border; end

#has_border_colour ⇒ Boolean Also known as: has_border_colour?

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

Returns:

  • (Boolean) 


72
 
# File 'lib/wx/doc/gen/calendar_date_attr.rb', line 72

def has_border_colour; end

#has_font ⇒ Boolean Also known as: has_font?

Returns true if a non-default font is set.

Returns:

  • (Boolean) 


77
 
# File 'lib/wx/doc/gen/calendar_date_attr.rb', line 77

def has_font; end

#has_text_colour ⇒ Boolean Also known as: has_text_colour?

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

Returns:

  • (Boolean) 


82
 
# File 'lib/wx/doc/gen/calendar_date_attr.rb', line 82

def has_text_colour; end

#is_holiday ⇒ Boolean Also known as: holiday?

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

Returns:

  • (Boolean) 


87
 
# File 'lib/wx/doc/gen/calendar_date_attr.rb', line 87

def is_holiday; end

#set_background_colour(colBack) ⇒ void Also known as: background_colour=

This method returns an undefined value.

Sets the text background colour to use.

Parameters:



93
 
# File 'lib/wx/doc/gen/calendar_date_attr.rb', line 93

def set_background_colour(colBack) end

#set_border(border) ⇒ void Also known as: border=

This method returns an undefined value.

Sets the border to use.

Parameters:



99
 
# File 'lib/wx/doc/gen/calendar_date_attr.rb', line 99

def set_border(border) end

#set_border_colour(col) ⇒ void Also known as: border_colour=

This method returns an undefined value.

Sets the border colour to use.

Parameters:



105
 
# File 'lib/wx/doc/gen/calendar_date_attr.rb', line 105

def set_border_colour(col) end

#set_font(font) ⇒ void Also known as: font=

This method returns an undefined value.

Sets the font to use.

Parameters:



111
 
# File 'lib/wx/doc/gen/calendar_date_attr.rb', line 111

def set_font(font) end

#set_holiday(holiday) ⇒ void Also known as: holiday=

This method returns an undefined value.

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

Parameters:

  • holiday (Boolean) 


117
 
# File 'lib/wx/doc/gen/calendar_date_attr.rb', line 117

def set_holiday(holiday) end

#set_text_colour(colText) ⇒ void Also known as: text_colour=

This method returns an undefined value.

Sets the text (foreground) colour to use.

Parameters:



123
 
# File 'lib/wx/doc/gen/calendar_date_attr.rb', line 123

def set_text_colour(colText) end