Class: Wx::FindReplaceData

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

Overview

FindReplaceData holds the data for FindReplaceDialog.

It is used to initialize the dialog with the default values and will keep the last values from the dialog when it is closed. It is also updated each time a FindDialogEvent is generated so instead of using the FindDialogEvent methods you can also directly query this object. Note that all SetXXX() methods may only be called before showing the dialog and calling them has no effect later.

Category: Common Dialogs, Data Structures

Requires:

  • USE_FINDREPLDLG

Instance Method Summary collapse

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize(flags = 0) ⇒ Wx::FindReplaceData

Constructor initializes the flags to default value (0).

Parameters:

  • flags (Integer) (defaults to: 0) 


22
 
# File 'lib/wx/doc/gen/find_replace_data.rb', line 22

def initialize(flags=0) end

Instance Method Details

#get_find_string ⇒ Wx::String Also known as: find_string

Get the string to find.

Returns:

  • (Wx::String) 


26
 
# File 'lib/wx/doc/gen/find_replace_data.rb', line 26

def get_find_string; end

#get_flags ⇒ Integer Also known as: flags

Get the combination of Wx::FindReplaceFlags values.

Returns:

  • (Integer) 


31
 
# File 'lib/wx/doc/gen/find_replace_data.rb', line 31

def get_flags; end

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

Get the replacement string.

Returns:

  • (Wx::String) 


36
 
# File 'lib/wx/doc/gen/find_replace_data.rb', line 36

def get_replace_string; end

#set_find_string(str) ⇒ void Also known as: find_string=

This method returns an undefined value.

Set the string to find (used as initial value by the dialog).

Parameters:

  • str (String) 


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

def set_find_string(str) end

#set_flags(flags) ⇒ void Also known as: flags=

This method returns an undefined value.

Set the flags to use to initialize the controls of the dialog.

Parameters:

  • flags (Integer) 


48
 
# File 'lib/wx/doc/gen/find_replace_data.rb', line 48

def set_flags(flags) end

#set_replace_string(str) ⇒ void Also known as: replace_string=

This method returns an undefined value.

Set the replacement string (used as initial value by the dialog).

Parameters:

  • str (String) 


54
 
# File 'lib/wx/doc/gen/find_replace_data.rb', line 54

def set_replace_string(str) end