GimpDockable

GimpDockable

Synopsis

#define             GIMP_DOCKABLE_DRAG_OFFSET
                    GimpDockable;
                    GimpDockablePrivate;
GtkWidget *         gimp_dockable_new                   (const gchar *name,
                                                         const gchar *blurb,
                                                         const gchar *stock_id,
                                                         const gchar *help_id);
void                gimp_dockable_set_dockbook          (GimpDockable *dockable,
                                                         GimpDockbook *dockbook);
GimpDockbook *      gimp_dockable_get_dockbook          (GimpDockable *dockable);
GimpTabStyle        gimp_dockable_get_tab_style         (GimpDockable *dockable);
const gchar *       gimp_dockable_get_name              (GimpDockable *dockable);
const gchar *       gimp_dockable_get_blurb             (GimpDockable *dockable);
const gchar *       gimp_dockable_get_help_id           (GimpDockable *dockable);
const gchar *       gimp_dockable_get_stock_id          (GimpDockable *dockable);
GtkWidget *         gimp_dockable_get_icon              (GimpDockable *dockable,
                                                         GtkIconSize size);
gboolean            gimp_dockable_get_locked            (GimpDockable *dockable);
void                gimp_dockable_set_drag_pos          (GimpDockable *dockable,
                                                         gint drag_x,
                                                         gint drag_y);
void                gimp_dockable_get_drag_pos          (GimpDockable *dockable,
                                                         gint *drag_x,
                                                         gint *drag_y);
GimpPanedBox *      gimp_dockable_get_drag_handler      (GimpDockable *dockable);
void                gimp_dockable_set_locked            (GimpDockable *dockable,
                                                         gboolean lock);
gboolean            gimp_dockable_is_locked             (GimpDockable *dockable);
void                gimp_dockable_set_tab_style         (GimpDockable *dockable,
                                                         GimpTabStyle tab_style);
gboolean            gimp_dockable_set_actual_tab_style  (GimpDockable *dockable,
                                                         GimpTabStyle tab_style);
GimpTabStyle        gimp_dockable_get_actual_tab_style  (GimpDockable *dockable);
GtkWidget *         gimp_dockable_create_tab_widget     (GimpDockable *dockable,
                                                         GimpContext *context,
                                                         GimpTabStyle tab_style,
                                                         GtkIconSize size);
GtkWidget *         gimp_dockable_create_drag_widget    (GimpDockable *dockable);
void                gimp_dockable_set_context           (GimpDockable *dockable,
                                                         GimpContext *context);
GimpUIManager *     gimp_dockable_get_menu              (GimpDockable *dockable,
                                                         const gchar **ui_path,
                                                         gpointer *popup_data);
void                gimp_dockable_set_drag_handler      (GimpDockable *dockable,
                                                         GimpPanedBox *drag_handler);
void                gimp_dockable_detach                (GimpDockable *dockable);
void                gimp_dockable_blink                 (GimpDockable *dockable);
void                gimp_dockable_blink_cancel          (GimpDockable *dockable);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkBin
                                 +----GimpDockable

Implemented Interfaces

GimpDockable implements AtkImplementorIface, GtkBuildable and GimpSessionManagedInterface.

Properties

  "locked"                   gboolean              : Read / Write

Style Properties

  "content-border"           gint                  : Read

Description

Details

GIMP_DOCKABLE_DRAG_OFFSET

#define GIMP_DOCKABLE_DRAG_OFFSET (-6)


GimpDockable

typedef struct _GimpDockable GimpDockable;

A kind of adpater to make other widgets dockable. The widget to dock is put inside the GimpDockable, which is put in a GimpDockbook.


GimpDockablePrivate

typedef struct _GimpDockablePrivate GimpDockablePrivate;


gimp_dockable_new ()

GtkWidget *         gimp_dockable_new                   (const gchar *name,
                                                         const gchar *blurb,
                                                         const gchar *stock_id,
                                                         const gchar *help_id);


gimp_dockable_set_dockbook ()

void                gimp_dockable_set_dockbook          (GimpDockable *dockable,
                                                         GimpDockbook *dockbook);


