KeyInfo-class: Representation for option in aspell configuration.

In omegahat/Aspell: Interface to aspell library

Representation for option in aspell configuration.

Description

This class is used to represent meta-data about options within the aspell library's configuration mechanism.

Objects from the Class

Objects can be created by calls of the form new("KeyInfo", ...). Typically, one does not create objects of this type directly. Instead, these are created programmatically via a call to getSpellInfo.

Slots

name:

Object of class "character" the name of the option.

type:

Object of class "integer" the type of the value of this option. This is a named integer. It will be one of the elements of c(string = 0, int = 1, boolean = 2, list = 3).

def:

Object of class "character". The default value.

desc:

Object of class "character". A short description of the option. This serves as the help.

flags:

Object of class "integer". Flags providing information about characteristics of this option. This includes things like whether it is hidden, modifiable, UTF8.

other_data:

Object of class "integer". Used internally by aspell (see common/config.cpp).

Methods

No methods defined with class "KeyInfo" in the signature.

Author(s)

Duncan Temple Lang <[e-mail]>

References

http://aspell.sourceforge.net http://www.omegahat.org

See Also

getSpellInfo

Examples

 opts = getSpellInfo()

  # Get all the list elements.
 opts[sapply(opts, function(x) names(x@type)) == "list"]

omegahat/Aspell documentation built on July 29, 2024, 10:17 p.m.