![]() |
![]() |
![]() |
GNOME Video Arcade Reference Manual | ![]() |
---|---|---|---|---|
void gva_main_init (void); gboolean gva_main_build_database (GError **error); gboolean gva_main_analyze_roms (GError **error); void gva_main_connect_proxy_cb (GtkUIManager *manager, GtkAction *action, GtkWidget *proxy); void gva_main_progress_bar_show (void); void gva_main_progress_bar_hide (void); void gva_main_progress_bar_set_fraction (gdouble fraction); guint gva_main_statusbar_get_context_id (const gchar *context_description); guint gva_main_statusbar_push (guint context_id, const gchar *format, ...); void gva_main_statusbar_pop (guint context_id); void gva_main_statusbar_remove (guint context_id, guint message_id); void gva_main_window_destroy_cb (GtkWindow *window);
These functions manipulate the main window, excluding the tree view. The tree view functions are documented separately in the gva-tree-view section.
void gva_main_init (void);
Initializes the main window.
This function should be called once when the application starts.
gboolean gva_main_build_database (GError **error);
Executes the lengthy process of constructing the games database. The function updates the main window's progress bar to help track the database construction. The function is synchronous; it blocks until database construction is complete or aborted.
|
return location for a GError, or NULL
|
Returns : |
TRUE if the database construction was successful,
FALSE if construction failed or was aborted
|
gboolean gva_main_analyze_roms (GError **error);
Executes the lengthy process of analyzing all available ROM and sample sets for correctness and then updating the games database with the new status information. The function updates the main window's progress bar to help track the analysis. The function is synchronous; it blocks until the analysis is complete or aborted.
|
return location for a GError, or NULL
|
Returns : |
TRUE if the analysis completed successfully,
FALSE if the analysis failed or was aborted
|
void gva_main_connect_proxy_cb (GtkUIManager *manager, GtkAction *action, GtkWidget *proxy);
Callback for manager
's "connect
-proxy" signal. The function configures
main menu items to display the appropriate tooltip in the status bar when
the mouse hovers over them. action
supplies the tooltip.
|
a GtkUIManager |
|
a GtkAction |
|
a GtkWidget |
void gva_main_progress_bar_show (void);
Shows the progress bar in the main window's status bar and sets the mouse cursor to busy. Generally useful before starting a long-running foreground task.
void gva_main_progress_bar_hide (void);
Hides the progress bar in the main window's status bar and sets the mouse cursor back to normal. Generally useful after completing a long-running foreground task.
void gva_main_progress_bar_set_fraction (gdouble fraction);
Thin wrapper for gtk_progress_bar_set_fraction()
that uses the main
window's progress bar.
Causes the progress bar to "fill in" the given fraction of the bar. The fraction should be between 0.0 and 1.0, inclusive.
|
fraction of the task that's been completed |
guint gva_main_statusbar_get_context_id (const gchar *context_description);
Thin wrapper for gtk_statusbar_get_context_id()
that uses the main
window's status bar.
Returns a new context identifier, given a description of the actual context. Note that the description is not shown in the UI.
|
textual description of what context the new message is being used in |
Returns : |
a context identifier |
guint gva_main_statusbar_push (guint context_id, const gchar *format, ...);
Thin wrapper for gtk_statusbar_push()
that uses the main window's
status bar.
Pushes a new message onto the status bar's stack. As a convenience,
the function takes a
-style format string
and variable length argument list.printf()
|
a context identifier |
|
a standard format string
|
|
the arguments to insert into the format string |
Returns : |
a message identifier that can be used with
gva_main_statusbar_remove()
|
void gva_main_statusbar_pop (guint context_id);
Thin wrapper for gtk_statusbar_pop()
that uses the main window's
status bar.
Removes the first message in the status bar's stack with the given context id.
Note that this may not change the displayed message, if the message at the top of the stack has a different context id.
|
a context identifier |
void gva_main_statusbar_remove (guint context_id, guint message_id);
Thin wrapper for gtk_statusbar_remove()
that uses the main window's
status bar.
Forces the removal of a message from a status bar's stack. The exact
context_id
and message_id
must be specified.
|
a context identifier |
|
a message identifier |
void gva_main_window_destroy_cb (GtkWindow *window);
Handler for "destroy" signals to the main window.
Activates the GVA_ACTION_QUIT action.
|
the main window |