Main UI

Main UI — The main UI of the player

Synopsis

#include <rc-ui-player.h>

struct              RCUiPlayer;
struct              RCUiPlayerClass;
void                rc_ui_player_exit                   ();
GdkPixbuf *         rc_ui_player_get_icon_image         ();
GObject *           rc_ui_player_get_instance           ();
GtkWidget *         rc_ui_player_get_main_window        ();
GtkStatusIcon *     rc_ui_player_get_tray_icon          ();
void                rc_ui_player_init                   (GtkApplication *app);
gulong              rc_ui_player_signal_connect         (const gchar *name,
                                                         GCallback callback,
                                                         gpointer data);
void                rc_ui_player_signal_disconnect      (gulong handler_id);

Object Hierarchy

  GObject
   +----RCUiPlayer

Signals

  "ready"                                          : Run First

Description

This module provides the main UI of the player, it shows the main player window and the widgets inside for the player.

Details

struct RCUiPlayer

struct RCUiPlayer;

The data structure used for RCUiPlayer class.


struct RCUiPlayerClass

struct RCUiPlayerClass {
};

RCUiPlayerClass class.


rc_ui_player_exit ()

void                rc_ui_player_exit                   ();

Unload the running instance of the main UI.


rc_ui_player_get_icon_image ()

GdkPixbuf *         rc_ui_player_get_icon_image         ();

Get the icon image of this player.

Returns :

The icon image of this player. [transfer none]

rc_ui_player_get_instance ()

GObject *           rc_ui_player_get_instance           ();

Get the running RCUiPlayer instance.

Returns :

The running instance. [transfer none]

rc_ui_player_get_main_window ()

GtkWidget *         rc_ui_player_get_main_window        ();

Get the main window of this player.

Returns :

The main window. [transfer none]

rc_ui_player_get_tray_icon ()

GtkStatusIcon *     rc_ui_player_get_tray_icon          ();

Get the tray icon of this player.

Returns :

The tray icon. [transfer none]

rc_ui_player_init ()

void                rc_ui_player_init                   (GtkApplication *app);

Initialize the main UI of the player.

app :

the GtkApplication for the program

rc_ui_player_signal_connect ()

gulong              rc_ui_player_signal_connect         (const gchar *name,
                                                         GCallback callback,
                                                         gpointer data);

Connect the GCallback function to the given signal for the running instance of RCUiPlayer object.

name :

the name of the signal

callback :

the the GCallback to connect. [scope call]

data :

the user data

Returns :

The handler ID.

rc_ui_player_signal_disconnect ()

void                rc_ui_player_signal_disconnect      (gulong handler_id);

Disconnects a handler from the running RCUiPlayer instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to. The handler_id becomes invalid and may be reused.

handler_id :

handler id of the handler to be disconnected

Signal Details

The "ready" signal

void                user_function                      (RCUiPlayer *player,
                                                        gpointer    user_data)      : Run First

The ::ready signal is emitted when the main UI is ready.

player :

the RCUiPlayer that received the signal

user_data :

user data set when the signal handler was connected.