| MATE Dictionary Library Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | ||||
GtkWidget * gdict_database_chooser_new (void); GtkWidget * gdict_database_chooser_new_with_context (GdictContext *context); GdictContext * gdict_database_chooser_get_context (GdictDatabaseChooser *chooser); void gdict_database_chooser_set_context (GdictDatabaseChooser *chooser,GdictContext *context); gboolean gdict_database_chooser_select_database (GdictDatabaseChooser *chooser,const gchar *db_name); gboolean gdict_database_chooser_unselect_database (GdictDatabaseChooser *chooser,const gchar *db_name); gboolean gdict_database_chooser_set_current_database (GdictDatabaseChooser *chooser,const gchar *db_name); gchar * gdict_database_chooser_get_current_database (GdictDatabaseChooser *chooser); gchar ** gdict_database_chooser_get_databases (GdictDatabaseChooser *chooser,gsize *length); gint gdict_database_chooser_count_databases (GdictDatabaseChooser *chooser); gboolean gdict_database_chooser_has_database (GdictDatabaseChooser *chooser,const gchar *database); void gdict_database_chooser_refresh (GdictDatabaseChooser *chooser); void gdict_database_chooser_clear (GdictDatabaseChooser *chooser); GtkWidget * gdict_database_chooser_add_button (GdictDatabaseChooser *chooser,const gchar *button_text);
Each GdictContext has a list of databases, that is dictionaries that can be queried. GdictDatabaseChooser is a widget that queries a given GdictContext and displays the list of available databases.
GdictDatabaseChooser is available since Gdict 0.10
GtkWidget * gdict_database_chooser_new (void);
Creates a new GdictDatabaseChooser widget. A Database chooser widget
can be used to display the list of available databases on a dictionary
source using the GdictContext representing it. After creation, the
GdictContext can be set using gdict_database_chooser_set_context().
Returns : |
the newly created GdictDatabaseChooser widget. |
Since 0.10
GtkWidget * gdict_database_chooser_new_with_context
(GdictContext *context);
Creates a new GdictDatabaseChooser, using context as the representation
of the dictionary source to query for the list of available databases.
|
a GdictContext |
Returns : |
the newly created GdictDatabaseChooser widget. |
Since 0.10
GdictContext * gdict_database_chooser_get_context (GdictDatabaseChooser *chooser);
Retrieves the GdictContext used by chooser.
|
a GdictDatabaseChooser |
Returns : |
a GdictContext or NULL
|
Since 0.10
void gdict_database_chooser_set_context (GdictDatabaseChooser *chooser,GdictContext *context);
Sets the GdictContext to be used to query a dictionary source for the list of available databases.
|
a GdictDatabaseChooser |
|
a GdictContext |
Since 0.10
gboolean gdict_database_chooser_select_database (GdictDatabaseChooser *chooser,const gchar *db_name);
Selects the database with db_name inside the chooser widget.
|
a GdictDatabaseChooser |
|
name of the database to select |
Returns : |
TRUE if the database was found and selected |
Since 0.10
gboolean gdict_database_chooser_unselect_database (GdictDatabaseChooser *chooser,const gchar *db_name);
Unselects the database db_name inside the chooser widget
|
a GdictDatabaseChooser |
|
name of the database to unselect |
Returns : |
TRUE if the database was found and unselected |
Since 0.10
gboolean gdict_database_chooser_set_current_database (GdictDatabaseChooser *chooser,const gchar *db_name);
Sets db_name as the current database. This function will select
and activate the corresponding row, if the database is found.
|
a GdictDatabaseChooser |
|
the name of the database |
Returns : |
TRUE if the database was found and set |
Since 0.10
gchar * gdict_database_chooser_get_current_database
(GdictDatabaseChooser *chooser);
Retrieves the name of the currently selected database inside chooser
|
a GdictDatabaseChooser |
Returns : |
the name of the selected database. Use g_free() on the
returned string when done using it |
Since 0.10
gchar ** gdict_database_chooser_get_databases (GdictDatabaseChooser *chooser,gsize *length);
Gets the list of available database names.
|
a GdictDatabaseChooser |
|
return location for the length of the returned vector |
Returns : |
a newly allocated, NULL terminated string vector
containing database names. Use g_strfreev() to deallocate it. |
Since 0.10
gint gdict_database_chooser_count_databases
(GdictDatabaseChooser *chooser);
Returns the number of databases found.
|
a GdictDatabaseChooser |
Returns : |
the number of databases or -1 if no context is set |
Since 0.10
gboolean gdict_database_chooser_has_database (GdictDatabaseChooser *chooser,const gchar *database);
Checks whether the chooser displays database
|
a GdictDatabaseChooser |
|
the name of a database |
Returns : |
TRUE if the search database name is present |
Since 0.10
void gdict_database_chooser_refresh (GdictDatabaseChooser *chooser);
Reloads the list of available databases.
|
a GdictDatabaseChooser |
Since 0.10
void gdict_database_chooser_clear (GdictDatabaseChooser *chooser);
Clears chooser.
|
a GdictDatabaseChooser |
Since 0.10
GtkWidget * gdict_database_chooser_add_button (GdictDatabaseChooser *chooser,const gchar *button_text);
Adds a GtkButton with button_text to the button area on
the bottom of chooser. The button_text can also be a
stock ID.
|
a GdictDatabase |
|
text of the button |
Returns : |
the newly packed button. |
Since 0.10