RCUiMainWindow

RCUiMainWindow — The main window of the player

Synopsis

#include <rc-ui-window.h>

struct              RCUiMainWindow;
struct              RCUiMainWindowClass;
gboolean            rc_ui_main_window_cover_image_get_visible
                                                        ();
void                rc_ui_main_window_cover_image_set_visible
                                                        (gboolean visible);
GdkPixbuf *         rc_ui_main_window_get_default_cover_image
                                                        ();
GtkWidget *         rc_ui_main_window_get_widget        ();
gboolean            rc_ui_main_window_lyric_labels_get_visible
                                                        ();
void                rc_ui_main_window_lyric_labels_set_visible
                                                        (gboolean visible);
void                rc_ui_main_window_playlist_scrolled_window_set_horizontal_policy
                                                        (gboolean state);
void                rc_ui_main_window_present_main_window
                                                        ();
void                rc_ui_main_window_set_keep_above_state
                                                        (gboolean state);
void                rc_ui_main_window_show              ();
gboolean            rc_ui_main_window_spectrum_get_visible
                                                        ();
void                rc_ui_main_window_spectrum_set_style
                                                        (guint style);
void                rc_ui_main_window_spectrum_set_visible
                                                        (gboolean visible);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkWidget
               +----GtkContainer
                     +----GtkBin
                           +----GtkWindow
                                 +----RCUiMainWindow

Implemented Interfaces

RCUiMainWindow implements AtkImplementorIface and GtkBuildable.

Signals

  "keep-above-changed"                             : Run First

Description

This module implements the main window class RCUiMainWindow, which implements the main window of the player.

Details

struct RCUiMainWindow

struct RCUiMainWindow;

The data structure used for RCUiMainWindow class.


struct RCUiMainWindowClass

struct RCUiMainWindowClass {
};

RCUiMainWindowClass class.


rc_ui_main_window_cover_image_get_visible ()

gboolean            rc_ui_main_window_cover_image_get_visible
                                                        ();

Get the visibilty of the spectrum show widget.

Returns :

Whether the widget is visible.

rc_ui_main_window_cover_image_set_visible ()

void                rc_ui_main_window_cover_image_set_visible
                                                        (gboolean visible);

Set the visibilty of the cover image widget.

visible :

whether the widget is visible

rc_ui_main_window_get_default_cover_image ()

GdkPixbuf *         rc_ui_main_window_get_default_cover_image
                                                        ();

Get the default cover image of the player.

Returns :

The default cover image. [transfer none]

rc_ui_main_window_get_widget ()

GtkWidget *         rc_ui_main_window_get_widget        ();

Get the main window widget. If the widget is not initialized yet, it will be initialized.

Returns :

The main window widget. [transfer none]

rc_ui_main_window_lyric_labels_get_visible ()

gboolean            rc_ui_main_window_lyric_labels_get_visible
                                                        ();

Get the visibilty of the lyric label widgets.

Returns :

Whether the widget is visible.

rc_ui_main_window_lyric_labels_set_visible ()

void                rc_ui_main_window_lyric_labels_set_visible
                                                        (gboolean visible);

Set the visibilty of the lyric label widgets.

visible :

whether the widget is visible

rc_ui_main_window_playlist_scrolled_window_set_horizontal_policy ()

void                rc_ui_main_window_playlist_scrolled_window_set_horizontal_policy
                                                        (gboolean state);

Set the horizontal policy state of the playlist scrolled window.

state :

the policy state

rc_ui_main_window_present_main_window ()

void                rc_ui_main_window_present_main_window
                                                        ();

Present the main window, if it is hided.


rc_ui_main_window_set_keep_above_state ()

void                rc_ui_main_window_set_keep_above_state
                                                        (gboolean state);

Keep the player above the other windows. Notice that it depends on the Window Manager, in some WMs, it may has no effect.

state :

the new state

rc_ui_main_window_show ()

void                rc_ui_main_window_show              ();

Show the main window of the player.


rc_ui_main_window_spectrum_get_visible ()

gboolean            rc_ui_main_window_spectrum_get_visible
                                                        ();

rc_ui_main_window_spectrum_set_style ()

void                rc_ui_main_window_spectrum_set_style
                                                        (guint style);

Set the visualize style of the spectrum widget in the player.

style :

the visualize style

rc_ui_main_window_spectrum_set_visible ()

void                rc_ui_main_window_spectrum_set_visible
                                                        (gboolean visible);

Set the visibilty of the spectrum show widget.

visible :

whether the widget is visible

Signal Details

The "keep-above-changed" signal

void                user_function                      (RCUiMainWindow *window,
                                                        gboolean        state,
                                                        gpointer        user_data)      : Run First

The ::keep-above-changed signal is emitted when the keep above state of the main window changed.

window :

the RCUiMainWindow that received the signal

state :

the state

user_data :

user data set when the signal handler was connected.