AgsUiProvider

AgsUiProvider — provide user interface

Stability Level

Stable, unless otherwise indicated

Functions

gboolean ags_ui_provider_get_show_animation ()
void ags_ui_provider_set_show_animation ()
gboolean ags_ui_provider_get_gui_ready ()
void ags_ui_provider_set_gui_ready ()
gboolean ags_ui_provider_get_file_ready ()
void ags_ui_provider_set_file_ready ()
gdouble ags_ui_provider_get_gui_scale_factor ()
void ags_ui_provider_set_gui_scale_factor ()
void ags_ui_provider_schedule_task ()
void ags_ui_provider_schedule_task_all ()
void ags_ui_provider_setup_completed ()
void ags_ui_provider_check_message ()
void ags_ui_provider_clean_message ()
void ags_ui_provider_update_ui ()
GtkWidget * ags_ui_provider_get_animation_window ()
void ags_ui_provider_set_animation_window ()
GtkWidget * ags_ui_provider_get_window ()
void ags_ui_provider_set_window ()
GtkWidget * ags_ui_provider_get_export_window ()
void ags_ui_provider_set_export_window ()
GtkWidget * ags_ui_provider_get_online_help_window ()
void ags_ui_provider_set_online_help_window ()
GtkWidget * ags_ui_provider_get_preferences ()
void ags_ui_provider_set_preferences ()
GtkWidget * ags_ui_provider_get_history_browser ()
void ags_ui_provider_set_history_browser ()
GtkWidget * ags_ui_provider_get_midi_browser ()
void ags_ui_provider_set_midi_browser ()
GtkWidget * ags_ui_provider_get_sample_browser ()
void ags_ui_provider_set_sample_browser ()
GtkWidget * ags_ui_provider_get_midi_import_wizard ()
void ags_ui_provider_set_midi_import_wizard ()
GtkWidget * ags_ui_provider_get_midi_export_wizard ()
void ags_ui_provider_set_midi_export_wizard ()
GList * ags_ui_provider_get_machine ()
void ags_ui_provider_set_machine ()
GtkWidget * ags_ui_provider_get_composite_editor ()
void ags_ui_provider_set_composite_editor ()
GtkWidget * ags_ui_provider_get_navigation ()
void ags_ui_provider_set_navigation ()
GtkApplication * ags_ui_provider_get_app ()
void ags_ui_provider_set_app ()
GtkWidget * ags_ui_provider_get_meta_data_window ()
void ags_ui_provider_set_meta_data_window ()

Signals

Types and Values

Object Hierarchy

    GInterface
    ╰── AgsUiProvider

Includes

#include <ags/app/ags_ui_provider.h>

Description

The AgsUiProvider provides you the window capabilities.

Functions

ags_ui_provider_get_show_animation ()

gboolean
ags_ui_provider_get_show_animation (AgsUiProvider *ui_provider);

Get show animation.

Parameters

ui_provider

the AgsUiProvider

 

Returns

TRUE if animation does show, else FALSE

Since: 3.0.0


ags_ui_provider_set_show_animation ()

void
ags_ui_provider_set_show_animation (AgsUiProvider *ui_provider,
                                    gboolean show_animation);

Set show animation.

Parameters

ui_provider

the AgsUiProvider

 

show_animation

do show animation

 

Since: 3.0.0


ags_ui_provider_get_gui_ready ()

gboolean
ags_ui_provider_get_gui_ready (AgsUiProvider *ui_provider);

Get GUI ready.

Parameters

ui_provider

the AgsUiProvider

 

Returns

TRUE if gui is ready, else FALSE

Since: 3.0.0


ags_ui_provider_set_gui_ready ()

void
ags_ui_provider_set_gui_ready (AgsUiProvider *ui_provider,
                               gboolean gui_ready);

Set GUI ready.

Parameters

ui_provider

the AgsUiProvider

 

gui_ready

is GUI ready

 

Since: 3.0.0


ags_ui_provider_get_file_ready ()

gboolean
ags_ui_provider_get_file_ready (AgsUiProvider *ui_provider);

Get file ready.

Parameters

ui_provider

the AgsUiProvider

 

Returns

TRUE if gui is ready, else FALSE

Since: 3.0.0


ags_ui_provider_set_file_ready ()

void
ags_ui_provider_set_file_ready (AgsUiProvider *ui_provider,
                                gboolean file_ready);

Set file ready.

Parameters

ui_provider

the AgsUiProvider

 

file_ready

is GUI ready

 

Since: 3.0.0


ags_ui_provider_get_gui_scale_factor ()

