Object
The functionality of Aspell is accessible via this class.
Returns a list of checker options.
# File lib/raspell_stub.rb, line 19 def self.CheckerOptions; end
Returns a list of dictionary options.
# File lib/raspell_stub.rb, line 22 def self.DictionaryOptions; end
Returns a list of filter options.
# File lib/raspell_stub.rb, line 25 def self.FilterOptions; end
Returns a list of misc options.
# File lib/raspell_stub.rb, line 28 def self.MiscOptions; end
Returns a list of run-together options.
# File lib/raspell_stub.rb, line 31 def self.RunTogetherOptions; end
Returns a list of utility options.
# File lib/raspell_stub.rb, line 34 def self.UtilityOptions; end
Returns a list of AspellDictInfo-objects describing each dictionary.
# File lib/raspell_stub.rb, line 16 def self.list_dicts; end
Creates an Aspell instance. All parameters are optional and have default values. In most situations it is enough to create an Aspell-instance with only a language.
language - ISO639 language code plus optional ISO 3166 counry code as string (eg: "de" or "en_US").
jargon - A special jargon of the selected language.
size - The size of the dictionary to chose (if there are options).
encoding - The encoding to use.
# File lib/raspell_stub.rb, line 13 def initialize(language, jargon, size, encoding); end
Add a word to the private dictionary.
# File lib/raspell_stub.rb, line 39 def add_to_personal(word); end
Add a word to the session ignore list. The session persists for the lifetime of self.
# File lib/raspell_stub.rb, line 42 def add_to_session(word); end
Check given word for correctness. Returns true or false.
# File lib/raspell_stub.rb, line 45 def check(word); end
Clear the the session wordlist.
# File lib/raspell_stub.rb, line 56 def clear_session(); end
Check an entire file for correctness. This method requires a block, which will yield each misspelled word.
# File lib/raspell_stub.rb, line 48 def correct_file(filename); end
Check an array of strings for correctness. This method requires a block, which will yield each misspelled word.
# File lib/raspell_stub.rb, line 51 def correct_lines(array_of_strings) yield end
Value of an option in config. Returns a string.
# File lib/raspell_stub.rb, line 59 def get_option(option); end
Value of option in config. Returns a list of strings.
# File lib/raspell_stub.rb, line 62 def get_option_as_list(option); end
Returns a list of all words in the passed array that are misspelled.
# File lib/raspell_stub.rb, line 65 def list_misspelled(array_of_strings); end
Return a list of words inside the private dictionary.
# File lib/raspell_stub.rb, line 68 def personal_wordlist(); end
Sync changed dictionaries to disk.
# File lib/raspell_stub.rb, line 71 def save_all_word_lists(); end
Return the session wordlist.
# File lib/raspell_stub.rb, line 74 def session_wordlist(); end
Set a passthrough option to a value. Use the strings "true" and "false" for true and false.
# File lib/raspell_stub.rb, line 77 def set_option(option, value); end
Generated with the Darkfish Rdoc Generator 2.