gtkspellmm 3.0.5
|
#include <gtkspellmm/gtkspell.h>
Public Member Functions | |
Checker (Checker&& src) noexcept | |
Checker& | operator= (Checker&& src) noexcept |
virtual | ~Checker () noexcept |
GtkSpellChecker* | gobj () |
Provides access to the underlying C GObject. | |
const GtkSpellChecker* | gobj () const |
Provides access to the underlying C GObject. | |
GtkSpellChecker* | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. | |
Checker () | |
Constructs a new GtkSpell::Checker object. | |
bool | attach (Gtk::TextView& view) |
Attach the GtkSpell::Checker to the specified Gtk::TextView. | |
void | detach () |
Detaches the Gtk::SpellChecker. | |
std::vector< Glib::ustring > | get_suggestions (const Glib::ustring& word) |
Retreives a list of spelling suggestions for the specified word. | |
Gtk::Menu* | get_suggestions_menu (Gtk::TextIter& iter) |
Retreives a Gtk::Menu of replacement spellings. | |
void | set_language (const Glib::ustring& lang) |
Sets the language to be used for spelling, throws an exception on failure. | |
Glib::ustring | get_language () |
Gets the language currently being used for spelling. | |
bool | check_word (const Glib::ustring& word) |
Check the specified word. | |
void | recheck_all () |
Rechecks the entire text buffer. | |
void | add_to_dictionary (const Glib::ustring& word) |
Add the specified word to the user dictionary. | |
void | ignore_word (const Glib::ustring& word) |
Add the specified word to the user ignore list. | |
Glib::SignalProxy1< void, const Glib::ustring& > | signal_language_changed () |
This signal is emitted when a new language is selected from the context menu. | |
Glib::PropertyProxy< bool > | property_decode_language_codes () |
Whether to show decoded language codes in the context menu (requires the iso-codes package). | |
Glib::PropertyProxy_ReadOnly< bool > | property_decode_language_codes () const |
Whether to show decoded language codes in the context menu (requires the iso-codes package). | |
Static Public Member Functions | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. | |
static Glib::RefPtr< Checker > | get_from_text_view (Gtk::TextView& view) |
Retreives the GtkSpell::Checker attached to a Gtk::TextView. | |
static std::vector< Glib::ustring > | get_language_list () |
Gets the list of available languages. | |
static Glib::ustring | decode_language_code (const Glib::ustring& lang) |
Translates the language code to a human readable format (i.e. | |
Protected Member Functions | |
virtual void | on_language_changed (const Glib::ustring& newlang) |
This is a default handler for the signal signal_language_changed(). | |
Related Symbols | |
(Note that these are not member symbols.) | |
Glib::RefPtr< GtkSpell::Checker > | wrap (GtkSpellChecker* object, bool take_copy=false) |
A Glib::wrap() method for this object. | |
|
noexcept |
|
virtualnoexcept |
GtkSpell::Checker::Checker | ( | ) |
Constructs a new GtkSpell::Checker object.
void GtkSpell::Checker::add_to_dictionary | ( | const Glib::ustring & | word | ) |
Add the specified word to the user dictionary.
word | The word to add to the user dictionary. |
bool GtkSpell::Checker::attach | ( | Gtk::TextView & | view | ) |
Attach the GtkSpell::Checker to the specified Gtk::TextView.
view | A Gtk::TextView |
bool GtkSpell::Checker::check_word | ( | const Glib::ustring & | word | ) |
Check the specified word.
word | The word to check. |
|
static |
Translates the language code to a human readable format (i.e.
"en_US" -> "English (United States)").
lang | The language locale specifier (i.e. "en", or "en_US"). |
void GtkSpell::Checker::detach | ( | ) |
Detaches the Gtk::SpellChecker.
If the Gtk::SpellChecker is not attached to any Gtk::TextView, the function silently exits
|
static |
Retreives the GtkSpell::Checker attached to a Gtk::TextView.
view | A Gtk::TextView |
null
Glib::RefPtr Glib::ustring GtkSpell::Checker::get_language | ( | ) |
Gets the language currently being used for spelling.
|
static |
std::vector< Glib::ustring > GtkSpell::Checker::get_suggestions | ( | const Glib::ustring & | word | ) |
Retreives a list of spelling suggestions for the specified word.
word | The word for which to fetch suggestions |
Gtk::Menu * GtkSpell::Checker::get_suggestions_menu | ( | Gtk::TextIter & | iter | ) |
Retreives a Gtk::Menu of replacement spellings.
iter | A Gtk::TextIter position in the buffer to be corrected |
null
if the word is not misspelt
|
static |
Get the GType for this class, for use with the underlying GObject type system.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
GtkSpellChecker * GtkSpell::Checker::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
void GtkSpell::Checker::ignore_word | ( | const Glib::ustring & | word | ) |
Add the specified word to the user ignore list.
word | The word to add to the user ignore list. |
|
protectedvirtual |
This is a default handler for the signal signal_language_changed().
Glib::PropertyProxy< bool > GtkSpell::Checker::property_decode_language_codes | ( | ) |
Whether to show decoded language codes in the context menu (requires the iso-codes package).
Whether to show decoded language codes in the context menu (requires the iso-codes package).
Glib::PropertyProxy_ReadOnly< bool > GtkSpell::Checker::property_decode_language_codes | ( | ) | const |
Whether to show decoded language codes in the context menu (requires the iso-codes package).
void GtkSpell::Checker::recheck_all | ( | ) |
Rechecks the entire text buffer.
void GtkSpell::Checker::set_language | ( | const Glib::ustring & | lang | ) |
Sets the language to be used for spelling, throws an exception on failure.
lang | The language, as a locale specifier (i.e. "en", or "en_US") |
Gtk::Error | An exception describing the error occured |
Glib::SignalProxy1< void, const Glib::ustring & > GtkSpell::Checker::signal_language_changed | ( | ) |
This signal is emitted when a new language is selected from the context menu.
newlang | The new spelling language |
void on_my_language_changed(const Glib::ustring& newlang)
The signal_language_changed() signal is emitted when the user selects a new spelling language from the context menu.
newlang | The new language which was selected. |
|
related |
A Glib::wrap() method for this object.
object | The C instance. |
take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref. |