#include <gtkspellmm/gtkspell.h>
|
(Note that these are not member functions.)
|
Glib::RefPtr< GtkSpell::Checker > | wrap (GtkSpellChecker* object, bool take_copy=false) |
| A Glib::wrap() method for this object. More...
|
|
virtual GtkSpell::Checker::~Checker |
( |
| ) |
|
|
virtual |
GtkSpell::Checker::Checker |
( |
| ) |
|
bool GtkSpell::Checker::attach |
( |
Gtk::TextView & |
view | ) |
|
bool GtkSpell::Checker::check_word |
( |
const Glib::ustring & |
word | ) |
|
Check the specified word.
- Parameters
-
- Returns
- TRUE if the word is correctly spelled, FALSE otherwise.
- Since gtkspellmm 3.0.4:
static Glib::ustring GtkSpell::Checker::decode_language_code |
( |
const Glib::ustring & |
lang | ) |
|
|
static |
Translates the language code to a human readable format (i.e.
"en_US" -> "English (United States)").
- Parameters
-
lang | The language locale specifier (i.e. "en", or "en_US"). |
- Note
- If the iso-codes package is not available, the unchanged code is returned.
- Returns
- The translated language specifier.
- Since gtkspellmm 3.0.2:
void GtkSpell::Checker::detach |
( |
| ) |
|
Detaches the Gtk::SpellChecker.
If the Gtk::SpellChecker is not attached to any Gtk::TextView, the function silently exits
static Glib::RefPtr<Checker> GtkSpell::Checker::get_from_text_view |
( |
Gtk::TextView & |
view | ) |
|
|
static |
Retreives the GtkSpell::Checker attached to a Gtk::TextView.
- Parameters
-
- Returns
- A Glib::RefPtr to the attached Gtk::SpellChecker, if any, otherwise a
null
Glib::RefPtr
Glib::ustring GtkSpell::Checker::get_language |
( |
| ) |
|
Gets the language currently being used for spelling.
- Returns
- The language, as a locale specifier (i.e. "en", or "en_US")
static std::vector<Glib::ustring> GtkSpell::Checker::get_language_list |
( |
| ) |
|
|
static |
std::vector<Glib::ustring> GtkSpell::Checker::get_suggestions |
( |
const Glib::ustring & |
word | ) |
|
Retreives a list of spelling suggestions for the specified word.
- Parameters
-
word | The word for which to fetch suggestions |
- Returns
- The list of spelling suggestions for the specified word.
- Since gtkspellmm 3.0.4:
Gtk::Menu* GtkSpell::Checker::get_suggestions_menu |
( |
Gtk::TextIter & |
iter | ) |
|
Retreives a Gtk::Menu of replacement spellings.
- Parameters
-
iter | A Gtk::TextIter position in the buffer to be corrected |
- Returns
- A pointer to a Gtk::Menu, or
null
if the word is not misspelt
static GType GtkSpell::Checker::get_type |
( |
| ) |
|
|
static |
Get the GType for this class, for use with the underlying GObject type system.
GtkSpellChecker* GtkSpell::Checker::gobj |
( |
| ) |
|
|
inline |
Provides access to the underlying C GObject.
const GtkSpellChecker* GtkSpell::Checker::gobj |
( |
| ) |
const |
|
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.
virtual void GtkSpell::Checker::on_language_changed |
( |
const Glib::ustring & |
newlang | ) |
|
|
protectedvirtual |
Glib::PropertyProxy< bool > GtkSpell::Checker::property_decode_language_codes |
( |
| ) |
|
Whether to show decoded language codes in the context menu (requires the iso-codes package).
- Since gtkspellmm 3.0.2:
Whether to show decoded language codes in the context menu (requires the iso-codes package).
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
- Returns
- A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
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).
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
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.
- Parameters
-
lang | The language, as a locale specifier (i.e. "en", or "en_US") |
- Exceptions
-
Gtk::Error | An exception describing the error occured |
- Examples:
- example/example.cc.
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.
- Parameters
-
newlang | The new spelling language |
- Slot Prototype:
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.
- Parameters
-
lang | The new language which was selected. |
Glib::RefPtr< GtkSpell::Checker > wrap |
( |
GtkSpellChecker * |
object, |
|
|
bool |
take_copy = false |
|
) |
| |
|
related |
A Glib::wrap() method for this object.
- Parameters
-
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. |
- Returns
- A C++ instance that wraps this C instance.