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

# gnome-preferences

## Name

gnome-preferences -- Fetching and setting GNOME preferences

## Synopsis

    #include <gnome.h>

    struct      GnomePreferences;
    void        gnome_preferences_load          (void);
    void        gnome_preferences_save          (void);
    void        gnome_preferences_load_custom   (GnomePreferences *settings);
    void        gnome_preferences_save_custom   (GnomePreferences *settings);
    GtkButtonBoxStyle gnome_preferences_get_button_layout
                                                (void);
    void        gnome_preferences_set_button_layout
                                                (GtkButtonBoxStyle style);
    gboolean    gnome_preferences_get_statusbar_dialog
                                                (void);
    void        gnome_preferences_set_statusbar_dialog
                                                (gboolean statusbar);
    gboolean    gnome_preferences_get_statusbar_interactive
                                                (void);
    void        gnome_preferences_set_statusbar_interactive
                                                (gboolean b);
    gboolean    gnome_preferences_get_statusbar_meter_on_right
                                                (void);
    void        gnome_preferences_set_statusbar_meter_on_right
                                                (gboolean status_meter_on_right);
    gboolean    gnome_preferences_get_menubar_detachable
                                                (void);
    void        gnome_preferences_set_menubar_detachable
                                                (gboolean b);
    gboolean    gnome_preferences_get_menubar_relief
                                                (void);
    void        gnome_preferences_set_menubar_relief
                                                (gboolean b);
    gboolean    gnome_preferences_get_toolbar_detachable
                                                (void);
    void        gnome_preferences_set_toolbar_detachable
                                                (gboolean b);
    gboolean    gnome_preferences_get_toolbar_relief
                                                (void);
    void        gnome_preferences_set_toolbar_relief
                                                (gboolean b);
    gboolean    gnome_preferences_get_toolbar_relief_btn
                                                (void);
    void        gnome_preferences_set_toolbar_relief_btn
                                                (gboolean b);
    gboolean    gnome_preferences_get_toolbar_lines
                                                (void);
    void        gnome_preferences_set_toolbar_lines
                                                (gboolean b);
    gboolean    gnome_preferences_get_toolbar_labels
                                                (void);
    void        gnome_preferences_set_toolbar_labels
                                                (gboolean b);
    gboolean    gnome_preferences_get_dialog_centered
                                                (void);
    void        gnome_preferences_set_dialog_centered
                                                (gboolean b);
    GtkWindowType gnome_preferences_get_dialog_type
                                                (void);
    void        gnome_preferences_set_dialog_type
                                                (GtkWindowType t);
    GtkWindowPosition gnome_preferences_get_dialog_position
                                                (void);
    void        gnome_preferences_set_dialog_position
                                                (GtkWindowPosition p);
    GnomeMDIMode gnome_preferences_get_mdi_mode (void);
    void        gnome_preferences_set_mdi_mode  (GnomeMDIMode m);
    GtkPositionType gnome_preferences_get_mdi_tab_pos
                                                (void);
    void        gnome_preferences_set_mdi_tab_pos
                                                (GtkPositionType p);
    int         gnome_preferences_get_property_box_apply
                                                (void);
    void        gnome_preferences_set_property_box_button_apply
                                                (int v);
    gboolean    gnome_preferences_get_menus_have_tearoff
                                                (void);
    void        gnome_preferences_set_menus_have_tearoff
                                                (gboolean b);
    int         gnome_preferences_get_menus_have_icons
                                                (void);
    void        gnome_preferences_set_menus_have_icons
                                                (int have_icons);
    int         gnome_preferences_get_disable_imlib_cache
                                                (void);
    void        gnome_preferences_set_disable_imlib_cache
                                                (int disable_imlib_cache);

## Description

Routines used for loading, saving and accessing the various user preferences that are part of the GNOME configuration. gnome_init() calls gnome_preferences_load() at startup.

## Details

### struct GnomePreferences

    struct GnomePreferences {
      GtkButtonBoxStyle dialog_buttons_style;
      int property_box_buttons_ok : 1;
      int property_box_buttons_apply : 1;
      int property_box_buttons_close : 1;
      int property_box_buttons_help : 1;
      int statusbar_not_dialog : 1;
      int statusbar_is_interactive : 1;
      int statusbar_meter_on_right : 1;
      int menubar_detachable : 1;
      int menubar_relief : 1;
      int toolbar_detachable : 1;
      int toolbar_relief : 1;
      int toolbar_relief_btn : 1;
      int toolbar_lines : 1;
      int toolbar_labels : 1;
      int dialog_centered : 1;
      int menus_have_tearoff : 1;
      int menus_have_icons : 1;
      int disable_imlib_cache : 1;
      GtkWindowType dialog_type;
      GtkWindowPosition dialog_position;
      GnomeMDIMode mdi_mode;
      GtkPositionType mdi_tab_pos;
    };

