Class: Wx::TextProofOptions

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

Overview

This class provides a convenient means of passing multiple parameters to Wx::TextCtrl#enable_proof_check.

By default, i.e. when calling #enable_proof_check without any parameters, Wx::TextProofOptions.default proof options are used, which enable spelling (but not grammar) checks for the current language.

However it is also possible to customize the options: “‘ruby textctrl.enable_proof_check(Wx::TextProofOptions.default.language(“fr”).grammar_check) ““

or disable all checks entirely: “‘ruby textctrl.enable_proof_check(Wx::TextProofOptions.disable) ““

This class is only available if Wx.has_feature?(:USE_SPELLCHECK) returns true.

Requires:

  • USE_SPELLCHECK

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(schk = false, gchk = false, lang = '') ⇒ TextProofOptions

Returns a new instance of TextProofOptions.



28
 
# File 'lib/wx/doc/textctrl.rb', line 28

def initialize(schk=false, gchk=false, lang='')end

Class Method Details

.default ⇒ Wx::TextProofOptions

Return the object corresponding to the default options: current language, spell checking enabled, grammar checking disabled.

Returns:



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

def self.default; end

.disable ⇒ Wx::TextProofOptions

Return the object with all checks disabled.

Returns:



58
 
# File 'lib/wx/doc/textctrl.rb', line 58

def self.disable; end

Instance Method Details

#get_lang ⇒ String

Returns:

  • (String) 


49
 
# File 'lib/wx/doc/textctrl.rb', line 49

def get_lang; end

#grammar_check(f = true) ⇒ Object

Parameters:

  • f (Boolean) (defaults to: true) 


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

def grammar_check(f = true) end

#is_grammar_check_enabled ⇒ Boolean Also known as: grammar_check_enabled?

Returns:

  • (Boolean) 


45
 
# File 'lib/wx/doc/textctrl.rb', line 45

def is_grammar_check_enabled; end

#is_spell_check_enabled ⇒ Boolean Also known as: spell_check_enabled?

Returns:

  • (Boolean) 


41
 
# File 'lib/wx/doc/textctrl.rb', line 41

def is_spell_check_enabled; end

#language(lang) ⇒ Object Also known as: language=

Parameters:

  • lang (String) 


37
 
# File 'lib/wx/doc/textctrl.rb', line 37

def language(lang) end

#spell_check(f = true) ⇒ Object

Parameters:

  • f (Boolean) (defaults to: true) 


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

def spell_check(f = true) end