Class: Wx::CalendarEvent

Inherits:

DateEvent

• Object
• Object
• Event
• CommandEvent
• DateEvent
• Wx::CalendarEvent

Defined in:

lib/wx/doc/gen/calendar_event.rb

Overview

The CalendarEvent class is used together with CalendarCtrl.

Category: Events

See Also:

• CalendarCtrl

Requires:

• USE_CALENDARCTRL

Instance Method Summary

• #get_week_day ⇒ Integer (also: #week_day)

  Returns the week day on which the user clicked in EVT_CALENDAR_WEEKDAY_CLICKED handler.

• #initialize(*args) ⇒ CalendarEvent constructor

  A new instance of CalendarEvent.

Methods inherited from DateEvent

#get_date, #set_date

Methods inherited from CommandEvent

#client_data, #client_data=, #get_client_data, #get_client_object, #get_int, #get_selection, #get_string, #is_checked, #is_selection, #set_client_data, #set_client_object, #set_extra_long, #set_int, #set_string

Methods inherited from Event

#clone, #get_event_category, #get_event_object, #get_event_type, #get_id, #get_skipped, #get_timestamp, #is_command_event, #resume_propagation, #set_event_object, #set_event_type, #set_id, #set_timestamp, #should_propagate, #skip, #stop_propagation

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize ⇒ Wx::CalendarEvent #initialize(win, dt, type) ⇒ Wx::CalendarEvent

Returns a new instance of CalendarEvent.

Overloads:

• #initialize ⇒ Wx::CalendarEvent
• #initialize(win, dt, type) ⇒ Wx::CalendarEvent

  Parameters:

  • win (Wx::Window)
  • dt (Time, Date, DateTime)
  • type (Wx::GenericCollapsiblePane::EventType)

# File 'lib/wx/doc/gen/calendar_event.rb', line 135

def initialize(*args) end

Instance Method Details

#get_week_day ⇒ Integer Also known as: week_day

Returns the week day on which the user clicked in EVT_CALENDAR_WEEKDAY_CLICKED handler.

It doesn’t make sense to call this function in other handlers.

Returns:

• (Integer)

# File 'lib/wx/doc/gen/calendar_event.rb', line 141

def get_week_day; end