Class: Wx::ColourPickerEvent

Inherits:

CommandEvent

• Object
• Object
• Event
• CommandEvent
• Wx::ColourPickerEvent

Defined in:

lib/wx/doc/gen/colour_picker_event.rb

Overview

This event class is used for the events generated by ColourPickerCtrl.

Events using this class

The following event-handler methods redirect the events to member method or handler blocks for ColourPickerEvent events. Event handler methods:

• EvtHandler#evt_colourpicker_changed(id, meth = nil, &block): Generated whenever the selected colour changes.

• EvtHandler#evt_colourpicker_current_changed(id, meth = nil, &block): Generated whenever the currently selected colour in the dialog shown by the picker changes. This event is new since wxWidgets 3.1.3 and currently is only implemented in WXMSW.

• EvtHandler#evt_colourpicker_dialog_cancelled(id, meth = nil, &block): Generated when the user cancels the colour dialog associated with the control, i.e. closes it without accepting the selection. This event is new since wxWidgets 3.1.3 and currently is only implemented in WXMSW.

Category: Events

See Also:

• ColourPickerCtrl

Requires:

• USE_COLOURPICKERCTRL
• USE_COLOURDLG

Instance Method Summary

• #get_colour ⇒ Wx::Colour (also: #colour)

  Retrieve the colour the user has just selected.

• #initialize(*args) ⇒ ColourPickerEvent constructor

  A new instance of ColourPickerEvent.

• #set_colour(pos) ⇒ void (also: #colour=)

  Set the colour associated with the event.

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::ColourPickerEvent #initialize(generator, id, colour) ⇒ Wx::ColourPickerEvent

Returns a new instance of ColourPickerEvent.

Overloads:

• #initialize ⇒ Wx::ColourPickerEvent
• #initialize(generator, id, colour) ⇒ Wx::ColourPickerEvent

  The constructor is not normally used by the user code.

  Parameters:

  • generator (Wx::Object)
  • id (Integer)
  • colour (Wx::Colour, String, Symbol)

# File 'lib/wx/doc/gen/colour_picker_event.rb', line 61

def initialize(*args) end

Instance Method Details

#get_colour ⇒ Wx::Colour Also known as: colour

Retrieve the colour the user has just selected.

Returns:

• (Wx::Colour)

# File 'lib/wx/doc/gen/colour_picker_event.rb', line 65

def get_colour; end

#set_colour(pos) ⇒ void Also known as: colour=

This method returns an undefined value.

Set the colour associated with the event.

Parameters:

• pos (Wx::Colour, String, Symbol)

# File 'lib/wx/doc/gen/colour_picker_event.rb', line 71

def set_colour(pos) end