GdlDockLayout

GdlDockLayout

Synopsis

                    GdlDockLayout;
                    GdlDockLayoutClass;
                    GdlDockLayoutPrivate;
GdlDockLayout *     gdl_dock_layout_new                 (GdlDock *dock);
void                gdl_dock_layout_attach              (GdlDockLayout *layout,
                                                         GdlDockMaster *master);
gboolean            gdl_dock_layout_load_layout         (GdlDockLayout *layout,
                                                         const gchar *name);
void                gdl_dock_layout_save_layout         (GdlDockLayout *layout,
                                                         const gchar *name);
void                gdl_dock_layout_delete_layout       (GdlDockLayout *layout,
                                                         const gchar *name);
GList *             gdl_dock_layout_get_layouts         (GdlDockLayout *layout,
                                                         gboolean include_default);
void                gdl_dock_layout_run_manager         (GdlDockLayout *layout);
gboolean            gdl_dock_layout_load_from_file      (GdlDockLayout *layout,
                                                         const gchar *filename);
gboolean            gdl_dock_layout_save_to_file        (GdlDockLayout *layout,
                                                         const gchar *filename);
gboolean            gdl_dock_layout_is_dirty            (GdlDockLayout *layout);
GtkWidget *         gdl_dock_layout_get_layouts_ui      (GdlDockLayout *layout);

Object Hierarchy

  GObject
   +----GdlDockLayout

Properties

  "dirty"                    gboolean              : Read
  "master"                   GdlDockMaster*        : Read / Write

Description

Details

GdlDockLayout

typedef struct _GdlDockLayout GdlDockLayout;

GdlDockLayoutClass

typedef struct {
    GObjectClass  g_object_class;
} GdlDockLayoutClass;

GdlDockLayoutPrivate

typedef struct _GdlDockLayoutPrivate GdlDockLayoutPrivate;

gdl_dock_layout_new ()

GdlDockLayout *     gdl_dock_layout_new                 (GdlDock *dock);

dock :

 The dock item. Creates a new GdlDockLayout

Returns :

 New GdlDockLayout item.

gdl_dock_layout_attach ()

void                gdl_dock_layout_attach              (GdlDockLayout *layout,
                                                         GdlDockMaster *master);

Attach the layout to the master and delete the reference to the master that the layout attached previously

layout :

 The layout item

master :

 The master item to which the layout will be attached

gdl_dock_layout_load_layout ()

gboolean            gdl_dock_layout_load_layout         (GdlDockLayout *layout,
                                                         const gchar *name);

Loads the layout with the given name to the memory. This will set "dirty" to TRUE.

See also gdl_dock_layout_load_from_file()

layout :

 The dock item.

name :

 The name of the layout to load.

Returns :

 TRUE if layout successfully loaded else FALSE

gdl_dock_layout_save_layout ()

void                gdl_dock_layout_save_layout         (GdlDockLayout *layout,
                                                         const gchar *name);

Saves the layout with the given name to the memory. This will set "dirty" to TRUE.

See also gdl_dock_layout_save_to_file().

layout :

 The dock item.

name :

 The name of the layout to save.

gdl_dock_layout_delete_layout ()

void                gdl_dock_layout_delete_layout       (GdlDockLayout *layout,
                                                         const gchar *name);

Deletes the layout with the given name from the memory. This will set "dirty" to TRUE.

layout :

 The dock item.

name :

 The name of the layout to delete.

gdl_dock_layout_get_layouts ()

GList *             gdl_dock_layout_get_layouts         (GdlDockLayout *layout,
                                                         gboolean include_default);

gdl_dock_layout_run_manager ()

void                gdl_dock_layout_run_manager         (GdlDockLayout *layout);

Runs the layout manager.

layout :

 The dock item.

gdl_dock_layout_load_from_file ()

gboolean            gdl_dock_layout_load_from_file      (GdlDockLayout *layout,
                                                         const gchar *filename);

Loads the layout from file with the given filename. This will set "dirty" to FALSE.

layout :

 The layout item.

filename :

 The name of the file to load.

Returns :

 TRUE if layout successfully loaded else FALSE

gdl_dock_layout_save_to_file ()

gboolean            gdl_dock_layout_save_to_file        (GdlDockLayout *layout,
                                                         const gchar *filename);

This function saves the current layout in XML format to the file with the given filename.

layout :

 The layout item.

filename :

 Name of the file we want to save in layout

Returns :

 TRUE if layout successfuly save to the file, otherwise FALSE.

gdl_dock_layout_is_dirty ()

gboolean            gdl_dock_layout_is_dirty            (GdlDockLayout *layout);

Checks whether the XML tree in memory is different from the file where the layout was saved.

layout :

 The layout item.

Returns :

 TRUE is the layout in the memory is different from the file, else FALSE.

gdl_dock_layout_get_layouts_ui ()

GtkWidget *         gdl_dock_layout_get_layouts_ui      (GdlDockLayout *layout);

Property Details

The "dirty" property

  "dirty"                    gboolean              : Read

True if the layouts have changed and need to be saved to a file.

Default value: FALSE

The "master" property

  "master"                   GdlDockMaster*        : Read / Write

GdlDockMaster object which the layout object is attached to.

Generated by GTK-Doc V1.15.1