gdouble
ags_ui_provider_get_gui_scale_factor (AgsUiProvider *ui_provider);

Get GUI scale factor.

Parameters

ui_provider

the AgsUiProvider

 

Returns

the GUI scale factor as gdouble

Since: 3.0.0


ags_ui_provider_set_gui_scale_factor ()

void
ags_ui_provider_set_gui_scale_factor (AgsUiProvider *ui_provider,
                                      gdouble gui_scale_factor);

Set the GUI scale factor as gdouble.

Parameters

ui_provider

the AgsUiProvider

 

gui_scale_factor

GUI scale factor

 

Since: 3.0.0


ags_ui_provider_schedule_task ()

void
ags_ui_provider_schedule_task (AgsUiProvider *ui_provider,
                               AgsTask *task);

Schedule task to be launched.

Parameters

ui_provider

the AgsUiProvider

 

task

the AgsTask

 

Since: 3.0.0


ags_ui_provider_schedule_task_all ()

void
ags_ui_provider_schedule_task_all (AgsUiProvider *ui_provider,
                                   GList *task);

Schedule all task to be launched.

Parameters

ui_provider

the AgsUiProvider

 

task

the GList containig AgsTask

 

Since: 3.0.0


ags_ui_provider_setup_completed ()

void
ags_ui_provider_setup_completed (AgsUiProvider *ui_provider);

Application context setup completed.

Parameters

ui_provider

the AgsUiProvider

 

Since: 3.0.8


ags_ui_provider_check_message ()

void
ags_ui_provider_check_message (AgsUiProvider *ui_provider);

Check messages the UI provider needs to consume.

Parameters

ui_provider

the AgsUiProvider

 

Since: 3.0.0


ags_ui_provider_clean_message ()

void
ags_ui_provider_clean_message (AgsUiProvider *ui_provider);

Clean messages the UI provider needs to consume.

Parameters

ui_provider

the AgsUiProvider

 

Since: 3.0.0


ags_ui_provider_update_ui ()

void
ags_ui_provider_update_ui (AgsUiProvider *ui_provider);

Update UI.

Parameters

ui_provider

the AgsUiProvider

 

Since: 4.2.1


ags_ui_provider_get_animation_window ()

GtkWidget *
ags_ui_provider_get_animation_window (AgsUiProvider *ui_provider);

Get animation window.

Parameters

ui_provider

the AgsUiProvider

 

Returns

the GtkWidget

Since: 3.0.0


ags_ui_provider_set_animation_window ()

void
ags_ui_provider_set_animation_window (AgsUiProvider *ui_provider,
                                      GtkWidget *animation_window);

Set animation window.

Parameters

ui_provider

the AgsUiProvider

 

animation_window

the GtkWidget

 

Since: 3.0.0


ags_ui_provider_get_window ()

GtkWidget *
ags_ui_provider_get_window (AgsUiProvider *ui_provider);

Get window.

Parameters

ui_provider

the AgsUiProvider

 

Returns

the AgsWindow

Since: 3.0.0


ags_ui_provider_set_window ()

void
ags_ui_provider_set_window (AgsUiProvider *ui_provider,
                            GtkWidget *window);

Set window.

Parameters

ui_provider

the AgsUiProvider

 

window

the AgsWindow

 

Since: 3.0.0


ags_ui_provider_get_export_window ()

GtkWidget *
ags_ui_provider_get_export_window (AgsUiProvider *ui_provider);

Get export window.

Parameters

ui_provider

the AgsUiProvider

 

Returns

the GtkWidget

Since: 3.0.0


ags_ui_provider_set_export_window ()

void
ags_ui_provider_set_export_window (AgsUiProvider *ui_provider,
                                   GtkWidget *export_window);

Set export window.

Parameters

ui_provider

the AgsUiProvider

 

export_window

the GtkWidget

 

Since: 3.0.0


ags_ui_provider_get_online_help_window ()

GtkWidget *
ags_ui_provider_get_online_help_window
                               (AgsUiProvider *ui_provider);

Get online help window.

Parameters

ui_provider

the AgsUiProvider

 

Returns

the GtkWidget

Since: 3.5.0


ags_ui_provider_set_online_help_window ()

void
ags_ui_provider_set_online_help_window
                               (AgsUiProvider *ui_provider,
                                GtkWidget *online_help_window);

Set online help window.

Parameters

ui_provider

the AgsUiProvider

 

online_help_window

the GtkWidget

 

Since: 3.5.0


ags_ui_provider_get_preferences ()

