Class: Wx::FindDialogEvent

Inherits:

CommandEvent

• Object
• Object
• Event
• CommandEvent
• Wx::FindDialogEvent

Defined in:

lib/wx/doc/gen/find_dialog_event.rb

Overview

FindReplaceDialog events.

Events using this class

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

• EvtHandler#evt_find(id, meth = nil, &block): Find button was pressed in the dialog.

• EvtHandler#evt_find_next(id, meth = nil, &block): Find next button was pressed in the dialog.

• EvtHandler#evt_find_replace(id, meth = nil, &block): Replace button was pressed in the dialog.

• EvtHandler#evt_find_replace_all(id, meth = nil, &block): Replace all button was pressed in the dialog.

• EvtHandler#evt_find_close(id, meth = nil, &block): The dialog is being destroyed, any pointers to it cannot be used any longer.

Category: Events

Requires:

• USE_FINDREPLDLG

Instance Method Summary

• #get_dialog ⇒ Wx::FindReplaceDialog (also: #dialog)

  Return the pointer to the dialog which generated this event.

• #get_find_string ⇒ String (also: #find_string)

  Return the string to find (never empty).

• #get_flags ⇒ Integer (also: #flags)

  Get the currently selected flags: this is the combination of the FindReplaceFlags enumeration values.

• #get_replace_string ⇒ Wx::String (also: #replace_string)

  Return the string to replace the search string with (only for replace and replace all events).

• #initialize(commandType = Wx::EVT_NULL, id = 0) ⇒ Wx::FindDialogEvent constructor

  Constructor used by wxWidgets only.

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(commandType = Wx::EVT_NULL, id = 0) ⇒ Wx::FindDialogEvent

Constructor used by wxWidgets only.

Parameters:

• commandType (Wx::GenericCollapsiblePane::EventType) (defaults to: Wx::EVT_NULL)
• id (Integer) (defaults to: 0)

# File 'lib/wx/doc/gen/find_dialog_event.rb', line 101

def initialize(commandType=Wx::EVT_NULL, id=0) end

Instance Method Details

#get_dialog ⇒ Wx::FindReplaceDialog Also known as: dialog

Return the pointer to the dialog which generated this event.

Returns:

• (Wx::FindReplaceDialog)

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

def get_dialog; end

#get_find_string ⇒ String Also known as: find_string

Return the string to find (never empty).

Returns:

• (String)

# File 'lib/wx/doc/gen/find_dialog_event.rb', line 110

def get_find_string; end

#get_flags ⇒ Integer Also known as: flags

Get the currently selected flags: this is the combination of the Wx::FindReplaceFlags enumeration values.

Returns:

• (Integer)

# File 'lib/wx/doc/gen/find_dialog_event.rb', line 115

def get_flags; end

#get_replace_string ⇒ Wx::String Also known as: replace_string

Return the string to replace the search string with (only for replace and replace all events).

Returns:

• (Wx::String)

# File 'lib/wx/doc/gen/find_dialog_event.rb', line 120

def get_replace_string; end