### gnome_preferences_load ()

    void        gnome_preferences_load          (void);

Uses gnome_config_xxx() API to load a standard set of GNOME preferences into the default GNOME preferences object.

### gnome_preferences_save ()

    void        gnome_preferences_save          (void);

Uses gnome_config_xxx() API to store a standard set of GNOME preferences using info in the default GNOME preferences object.

### gnome_preferences_load_custom ()

    void        gnome_preferences_load_custom   (GnomePreferences *settings);

Uses gnome_config_xxx() interface to load a set of standard GNOME preferences into the specified `settings` object.

`settings` : | App-specified set of user preferences

### gnome_preferences_save_custom ()

    void        gnome_preferences_save_custom   (GnomePreferences *settings);

Uses gnome_config_xxx() interface to store a set of standard GNOME preferences from info in the `settings` object.

`settings` : | App-specified set of user preferences

### gnome_preferences_get_button_layout ()

    GtkButtonBoxStyle gnome_preferences_get_button_layout
                                                (void);

Obtain the button style from the default GNOME preferences object.

Returns : | Enumerated type indicating the default GNOME dialog button style.

### gnome_preferences_set_button_layout ()

    void        gnome_preferences_set_button_layout
                                                (GtkButtonBoxStyle style);

Set the default GNOME preferences object's default button style.

`style` : | Enumerated type indicating the default GNOME dialog button style.

### gnome_preferences_get_statusbar_dialog ()

    gboolean    gnome_preferences_get_statusbar_dialog
                                                (void);

Determine whether or not the statusbar is a dialog.

Returns : | `FALSE` if statusbar is a dialog, `TRUE` if not.

### gnome_preferences_set_statusbar_dialog ()

    void        gnome_preferences_set_statusbar_dialog
                                                (gboolean statusbar);

Indicate whether or not the default for GNOME status bars is a dialog.

`statusbar` : |

### gnome_preferences_get_statusbar_interactive ()

    gboolean    gnome_preferences_get_statusbar_interactive
                                                (void);

Determine whether or not the statusbar is interactive.

Returns : | `TRUE` if statusbar is interactive, `FALSE` if not.

### gnome_preferences_set_statusbar_interactive ()

    void        gnome_preferences_set_statusbar_interactive
                                                (gboolean b);

Indicate whether or not the GNOME status bars are, by default, interactive.

`b` : | `TRUE` if statusbar is interactive, `FALSE` if not.

### gnome_preferences_get_statusbar_meter_on_right ()

    gboolean    gnome_preferences_get_statusbar_meter_on_right
                                                (void);

Determine whether or not the statusbar's meter is on the right-hand side.

Returns : | `TRUE` if statusbar meter is on the right side, `FALSE` if not.

### gnome_preferences_set_statusbar_meter_on_right ()

    void        gnome_preferences_set_statusbar_meter_on_right
                                                (gboolean status_meter_on_right);

Indicate whether or not the GNOME status bars are, by default, on the right-hand side.

`status_meter_on_right` : |

### gnome_preferences_get_menubar_detachable ()

    gboolean    gnome_preferences_get_menubar_detachable
                                                (void);

Determine whether or not a menu bar is, by default, detachable from its parent frame.

Returns : | `TRUE` if menu bars are detachable, `FALSE` if not.

### gnome_preferences_set_menubar_detachable ()

    void        gnome_preferences_set_menubar_detachable
                                                (gboolean b);

Indicate whether or not the GNOME menu bars are, by default, detachable from their parent frame.

`b` : | `TRUE` if menu bars are detachable, `FALSE` if not.

### gnome_preferences_get_menubar_relief ()

    gboolean    gnome_preferences_get_menubar_relief
                                                (void);

Returns : | the relieft settings for the menubar.

### gnome_preferences_set_menubar_relief ()

    void        gnome_preferences_set_menubar_relief
                                                (gboolean b);

`b` : |