GtkWidget *
ags_ui_provider_get_preferences (AgsUiProvider *ui_provider);

Get animation window.

Parameters

ui_provider

the AgsUiProvider

 

Returns

the GtkWidget

Since: 3.0.0


ags_ui_provider_set_preferences ()

void
ags_ui_provider_set_preferences (AgsUiProvider *ui_provider,
                                 GtkWidget *preferences);

Set animation window.

Parameters

ui_provider

the AgsUiProvider

 

preferences

the GtkWidget

 

Since: 3.0.0


ags_ui_provider_get_history_browser ()

GtkWidget *
ags_ui_provider_get_history_browser (AgsUiProvider *ui_provider);

Get animation window.

Parameters

ui_provider

the AgsUiProvider

 

Returns

the GtkWidget

Since: 3.0.0


ags_ui_provider_set_history_browser ()

void
ags_ui_provider_set_history_browser (AgsUiProvider *ui_provider,
                                     GtkWidget *history_browser);

Set animation window.

Parameters

ui_provider

the AgsUiProvider

 

history_browser

the GtkWidget

 

Since: 3.0.0


ags_ui_provider_get_midi_browser ()

GtkWidget *
ags_ui_provider_get_midi_browser (AgsUiProvider *ui_provider);

Get animation window.

Parameters

ui_provider

the AgsUiProvider

 

Returns

the GtkWidget

Since: 3.0.0


ags_ui_provider_set_midi_browser ()

void
ags_ui_provider_set_midi_browser (AgsUiProvider *ui_provider,
                                  GtkWidget *midi_browser);

Set animation window.

Parameters

ui_provider

the AgsUiProvider

 

midi_browser

the GtkWidget

 

Since: 3.0.0


ags_ui_provider_get_sample_browser ()

GtkWidget *
ags_ui_provider_get_sample_browser (AgsUiProvider *ui_provider);

ags_ui_provider_set_sample_browser ()

void
ags_ui_provider_set_sample_browser (AgsUiProvider *ui_provider,
                                    GtkWidget *sample_browser);

Set animation window.

Parameters

ui_provider

the AgsUiProvider

 

sample_browser

the GtkWidget

 

Since: 3.0.0


ags_ui_provider_get_midi_import_wizard ()

GtkWidget *
ags_ui_provider_get_midi_import_wizard
                               (AgsUiProvider *ui_provider);

Get animation window.

Parameters

ui_provider

the AgsUiProvider

 

Returns

the GtkWidget

Since: 3.0.0


ags_ui_provider_set_midi_import_wizard ()

void
ags_ui_provider_set_midi_import_wizard
                               (AgsUiProvider *ui_provider,
                                GtkWidget *midi_import_wizard);

Set animation window.

Parameters

ui_provider

the AgsUiProvider

 

midi_import_wizard

the GtkWidget

 

Since: 3.0.0


ags_ui_provider_get_midi_export_wizard ()

GtkWidget *
ags_ui_provider_get_midi_export_wizard
                               (AgsUiProvider *ui_provider);

Get animation window.

Parameters

ui_provider

the AgsUiProvider

 

Returns

the GtkWidget

Since: 3.0.0


ags_ui_provider_set_midi_export_wizard ()

void
ags_ui_provider_set_midi_export_wizard
                               (AgsUiProvider *ui_provider,
                                GtkWidget *midi_export_wizard);

Set animation window.

Parameters

ui_provider

the AgsUiProvider

 

midi_export_wizard

the GtkWidget

 

Since: 3.0.0


ags_ui_provider_get_machine ()

GList *
ags_ui_provider_get_machine (AgsUiProvider *ui_provider);

Get machine.

Parameters

ui_provider

the AgsUiProvider

 

Returns

the GList containing AgsMachine

Since: 3.0.0


ags_ui_provider_set_machine ()

void
ags_ui_provider_set_machine (AgsUiProvider *ui_provider,
                             GList *machine);

Set machine.

Parameters

ui_provider

the AgsUiProvider

 

machine

the GList containing AgsMachine

 

Since: 3.0.0


ags_ui_provider_get_composite_editor ()

GtkWidget *
ags_ui_provider_get_composite_editor (AgsUiProvider *ui_provider);

Get animation window.

Parameters

ui_provider

the AgsUiProvider

 

Returns

the GtkWidget

Since: 3.0.0


ags_ui_provider_set_composite_editor ()

void
ags_ui_provider_set_composite_editor (AgsUiProvider *ui_provider,
                                      GtkWidget *composite_editor);

Set animation window.

Parameters

ui_provider

the AgsUiProvider

 

