Class: Wx::CollapsiblePaneEvent

Inherits:

CommandEvent

• Object
• Object
• Event
• CommandEvent
• Wx::CollapsiblePaneEvent

Defined in:

lib/wx/doc/gen/collapsible_pane_event.rb

Overview

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

Events using this class

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

• EvtHandler#evt_collapsiblepane_changed(id, meth = nil, &block): The user expanded or collapsed the collapsible pane.

Category: Events

See Also:

• CollapsiblePane

Requires:

• USE_COLLPANE

Instance Method Summary

• #get_collapsed ⇒ Boolean (also: #collapsed)

  Returns true if the pane has been collapsed.

• #initialize(generator, id, collapsed) ⇒ Wx::CollapsiblePaneEvent constructor

  The constructor is not normally used by the user code.

• #set_collapsed(collapsed) ⇒ void (also: #collapsed=)

  Sets this as a collapsed pane event (if collapsed is true) or as an expanded pane event (if collapsed is false).

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(generator, id, collapsed) ⇒ Wx::CollapsiblePaneEvent

The constructor is not normally used by the user code.

Parameters:

• generator (Wx::Object)
• id (Integer)
• collapsed (Boolean)

# File 'lib/wx/doc/gen/collapsible_pane_event.rb', line 30

def initialize(generator, id, collapsed) end

Instance Method Details

#get_collapsed ⇒ Boolean Also known as: collapsed

Returns true if the pane has been collapsed.

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/collapsible_pane_event.rb', line 34

def get_collapsed; end

#set_collapsed(collapsed) ⇒ void Also known as: collapsed=

This method returns an undefined value.

Sets this as a collapsed pane event (if collapsed is true) or as an expanded pane event (if collapsed is false).

Parameters:

• collapsed (Boolean)

# File 'lib/wx/doc/gen/collapsible_pane_event.rb', line 40

def set_collapsed(collapsed) end