eina-dock-plugin

eina-dock-plugin

Synopsis

#define             EINA_DOCK_EXPANDED_KEY
#define             EINA_DOCK_ORDER_KEY
#define             EINA_DOCK_PREFERENCES_DOMAIN
#define             EINA_DOCK_WINDOW_H_KEY
#define             EINA_DOCK_WINDOW_W_KEY
EinaDockTab *       eina_application_add_dock_widget    (EinaApplication *application,
                                                         const gchar *id,
                                                         GtkWidget *widget,
                                                         GtkWidget *label,
                                                         EinaDockFlag flags);
EinaDock *          eina_application_get_dock           (EinaApplication *application);
gboolean            eina_application_remove_dock_widget (EinaApplication *application,
                                                         EinaDockTab *tab);
gboolean            eina_application_switch_dock_widget (EinaApplication *application,
                                                         EinaDockTab *tab);

Description

Details

EINA_DOCK_EXPANDED_KEY

#define EINA_DOCK_EXPANDED_KEY       "expanded"

EINA_DOCK_ORDER_KEY

#define EINA_DOCK_ORDER_KEY          "page-order"

EINA_DOCK_PREFERENCES_DOMAIN

#define EINA_DOCK_PREFERENCES_DOMAIN EINA_DOMAIN".preferences.dock"

EINA_DOCK_WINDOW_H_KEY

#define EINA_DOCK_WINDOW_H_KEY       "window-height"

EINA_DOCK_WINDOW_W_KEY

#define EINA_DOCK_WINDOW_W_KEY       "window-width"

eina_application_add_dock_widget ()

EinaDockTab *       eina_application_add_dock_widget    (EinaApplication *application,
                                                         const gchar *id,
                                                         GtkWidget *widget,
                                                         GtkWidget *label,
                                                         EinaDockFlag flags);

Adds the widget into the application's docks

application :

An EinaApplication

id :

Unique ID to identify the widget

widget :

Widget to add

label :

Widget to use as label

flags :

Flags

Returns :

The EinaDockTab. [transfer none]

eina_application_get_dock ()

EinaDock *          eina_application_get_dock           (EinaApplication *application);

Gets the EinaDock from EinaApplication

application :

An EinaApplication

Returns :

The EinaDock. [transfer none]

eina_application_remove_dock_widget ()

gboolean            eina_application_remove_dock_widget (EinaApplication *application,
                                                         EinaDockTab *tab);

Removes tab from the application dock

application :

An EinaApplication

tab :

An EinaDockTab. [transfer none]

Returns :

TRUE on successful.

eina_application_switch_dock_widget ()

gboolean            eina_application_switch_dock_widget (EinaApplication *application,
                                                         EinaDockTab *tab);

Switches visible dock tab to tab

application :

An EinaApplication

tab :

An EinaDockTab. [transfer none]

Returns :

TRUE on successful.