Parent

Class/Module Index [+]

Quicksearch

Aspell

The functionality of Aspell is accessible via this class.

Public Class Methods

CheckerOptions() click to toggle source

Returns a list of checker options.

# File lib/raspell_stub.rb, line 19
def self.CheckerOptions; end
DictionaryOptions() click to toggle source

Returns a list of dictionary options.

# File lib/raspell_stub.rb, line 22
def self.DictionaryOptions; end
FilterOptions() click to toggle source

Returns a list of filter options.

# File lib/raspell_stub.rb, line 25
def self.FilterOptions; end
MiscOptions() click to toggle source

Returns a list of misc options.

# File lib/raspell_stub.rb, line 28
def self.MiscOptions; end
RunTogetherOptions() click to toggle source

Returns a list of run-together options.

# File lib/raspell_stub.rb, line 31
def self.RunTogetherOptions; end
UtilityOptions() click to toggle source

Returns a list of utility options.

# File lib/raspell_stub.rb, line 34
def self.UtilityOptions; end
list_dicts() click to toggle source

Returns a list of AspellDictInfo-objects describing each dictionary.

# File lib/raspell_stub.rb, line 16
def self.list_dicts; end
new(language, jargon, size, encoding) click to toggle source

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

Public Instance Methods

add_to_personal(word) click to toggle source

Add a word to the private dictionary.

# File lib/raspell_stub.rb, line 39
def add_to_personal(word); end
add_to_session(word) click to toggle source

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(word) click to toggle source

Check given word for correctness. Returns true or false.

# File lib/raspell_stub.rb, line 45
def check(word); end
clear_session() click to toggle source

Clear the the session wordlist.

# File lib/raspell_stub.rb, line 56
def clear_session(); end
correct_file(filename) click to toggle source

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
correct_lines(array_of_strings) click to toggle source

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
get_option(option) click to toggle source

Value of an option in config. Returns a string.

# File lib/raspell_stub.rb, line 59
def get_option(option); end
get_option_as_list(option) click to toggle source

Value of option in config. Returns a list of strings.

# File lib/raspell_stub.rb, line 62
def get_option_as_list(option); end
list_misspelled(array_of_strings) click to toggle source

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
personal_wordlist() click to toggle source

Return a list of words inside the private dictionary.

# File lib/raspell_stub.rb, line 68
def personal_wordlist(); end
save_all_word_lists() click to toggle source

Sync changed dictionaries to disk.

# File lib/raspell_stub.rb, line 71
def save_all_word_lists(); end
session_wordlist() click to toggle source

Return the session wordlist.

# File lib/raspell_stub.rb, line 74
def session_wordlist(); end
set_option(option, value) click to toggle source

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
suggest(word) click to toggle source

Returns an array of suggestions for the given word. Note that suggest returns multiple corrections even for words that are not wrong.

# File lib/raspell_stub.rb, line 80
def suggest(word); end
suggestion_mode=(mode) click to toggle source

Sets the suggestion mode. Use Aspell::ULTRA, Aspell::FAST, Aspell::NORMAL, or Aspell::BADSPELLERS as the parameter.

# File lib/raspell_stub.rb, line 83
def suggestion_mode=(mode); end

[Validate]

Generated with the Darkfish Rdoc Generator 2.