composite_editor

the GtkWidget

 

Since: 3.0.0


ags_ui_provider_get_navigation ()

GtkWidget *
ags_ui_provider_get_navigation (AgsUiProvider *ui_provider);

Get animation window.

Parameters

ui_provider

the AgsUiProvider

 

Returns

the GtkWidget

Since: 3.0.0


ags_ui_provider_set_navigation ()

void
ags_ui_provider_set_navigation (AgsUiProvider *ui_provider,
                                GtkWidget *navigation);

Set animation window.

Parameters

ui_provider

the AgsUiProvider

 

navigation

the GtkWidget

 

Since: 3.0.0


ags_ui_provider_get_app ()

GtkApplication *
ags_ui_provider_get_app (AgsUiProvider *ui_provider);

Get application.

Parameters

ui_provider

the AgsUiProvider

 

Returns

the GtkApplication

Since: 3.18.0


ags_ui_provider_set_app ()

void
ags_ui_provider_set_app (AgsUiProvider *ui_provider,
                         GtkApplication *app);

Set app.

Parameters

ui_provider

the AgsUiProvider

 

app

the GtkApplication

 

Since: 3.18.0


ags_ui_provider_get_meta_data_window ()

GtkWidget *
ags_ui_provider_get_meta_data_window (AgsUiProvider *ui_provider);

Get meta-data window.

Parameters

ui_provider

the AgsUiProvider

 

Returns

the GtkWidget

Since: 3.18.0


ags_ui_provider_set_meta_data_window ()

void
ags_ui_provider_set_meta_data_window (AgsUiProvider *ui_provider,
                                      GtkWidget *meta_data_window);

Set meta-data window.

Parameters

ui_provider

the AgsUiProvider

 

meta_data_window

the GtkWidget

 

Since: 3.18.0

Types and Values

AGS_UI_PROVIDER_DEFAULT_TIMEOUT

#define AGS_UI_PROVIDER_DEFAULT_TIMEOUT (1.0 / 25.0)

AGS_UI_PROVIDER_UPDATE_UI_TIMEOUT

#define AGS_UI_PROVIDER_UPDATE_UI_TIMEOUT (1.0 / 8.0)

AGS_UI_PROVIDER_DEFAULT_PADDING

#define AGS_UI_PROVIDER_DEFAULT_PADDING (6)

AGS_UI_PROVIDER_DEFAULT_SPACING

#define AGS_UI_PROVIDER_DEFAULT_SPACING (6)

AGS_UI_PROVIDER_DEFAULT_COLUMN_SPACING

#define AGS_UI_PROVIDER_DEFAULT_COLUMN_SPACING (6)

AGS_UI_PROVIDER_DEFAULT_ROW_SPACING

#define AGS_UI_PROVIDER_DEFAULT_ROW_SPACING (6)

AGS_UI_PROVIDER_DEFAULT_MARGIN_END

#define AGS_UI_PROVIDER_DEFAULT_MARGIN_END (6)

AGS_UI_PROVIDER_DEFAULT_OPEN_DIALOG_WIDTH

#define AGS_UI_PROVIDER_DEFAULT_OPEN_DIALOG_WIDTH (1024)

AGS_UI_PROVIDER_DEFAULT_OPEN_DIALOG_HEIGHT

#define AGS_UI_PROVIDER_DEFAULT_OPEN_DIALOG_HEIGHT (768)

Signal Details

The “check-message” signal

void
user_function (AgsUiProvider *ui_provider,
               gpointer       user_data)

The ::check-message signal is emitted every check message of the UI provider. This notifies about to check for messages from message delivery.

Parameters

ui_provider

the AgsUiProvider object

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 3.0.0


The “clean-message” signal

void
user_function (AgsUiProvider *ui_provider,
               gpointer       user_data)

The ::clean-message signal is emitted every clean message of the UI provider. This notifies about to clean messages from message delivery.

Parameters

ui_provider

the AgsUiProvider object

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 3.0.0


The “setup-completed” signal

void
user_function (AgsUiProvider *ui_provider,
               gpointer       user_data)

The ::setup-completed signal is emitted every check message of the UI provider. This notifies about to check for messages from message delivery.

Parameters

ui_provider

the AgsUiProvider object

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 3.0.8


The “update-ui” signal

void
user_function (AgsUiProvider *ui_provider,
               gpointer       user_data)

The ::update-ui signal is emitted every AGS_UI_PROVIDER_DEFAULT_TIMEOUT interval.

Parameters

ui_provider

the AgsUiProvider object

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 4.2.1