Gnome User Interface Library Reference Manual
<<< Previous Page | Home | Up | Next Page >>>

# gnome-mdi-session

## Name

gnome-mdi-session -- Routines providing GnomeMDI state saving and restoration

## Synopsis

    #include <gnome.h>

    GnomeMDIChild* (*GnomeMDIChildCreator)      (const gchar*);
    gboolean    gnome_mdi_restore_state         (GnomeMDI *mdi,
                                                 const char *section,
                                                 GnomeMDIChildCreator child_create_func);
    void        gnome_mdi_save_state            (GnomeMDI *mdi,
                                                 const gchar *section);

## Description

In order to simplify saving the state of MDI and its children, the GnomeMDI interface provides a function that saves its layout and the state of its children (provided by each child through get_config_string virtual function defined in GnomeMDIChild subclasses) and a function that restores a previously saved state, recreating the children from their configuration strings using a function provided by the programmer.

## Details

### GnomeMDIChildCreator ()

    GnomeMDIChild* (*GnomeMDIChildCreator)      (const gchar*);

`Param1` : |
Returns : |

### gnome_mdi_restore_state ()

    gboolean    gnome_mdi_restore_state         (GnomeMDI *mdi,
                                                 const char *section,
                                                 GnomeMDIChildCreator child_create_func);

Restores the MDI state. Children are recreated with `create_child_func` that restores information about a child from a config string that was provided during saving state by the child.

`mdi` : | A pointer to a GnomeMDI object.
`section` : | Name of the section to restore MDI state from.
`child_create_func` : |
Returns : | TRUE if state was successfully restored, FALSE otherwise.

### gnome_mdi_save_state ()

    void        gnome_mdi_save_state            (GnomeMDI *mdi,
                                                 const gchar *section);

Saves MDI state to the application's config file in section `section`.

`mdi` : | A pointer to a GnomeMDI object.
`section` : | Name of the section that the MDI config should be saved to.

<<< Previous Page | Home | Up | Next Page >>>
gnome-init | gnome-popup-help