Blame docs/reference/html/GspellLanguageChooser.html

Packit Service 0d5873
Packit Service 0d5873
<html>
Packit Service 0d5873
<head>
Packit Service 0d5873
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit Service 0d5873
<title>GspellLanguageChooser: gspell 1 Reference Manual</title>
Packit Service 0d5873
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
Packit Service 0d5873
<link rel="home" href="index.html" title="gspell 1 Reference Manual">
Packit Service 0d5873
<link rel="up" href="language-choosers.html" title="Language Choosers">
Packit Service 0d5873
<link rel="prev" href="language-choosers.html" title="Language Choosers">
Packit Service 0d5873
<link rel="next" href="GspellLanguageChooserButton.html" title="GspellLanguageChooserButton">
Packit Service 0d5873
<meta name="generator" content="GTK-Doc V1.28.1 (XML mode)">
Packit Service 0d5873
<link rel="stylesheet" href="style.css" type="text/css">
Packit Service 0d5873
</head>
Packit Service 0d5873
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Top  | 
Packit Service 0d5873
                  Description  | 
Packit Service 0d5873
                  Object Hierarchy  | 
Packit Service 0d5873
                  Prerequisites  | 
Packit Service 0d5873
                  Known Implementations  | 
Packit Service 0d5873
                  Properties
Packit Service 0d5873
Packit Service 0d5873
Home
Packit Service 0d5873
Up
Packit Service 0d5873
Prev
Packit Service 0d5873
Next
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873

GspellLanguageChooser

Packit Service 0d5873

GspellLanguageChooser — Interface to choose a GspellLanguage

Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873

Functions

Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
const GspellLanguage *
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
gspell_language_chooser_get_language ()
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
void
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
gspell_language_chooser_set_language ()
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
const gchar *
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
gspell_language_chooser_get_language_code ()
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
void
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
gspell_language_chooser_set_language_code ()
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873

Properties

Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
GspellLanguage *
Packit Service 0d5873
language
Packit Service 0d5873
Read / Write
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
gchar *
Packit Service 0d5873
language-code
Packit Service 0d5873
Read / Write
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873

Types and Values

Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
 
Packit Service 0d5873
GspellLanguageChooser
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873

Object Hierarchy

Packit Service 0d5873
    GInterface
Packit Service 0d5873
    ╰── GspellLanguageChooser
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873

Prerequisites

Packit Service 0d5873

Packit Service 0d5873
GspellLanguageChooser requires
Packit Service 0d5873
 GObject.

Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873

Known Implementations

Packit Service 0d5873

Packit Service 0d5873
GspellLanguageChooser is implemented by
Packit Service 0d5873
 GspellLanguageChooserButton and  GspellLanguageChooserDialog.

Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873

Includes

Packit Service 0d5873
#include <gspell/gspell.h>
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873

Description

Packit Service 0d5873

GspellLanguageChooser is an interface that is implemented by widgets for

Packit Service 0d5873
choosing a GspellLanguage.

Packit Service 0d5873

There are two properties: “language” and

Packit Service 0d5873
“language-code”. They are kept in sync. The former is
Packit Service 0d5873
useful, for example, to bind it to the GspellChecker's language property
Packit Service 0d5873
with g_object_bind_property(). The latter is useful to bind it to a
Packit Service 0d5873
GSettings key with g_settings_bind().

Packit Service 0d5873

When setting the language, NULL or the empty string can be passed to pick

Packit Service 0d5873
the default language. In that case, the “language-code”
Packit Service 0d5873
property will contain the empty string, whereas the
Packit Service 0d5873
“language” property will contain the actual
Packit Service 0d5873
GspellLanguage as returned by gspell_language_get_default(). If the user
Packit Service 0d5873
launches the GspellLanguageChooser and chooses explicitly a language, then
Packit Service 0d5873
the “language-code” property will no longer be empty,
Packit Service 0d5873
even if it is the same language as the default language.

Packit Service 0d5873

Note that if an explicit language (non-NULL or not the empty string) is set

Packit Service 0d5873
to the GspellLanguageChooser, then the “language-code”
Packit Service 0d5873
property will not be empty, it will contain the language code of the passed
Packit Service 0d5873
language, even if the language is the same as the default language.

