HeFullscreenButton

HeFullscreenButton — A semi-transparent button to leave fullscreen mode.

Synopsis

                    HeFullscreenButton;
HeFullscreenButton* he_fullscreen_button_new            (GtkWindow *window);
void                he_fullscreen_button_disable        (HeFullscreenButton *self);
void                he_fullscreen_button_enable         (HeFullscreenButton *self);
GtkWidget*          he_fullscreen_button_get_overlay    (HeFullscreenButton *self);
GtkWindow*          he_fullscreen_button_get_window     (HeFullscreenButton *self);

Object Hierarchy

  GObject
   +----HeFullscreenButton

Properties

  "act-on-state-change"      gboolean              : Read / Write

Signals

  "clicked"                                        : Run Last

Description

HeFullscreenButton is a semi transparent button which is automatically displayed whenever it's parent window enters fullscreen state. It's always displayed in the lower right corner of the parent window.

The button is automatically hidden after 5 seconds of mouse click inactivity. If the user clicks the parent window the button is shown for another 5 second.

If the user clicks the button, the "clicked" signal is emitted. If you did not provide a signal handler for the "clicked" signal, then the default handler will call gtk_window_unfullscreen() on the parent window. If you provide a signal handler, the default handler will not be called at all.

So, if your application has just one window. It will be enough, if you create an instance of HeFullscreenButton with this window as parent. Now if your window switches to fullscreen the HeFullscreenButton is automatically shown and can be used to leave fullscreen mode. In this case you don't have to provide a signal handler and you don't have to take care of the buttons destruction.

Details

HeFullscreenButton

typedef struct _HeFullscreenButton HeFullscreenButton;


he_fullscreen_button_new ()

HeFullscreenButton* he_fullscreen_button_new            (GtkWindow *window);

window :
Returns :

he_fullscreen_button_disable ()

void                he_fullscreen_button_disable        (HeFullscreenButton *self);

self :

he_fullscreen_button_enable ()

void                he_fullscreen_button_enable         (HeFullscreenButton *self);

self :

he_fullscreen_button_get_overlay ()

GtkWidget*          he_fullscreen_button_get_overlay    (HeFullscreenButton *self);

self :
Returns :

he_fullscreen_button_get_window ()

GtkWindow*          he_fullscreen_button_get_window     (HeFullscreenButton *self);

self :
Returns :

Property Details

The "act-on-state-change" property

  "act-on-state-change"      gboolean              : Read / Write

Whether to automatically enable/disable the button when its parent window fullscreens/unfullscreens itself.

Default value: TRUE

Signal Details

The "clicked" signal

void                user_function                      (HeFullscreenButton *arg0,
                                                        gpointer            user_data)      : Run Last

Emitted when the HeFullscreenButton was clicked by the user.

user_data : user data set when the signal handler was connected.