Struct xpcom::interfaces::mozISpellCheckingEngine

#[repr(C)]
pub struct mozISpellCheckingEngine { /* fields omitted */ }

interface mozISpellCheckingEngine : nsISupports

/**
 * This interface represents a SpellChecker.
 */

Methods

impl mozISpellCheckingEngine

pub fn coerce<T: mozISpellCheckingEngineCoerce>(&self) -> &T

Cast this mozISpellCheckingEngine to one of its base interfaces.

impl mozISpellCheckingEngine

pub unsafe fn GetDictionary(&self, aDictionary: *mut *const int16_t) -> nsresult

/**
   * The name of the current dictionary. Is either a value from
   * getDictionaryList or the empty string if no dictionary is selected.
   * Setting this attribute to a value not in getDictionaryList will throw
   * NS_ERROR_FILE_NOT_FOUND.
   *
   * If the dictionary is changed to no dictionary (the empty string), an
   * observer is allowed to set another dictionary before it returns.
   */

attribute wstring dictionary;

pub unsafe fn SetDictionary(&self, aDictionary: *const int16_t) -> nsresult

/**
   * The name of the current dictionary. Is either a value from
   * getDictionaryList or the empty string if no dictionary is selected.
   * Setting this attribute to a value not in getDictionaryList will throw
   * NS_ERROR_FILE_NOT_FOUND.
   *
   * If the dictionary is changed to no dictionary (the empty string), an
   * observer is allowed to set another dictionary before it returns.
   */

attribute wstring dictionary;

pub unsafe fn GetLanguage(&self, aLanguage: *mut *const int16_t) -> nsresult

/**
   * The language this spellchecker is using when checking
   */

readonly attribute wstring language;

pub unsafe fn GetProvidesPersonalDictionary(
    &self,
    aProvidesPersonalDictionary: *mut bool
) -> nsresult

/**
   * Does the engine provide its own personal dictionary?
   */

readonly attribute boolean providesPersonalDictionary;

pub unsafe fn GetProvidesWordUtils(
    &self,
    aProvidesWordUtils: *mut bool
) -> nsresult

/**
   * Does the engine provide its own word utils?
   */

readonly attribute boolean providesWordUtils;

pub unsafe fn GetName(&self, aName: *mut *const int16_t) -> nsresult

/**
   * The name of the engine
   */

readonly attribute wstring name;

pub unsafe fn GetCopyright(&self, aCopyright: *mut *const int16_t) -> nsresult

/**
   * a string indicating the copyright of the engine
   */

readonly attribute wstring copyright;

pub unsafe fn GetPersonalDictionary(
    &self,
    aPersonalDictionary: *mut *const mozIPersonalDictionary
) -> nsresult

/**
   * the personal dictionary
   */

attribute mozIPersonalDictionary personalDictionary;

pub unsafe fn SetPersonalDictionary(
    &self,
    aPersonalDictionary: *const mozIPersonalDictionary
) -> nsresult

/**
   * the personal dictionary
   */

attribute mozIPersonalDictionary personalDictionary;

pub unsafe fn GetDictionaryList(
    &self,
    dictionaries: *mut *mut *const int16_t,
    count: *mut uint32_t
) -> nsresult

/**
   * Get the list of dictionaries
   */

void getDictionaryList ([array, size_is (count)] out wstring dictionaries, out uint32_t count);

pub unsafe fn Check(&self, word: *const int16_t, _retval: *mut bool) -> nsresult

/**
   * check a word
   */

boolean check (in wstring word);

pub unsafe fn Suggest(
    &self,
    word: *const int16_t,
    suggestions: *mut *mut *const int16_t,
    count: *mut uint32_t
) -> nsresult

/**
   * get a list of suggestions for a misspelled word
   */

void suggest (in wstring word, [array, size_is (count)] out wstring suggestions, out uint32_t count);

pub unsafe fn LoadDictionariesFromDir(&self, dir: *const nsIFile) -> nsresult

/**
   * Load dictionaries from the specified dir
   */

void loadDictionariesFromDir (in nsIFile dir);

pub unsafe fn AddDirectory(&self, dir: *const nsIFile) -> nsresult

/**
   * Add dictionaries from a directory to the spell checker
   */

void addDirectory (in nsIFile dir);

pub unsafe fn RemoveDirectory(&self, dir: *const nsIFile) -> nsresult

/**
   * Remove dictionaries from a directory from the spell checker
   */

void removeDirectory (in nsIFile dir);

Methods from Deref<Target = nsISupports>

pub fn coerce<T: nsISupportsCoerce>(&self) -> &T

Cast this nsISupports to one of its base interfaces.

pub unsafe fn QueryInterface(
    &self,
    uuid: &nsIID,
    result: *mut *mut c_void
) -> nsresult

void QueryInterface (in nsIIDRef uuid, [iid_is (uuid), retval] out nsQIResult result);

pub unsafe fn AddRef(&self) -> nsrefcnt

[noscript,notxpcom] nsrefcnt AddRef ();

pub unsafe fn Release(&self) -> nsrefcnt

[noscript,notxpcom] nsrefcnt Release ();

Trait Implementations

impl XpCom for mozISpellCheckingEngine

const IID: nsIID

IID: nsIID = nsID(2342929316, 32220, 18018, [185, 118, 126, 193, 35, 132, 63, 16])

fn query_interface<T: XpCom>(&self) -> Option<RefPtr<T>>

Perform a QueryInterface call on this object, attempting to dynamically cast it to the requested interface type. Returns Some(RefPtr) if the cast succeeded, and None otherwise.

impl RefCounted for mozISpellCheckingEngine

unsafe fn addref(&self)

Increment the reference count.

unsafe fn release(&self)

Decrement the reference count, potentially freeing backing memory.

impl Deref for mozISpellCheckingEngine

type Target = nsISupports

The resulting type after dereferencing.

fn deref(&self) -> &nsISupports

Dereferences the value.