Packit Service 0d5873

Thus, a good default value for a GSettings key is the empty string. That

Packit Service 0d5873
way, the default language is picked, and can change depending on the locale.
Packit Service 0d5873
But once the user has chosen a language, that language is kept in the
Packit Service 0d5873
GSettings key.

Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873

Functions

Packit Service 0d5873
Packit Service 0d5873

gspell_language_chooser_get_language ()

Packit Service 0d5873
const GspellLanguage *
Packit Service 0d5873
gspell_language_chooser_get_language (GspellLanguageChooser *chooser);
Packit Service 0d5873
Packit Service 0d5873

Parameters

Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873

chooser

Packit Service 0d5873

a GspellLanguageChooser.

Packit Service 0d5873
 
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873

Returns

Packit Service 0d5873

the selected GspellLanguage, or NULL if no

Packit Service 0d5873
dictionaries are available. 

Packit Service 0d5873

[nullable]

Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873

Packit Service 0d5873
Packit Service 0d5873

gspell_language_chooser_set_language ()

Packit Service 0d5873
void
Packit Service 0d5873
gspell_language_chooser_set_language (GspellLanguageChooser *chooser,
Packit Service 0d5873
                                      const GspellLanguage *language);
Packit Service 0d5873

Sets the selected language.

Packit Service 0d5873
Packit Service 0d5873

Parameters

Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873

chooser

Packit Service 0d5873

a GspellLanguageChooser.

Packit Service 0d5873
 
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873

language

Packit Service 0d5873

a GspellLanguage or NULL to pick the default

Packit Service 0d5873
language. 

Packit Service 0d5873
[nullable]
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873

Packit Service 0d5873
Packit Service 0d5873

gspell_language_chooser_get_language_code ()

Packit Service 0d5873
const gchar *
Packit Service 0d5873
gspell_language_chooser_get_language_code
Packit Service 0d5873
                               (GspellLanguageChooser *chooser);
Packit Service 0d5873
Packit Service 0d5873

Parameters

Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873

chooser

Packit Service 0d5873

a GspellLanguageChooser.

Packit Service 0d5873
 
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873

Returns

Packit Service 0d5873

the “language-code”. It cannot be NULL.

Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873

Packit Service 0d5873
Packit Service 0d5873

gspell_language_chooser_set_language_code ()

Packit Service 0d5873
void
Packit Service 0d5873
gspell_language_chooser_set_language_code
Packit Service 0d5873
                               (GspellLanguageChooser *chooser,
Packit Service 0d5873
                                const gchar *language_code);
Packit Service 0d5873
Packit Service 0d5873

Parameters

Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873

chooser

Packit Service 0d5873

a GspellLanguageChooser.

Packit Service 0d5873
 
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873

language_code

Packit Service 0d5873

a language code, or the empty string or NULL to

Packit Service 0d5873
pick the default language. 

Packit Service 0d5873
[nullable]
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873

Types and Values

Packit Service 0d5873
Packit Service 0d5873

GspellLanguageChooser

Packit Service 0d5873
typedef struct _GspellLanguageChooser GspellLanguageChooser;
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873

Property Details

Packit Service 0d5873
Packit Service 0d5873

The “language” property

Packit Service 0d5873
  “language”                 GspellLanguage *
Packit Service 0d5873

The selected GspellLanguage.

Packit Service 0d5873

Flags: Read / Write

Packit Service 0d5873
Packit Service 0d5873

Packit Service 0d5873
Packit Service 0d5873

The “language-code” property

Packit Service 0d5873
  “language-code”            gchar *
Packit Service 0d5873

The empty string if the default language was set and the selection

Packit Service 0d5873
hasn't changed. Or the language code if an explicit language was set
Packit Service 0d5873
or if the selection has changed.

Packit Service 0d5873

Flags: Read / Write

Packit Service 0d5873

Default value: ""

Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873

See Also

Packit Service 0d5873

GspellLanguage, GspellLanguageChooserButton, GspellLanguageChooserDialog

Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873
Packit Service 0d5873

Generated by GTK-Doc V1.28.1
Packit Service 0d5873
</body>
Packit Service 0d5873
</html>