gimp_dockable_get_dockbook ()

GimpDockbook *      gimp_dockable_get_dockbook          (GimpDockable *dockable);


gimp_dockable_get_tab_style ()

GimpTabStyle        gimp_dockable_get_tab_style         (GimpDockable *dockable);


gimp_dockable_get_name ()

const gchar *       gimp_dockable_get_name              (GimpDockable *dockable);


gimp_dockable_get_blurb ()

const gchar *       gimp_dockable_get_blurb             (GimpDockable *dockable);


gimp_dockable_get_help_id ()

const gchar *       gimp_dockable_get_help_id           (GimpDockable *dockable);


gimp_dockable_get_stock_id ()

const gchar *       gimp_dockable_get_stock_id          (GimpDockable *dockable);


gimp_dockable_get_icon ()

GtkWidget *         gimp_dockable_get_icon              (GimpDockable *dockable,
                                                         GtkIconSize size);


gimp_dockable_get_locked ()

gboolean            gimp_dockable_get_locked            (GimpDockable *dockable);


gimp_dockable_set_drag_pos ()

void                gimp_dockable_set_drag_pos          (GimpDockable *dockable,
                                                         gint drag_x,
                                                         gint drag_y);


gimp_dockable_get_drag_pos ()

void                gimp_dockable_get_drag_pos          (GimpDockable *dockable,
                                                         gint *drag_x,
                                                         gint *drag_y);


gimp_dockable_get_drag_handler ()

GimpPanedBox *      gimp_dockable_get_drag_handler      (GimpDockable *dockable);


gimp_dockable_set_locked ()

void                gimp_dockable_set_locked            (GimpDockable *dockable,
                                                         gboolean lock);


gimp_dockable_is_locked ()

gboolean            gimp_dockable_is_locked             (GimpDockable *dockable);


gimp_dockable_set_tab_style ()

void                gimp_dockable_set_tab_style         (GimpDockable *dockable,
                                                         GimpTabStyle tab_style);


gimp_dockable_set_actual_tab_style ()

gboolean            gimp_dockable_set_actual_tab_style  (GimpDockable *dockable,
                                                         GimpTabStyle tab_style);

Sets actual tab style, meant for those that decides what "automatic" tab style means.

Returns :

TRUE if changed, FALSE otherwise.

gimp_dockable_get_actual_tab_style ()

GimpTabStyle        gimp_dockable_get_actual_tab_style  (GimpDockable *dockable);

Get actual tab style, i.e. never "automatic". This state should actually be hold on a per-dockbook basis, but at this point that feels like over-engineering...


gimp_dockable_create_tab_widget ()

GtkWidget *         gimp_dockable_create_tab_widget     (GimpDockable *dockable,
                                                         GimpContext *context,
                                                         GimpTabStyle tab_style,
                                                         GtkIconSize size);


gimp_dockable_create_drag_widget ()

GtkWidget *         gimp_dockable_create_drag_widget    (GimpDockable *dockable);


gimp_dockable_set_context ()

void                gimp_dockable_set_context           (GimpDockable *dockable,
                                                         GimpContext *context);


gimp_dockable_get_menu ()

GimpUIManager *     gimp_dockable_get_menu              (GimpDockable *dockable,
                                                         const gchar **ui_path,
                                                         gpointer *popup_data);


gimp_dockable_set_drag_handler ()

void                gimp_dockable_set_drag_handler      (GimpDockable *dockable,
                                                         GimpPanedBox *drag_handler);

Set a drag handler that will be asked if it will handle drag events before the dockbook handles the event itself.


gimp_dockable_detach ()

void                gimp_dockable_detach                (GimpDockable *dockable);


gimp_dockable_blink ()

void                gimp_dockable_blink                 (GimpDockable *dockable);


gimp_dockable_blink_cancel ()

void                gimp_dockable_blink_cancel          (GimpDockable *dockable);

Property Details

The "locked" property

  "locked"                   gboolean              : Read / Write

Default value: FALSE

Style Property Details

The "content-border" style property

  "content-border"           gint                  : Read

Allowed values: >= 0

Default value: 0