Top |
Functions
GtkWidget * | gdict_database_chooser_new () |
GtkWidget * | gdict_database_chooser_new_with_context () |
GdictContext * | gdict_database_chooser_get_context () |
void | gdict_database_chooser_set_context () |
gchar ** | gdict_database_chooser_get_databases () |
gint | gdict_database_chooser_count_databases () |
gboolean | gdict_database_chooser_has_database () |
void | gdict_database_chooser_refresh () |
void | gdict_database_chooser_clear () |
GtkWidget * | gdict_database_chooser_add_button () |
gchar * | gdict_database_chooser_get_current_database () |
gboolean | gdict_database_chooser_select_database () |
gboolean | gdict_database_chooser_set_current_database () |
gboolean | gdict_database_chooser_unselect_database () |
Object Hierarchy
GObject ╰── GInitiallyUnowned ╰── GtkWidget ╰── GtkContainer ╰── GtkBox ╰── GdictDatabaseChooser
Implemented Interfaces
GdictDatabaseChooser implements AtkImplementorIface, GtkBuildable and GtkOrientable.
Description
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
Functions
gdict_database_chooser_new ()
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()
.
Since: 0.10
gdict_database_chooser_new_with_context ()
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.
Since: 0.10
gdict_database_chooser_get_context ()
GdictContext *
gdict_database_chooser_get_context (GdictDatabaseChooser *chooser
);
Retrieves the GdictContext used by chooser
.
Since: 0.10
gdict_database_chooser_set_context ()
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.
Since: 0.10
gdict_database_chooser_get_databases ()
gchar ** gdict_database_chooser_get_databases (GdictDatabaseChooser *chooser
,gsize *length
);
Gets the list of available database names.
Returns
a newly allocated, NULL
terminated string vector
containing database names. Use g_strfreev()
to deallocate it.
[transfer full]
Since: 0.10
gdict_database_chooser_count_databases ()
gint
gdict_database_chooser_count_databases
(GdictDatabaseChooser *chooser
);
Returns the number of databases found.
Since: 0.10
gdict_database_chooser_has_database ()
gboolean gdict_database_chooser_has_database (GdictDatabaseChooser *chooser
,const gchar *database
);
Checks whether the chooser
displays database
Since: 0.10
gdict_database_chooser_refresh ()
void
gdict_database_chooser_refresh (GdictDatabaseChooser *chooser
);
Reloads the list of available databases.
Since: 0.10
gdict_database_chooser_clear ()
void
gdict_database_chooser_clear (GdictDatabaseChooser *chooser
);
Clears chooser
.
Since: 0.10
gdict_database_chooser_add_button ()
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
.
Since: 0.10
gdict_database_chooser_get_current_database ()
gchar *
gdict_database_chooser_get_current_database
(GdictDatabaseChooser *chooser
);
Retrieves the name of the currently selected database inside chooser
Since: 0.10
gdict_database_chooser_select_database ()
gboolean gdict_database_chooser_select_database (GdictDatabaseChooser *chooser
,const gchar *db_name
);
Selects the database with db_name
inside the chooser
widget.
Since: 0.10
gdict_database_chooser_set_current_database ()
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.
Since: 0.10
gdict_database_chooser_unselect_database ()
gboolean gdict_database_chooser_unselect_database (GdictDatabaseChooser *chooser
,const gchar *db_name
);
Unselects the database db_name
inside the chooser
widget
Since: 0.10
Property Details
The “context”
property
“context” GdictContext *
The GdictContext used to retrieve the list of available databases.
Flags: Read / Write / Construct
Since: 0.10
The “count”
property
“count” gint
The number of displayed databases or, if no GdictContext is set, -1.
Flags: Read
Allowed values: >= -1
Default value: -1
Since: 0.12
Signal Details
The “database-activated”
signal
void user_function (GdictDatabaseChooser *chooser, gchar *name, gchar *description, gpointer user_data)
The ::database-activated signal is emitted each time the user activated a row in the database chooser widget, either by double clicking on it or by a keyboard event.
Parameters
chooser |
the database chooser that received the signal |
|
name |
the name of the activated database |
|
description |
the description of the activated database |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 0.10
The “selection-changed”
signal
void user_function (GdictDatabaseChooser *chooser, gpointer user_data)
The ::selection-changed signal is emitted each time the selection inside the database chooser has been changed.
Parameters
chooser |
the database chooser that received the signal |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 0.12