### gnome_preferences_get_toolbar_detachable ()

    gboolean    gnome_preferences_get_toolbar_detachable
                                                (void);

Returns : |

### gnome_preferences_set_toolbar_detachable ()

    void        gnome_preferences_set_toolbar_detachable
                                                (gboolean b);

`b` : |

### gnome_preferences_get_toolbar_relief ()

    gboolean    gnome_preferences_get_toolbar_relief
                                                (void);

Returns : |

### gnome_preferences_set_toolbar_relief ()

    void        gnome_preferences_set_toolbar_relief
                                                (gboolean b);

`b` : |

### gnome_preferences_get_toolbar_relief_btn ()

    gboolean    gnome_preferences_get_toolbar_relief_btn
                                                (void);

Returns : |

### gnome_preferences_set_toolbar_relief_btn ()

    void        gnome_preferences_set_toolbar_relief_btn
                                                (gboolean b);

`b` : |

### gnome_preferences_get_toolbar_lines ()

    gboolean    gnome_preferences_get_toolbar_lines
                                                (void);

Returns : |

### gnome_preferences_set_toolbar_lines ()

    void        gnome_preferences_set_toolbar_lines
                                                (gboolean b);

`b` : |

### gnome_preferences_get_toolbar_labels ()

    gboolean    gnome_preferences_get_toolbar_labels
                                                (void);

Returns : |

### gnome_preferences_set_toolbar_labels ()

    void        gnome_preferences_set_toolbar_labels
                                                (gboolean b);

`b` : |

### gnome_preferences_get_dialog_centered ()

    gboolean    gnome_preferences_get_dialog_centered
                                                (void);

Returns : |

### gnome_preferences_set_dialog_centered ()

    void        gnome_preferences_set_dialog_centered
                                                (gboolean b);

`b` : |

### gnome_preferences_get_dialog_type ()

    GtkWindowType gnome_preferences_get_dialog_type
                                                (void);

Returns : |

### gnome_preferences_set_dialog_type ()

    void        gnome_preferences_set_dialog_type
                                                (GtkWindowType t);

`t` : |

### gnome_preferences_get_dialog_position ()

    GtkWindowPosition gnome_preferences_get_dialog_position
                                                (void);

Returns : |

### gnome_preferences_set_dialog_position ()

    void        gnome_preferences_set_dialog_position
                                                (GtkWindowPosition p);

`p` : |

### gnome_preferences_get_mdi_mode ()

    GnomeMDIMode gnome_preferences_get_mdi_mode (void);

Returns : |

### gnome_preferences_set_mdi_mode ()

    void        gnome_preferences_set_mdi_mode  (GnomeMDIMode m);

`m` : |

### gnome_preferences_get_mdi_tab_pos ()

    GtkPositionType gnome_preferences_get_mdi_tab_pos
                                                (void);

Returns : |

### gnome_preferences_set_mdi_tab_pos ()

    void        gnome_preferences_set_mdi_tab_pos
                                                (GtkPositionType p);

`p` : |

### gnome_preferences_get_property_box_apply ()

    int         gnome_preferences_get_property_box_apply
                                                (void);

Returns : |

### gnome_preferences_set_property_box_button_apply ()

    void        gnome_preferences_set_property_box_button_apply
                                                (int v);

`v` : |

### gnome_preferences_get_menus_have_tearoff ()

    gboolean    gnome_preferences_get_menus_have_tearoff
                                                (void);

Returns : |

### gnome_preferences_set_menus_have_tearoff ()

    void        gnome_preferences_set_menus_have_tearoff
                                                (gboolean b);

`b` : |

### gnome_preferences_get_menus_have_icons ()

    int         gnome_preferences_get_menus_have_icons
                                                (void);

Returns : |

### gnome_preferences_set_menus_have_icons ()

    void        gnome_preferences_set_menus_have_icons
                                                (int have_icons);

`have_icons` : |

### gnome_preferences_get_disable_imlib_cache ()

    int         gnome_preferences_get_disable_imlib_cache
                                                (void);

Returns : |

### gnome_preferences_set_disable_imlib_cache ()

    void        gnome_preferences_set_disable_imlib_cache
                                                (int disable_imlib_cache);

`disable_imlib_cache` : |

## See Also

gnome_init(), gnome_init_with_popt_table()

<<< Previous Page | Home | Up | Next Page >>>
gnome-popup-menu | gnome-properties