Mutter Reference Manual: Preferences

## Preferences Preferences — Mutter preferences |

## Functions

void | (*MetaPrefsChangedFunc) ()
void | meta_prefs_add_listener ()
void | meta_prefs_remove_listener ()
void | meta_prefs_init ()
void | meta_prefs_override_preference_schema ()
const char * | meta_preference_to_string ()
MetaVirtualModifier | meta_prefs_get_mouse_button_mods ()
gint | meta_prefs_get_mouse_button_resize ()
gint | meta_prefs_get_mouse_button_menu ()
GDesktopFocusMode | meta_prefs_get_focus_mode ()
GDesktopFocusNewWindows | meta_prefs_get_focus_new_windows ()
gboolean | meta_prefs_get_attach_modal_dialogs ()
gboolean | meta_prefs_get_raise_on_click ()
const char * | meta_prefs_get_theme ()
const PangoFontDescription * | meta_prefs_get_titlebar_font ()
int | meta_prefs_get_num_workspaces ()
gboolean | meta_prefs_get_dynamic_workspaces ()
gboolean | meta_prefs_get_disable_workarounds ()
gboolean | meta_prefs_get_auto_raise ()
int | meta_prefs_get_auto_raise_delay ()
gboolean | meta_prefs_get_focus_change_on_pointer_rest ()
gboolean | meta_prefs_get_gnome_accessibility ()
gboolean | meta_prefs_get_gnome_animations ()
gboolean | meta_prefs_get_edge_tiling ()
gboolean | meta_prefs_get_auto_maximize ()
void | meta_prefs_get_button_layout ()
GDesktopTitlebarAction | meta_prefs_get_action_double_click_titlebar ()
GDesktopTitlebarAction | meta_prefs_get_action_middle_click_titlebar ()
GDesktopTitlebarAction | meta_prefs_get_action_right_click_titlebar ()
void | meta_prefs_set_num_workspaces ()
const char * | meta_prefs_get_workspace_name ()
void | meta_prefs_change_workspace_name ()
const char * | meta_prefs_get_cursor_theme ()
int | meta_prefs_get_cursor_size ()
gboolean | meta_prefs_get_compositing_manager ()
gboolean | meta_prefs_get_force_fullscreen ()
void | meta_prefs_set_force_fullscreen ()
gboolean | meta_prefs_get_workspaces_only_on_primary ()
int | meta_prefs_get_draggable_border_width ()
gboolean | meta_prefs_get_ignore_request_hide_titlebar ()
void | meta_prefs_set_ignore_request_hide_titlebar ()
void | (*MetaKeyHandlerFunc) ()
MetaKeyBindingAction | meta_prefs_get_keybinding_action ()
void | meta_prefs_get_window_binding ()
gboolean | meta_prefs_get_visual_bell ()
gboolean | meta_prefs_bell_is_audible ()
GDesktopVisualBellType | meta_prefs_get_visual_bell_type ()

## Types and Values

enum | MetaPreference
enum | MetaKeyBindingAction
enum | MetaKeyBindingFlags

## Description

## Functions

### MetaPrefsChangedFunc ()

    void
    (*MetaPrefsChangedFunc) (MetaPreference pref,
                             gpointer user_data);

### meta_prefs_add_listener ()

    void
    meta_prefs_add_listener (MetaPrefsChangedFunc func,
                             gpointer user_data);

#### Parameters

func | a MetaPrefsChangedFunc |
user_data | data passed to the function |

### meta_prefs_remove_listener ()

    void
    meta_prefs_remove_listener (MetaPrefsChangedFunc func,
                                gpointer user_data);

#### Parameters

func | a MetaPrefsChangedFunc |
user_data | data passed to the function |

### meta_prefs_init ()

    void
    meta_prefs_init (void);

### meta_prefs_override_preference_schema ()

    void
    meta_prefs_override_preference_schema (const char *key,
                                           const char *schema);

Specify a schema whose keys are used to override the standard Metacity keys. This might be used if a plugin expected a different value for some preference than the Metacity default. While this function can be called at any point, this function should generally be called in a plugin's constructor, rather than in its `start()` method so the preference isn't first loaded with one value then changed to another value.

#### Parameters

key | the preference name |
schema | new schema for preference `key` |

### meta_preference_to_string ()

    const char *
    meta_preference_to_string (MetaPreference pref);

### meta_prefs_get_mouse_button_mods ()

    MetaVirtualModifier
    meta_prefs_get_mouse_button_mods (void);

### meta_prefs_get_mouse_button_resize ()

    gint
    meta_prefs_get_mouse_button_resize (void);

### meta_prefs_get_mouse_button_menu ()

    gint
    meta_prefs_get_mouse_button_menu (void);

### meta_prefs_get_focus_mode ()

    GDesktopFocusMode
    meta_prefs_get_focus_mode (void);

### meta_prefs_get_focus_new_windows ()

    GDesktopFocusNewWindows
    meta_prefs_get_focus_new_windows (void);

### meta_prefs_get_attach_modal_dialogs ()

    gboolean
    meta_prefs_get_attach_modal_dialogs (void);

### meta_prefs_get_raise_on_click ()

    gboolean
    meta_prefs_get_raise_on_click (void);

### meta_prefs_get_theme ()

    const char *
    meta_prefs_get_theme (void);

### meta_prefs_get_titlebar_font ()

    const PangoFontDescription *
    meta_prefs_get_titlebar_font (void);

### meta_prefs_get_num_workspaces ()

    int
    meta_prefs_get_num_workspaces (void);

### meta_prefs_get_dynamic_workspaces ()

    gboolean
    meta_prefs_get_dynamic_workspaces (void);

### meta_prefs_get_disable_workarounds ()

    gboolean
    meta_prefs_get_disable_workarounds (void);

### meta_prefs_get_auto_raise ()

    gboolean
    meta_prefs_get_auto_raise (void);

### meta_prefs_get_auto_raise_delay ()

    int
    meta_prefs_get_auto_raise_delay (void);

### meta_prefs_get_focus_change_on_pointer_rest ()

    gboolean
    meta_prefs_get_focus_change_on_pointer_rest
                                   (void);

### meta_prefs_get_gnome_accessibility ()

    gboolean
    meta_prefs_get_gnome_accessibility (void);

### meta_prefs_get_gnome_animations ()

    gboolean
    meta_prefs_get_gnome_animations (void);

### meta_prefs_get_edge_tiling ()

    gboolean
    meta_prefs_get_edge_tiling (void);

### meta_prefs_get_auto_maximize ()

    gboolean
    meta_prefs_get_auto_maximize (void);

### meta_prefs_get_button_layout ()

    void
    meta_prefs_get_button_layout (MetaButtonLayout *button_layout);

#### Parameters

button_layout | . | [out]

### meta_prefs_get_action_double_click_titlebar ()

    GDesktopTitlebarAction
    meta_prefs_get_action_double_click_titlebar
                                   (void);

### meta_prefs_get_action_middle_click_titlebar ()

    GDesktopTitlebarAction
    meta_prefs_get_action_middle_click_titlebar
                                   (void);

### meta_prefs_get_action_right_click_titlebar ()

    GDesktopTitlebarAction
    meta_prefs_get_action_right_click_titlebar
                                   (void);

### meta_prefs_set_num_workspaces ()

    void
    meta_prefs_set_num_workspaces (int n_workspaces);

### meta_prefs_get_workspace_name ()

    const char *
    meta_prefs_get_workspace_name (int i);

### meta_prefs_change_workspace_name ()

    void
    meta_prefs_change_workspace_name (int i,
                                      const char *name);

### meta_prefs_get_cursor_theme ()

    const char *
    meta_prefs_get_cursor_theme (void);

### meta_prefs_get_cursor_size ()

    int
    meta_prefs_get_cursor_size (void);

### meta_prefs_get_compositing_manager ()

    gboolean
    meta_prefs_get_compositing_manager (void);

### meta_prefs_get_force_fullscreen ()

    gboolean
    meta_prefs_get_force_fullscreen (void);

### meta_prefs_set_force_fullscreen ()

    void
    meta_prefs_set_force_fullscreen (gboolean whether);

### meta_prefs_get_workspaces_only_on_primary ()

    gboolean
    meta_prefs_get_workspaces_only_on_primary
                                   (void);

### meta_prefs_get_draggable_border_width ()

    int
    meta_prefs_get_draggable_border_width (void);

### meta_prefs_get_ignore_request_hide_titlebar ()

    gboolean
    meta_prefs_get_ignore_request_hide_titlebar
                                   (void);

### meta_prefs_set_ignore_request_hide_titlebar ()

    void
    meta_prefs_set_ignore_request_hide_titlebar
                                   (gboolean whether);

### MetaKeyHandlerFunc ()

    void
    (*MetaKeyHandlerFunc) (MetaDisplay *display,
                           MetaScreen *screen,
                           MetaWindow *window,
                           ClutterKeyEvent *event,
                           MetaKeyBinding *binding,
                           gpointer user_data);

#### Parameters

display | a MetaDisplay |
screen | a MetaScreen |
window | a MetaWindow |
event | a ClutterKeyEvent. | [type gpointer]
binding | a MetaKeyBinding |
user_data | data passed to the function |

### meta_prefs_get_keybinding_action ()

    MetaKeyBindingAction
    meta_prefs_get_keybinding_action (const char *name);

### meta_prefs_get_window_binding ()

    void
    meta_prefs_get_window_binding (const char *name,
                                   unsigned int *keysym,
                                   MetaVirtualModifier *modifiers);

### meta_prefs_get_visual_bell ()

    gboolean
    meta_prefs_get_visual_bell (void);

### meta_prefs_bell_is_audible ()

    gboolean
    meta_prefs_bell_is_audible (void);

### meta_prefs_get_visual_bell_type ()

    GDesktopVisualBellType
    meta_prefs_get_visual_bell_type (void);

## Types and Values

### enum MetaPreference

#### Members

META_PREF_MOUSE_BUTTON_MODS | mouse button modifiers |
META_PREF_FOCUS_MODE | focus mode |
META_PREF_FOCUS_NEW_WINDOWS | focus new windows |
META_PREF_ATTACH_MODAL_DIALOGS | attach modal dialogs |
META_PREF_RAISE_ON_CLICK | raise on click |
META_PREF_ACTION_DOUBLE_CLICK_TITLEBAR | action double click titlebar |
META_PREF_ACTION_MIDDLE_CLICK_TITLEBAR | action middle click titlebar |
META_PREF_ACTION_RIGHT_CLICK_TITLEBAR | action right click titlebar |
META_PREF_AUTO_RAISE | auto-raise |
META_PREF_AUTO_RAISE_DELAY | auto-raise delay |
META_PREF_FOCUS_CHANGE_ON_POINTER_REST | focus change on pointer rest |
META_PREF_THEME | theme |
META_PREF_TITLEBAR_FONT | title-bar font |
META_PREF_NUM_WORKSPACES | number of workspaces |
META_PREF_DYNAMIC_WORKSPACES | dynamic workspaces |
META_PREF_KEYBINDINGS | keybindings |
META_PREF_DISABLE_WORKAROUNDS | disable workarounds |
META_PREF_BUTTON_LAYOUT | button layout |
META_PREF_WORKSPACE_NAMES | workspace names |
META_PREF_VISUAL_BELL | visual bell |
META_PREF_AUDIBLE_BELL | audible bell |
META_PREF_VISUAL_BELL_TYPE | visual bell type |
META_PREF_GNOME_ACCESSIBILITY | GNOME accessibility |
META_PREF_GNOME_ANIMATIONS | GNOME animations |
META_PREF_CURSOR_THEME | cursor theme |
META_PREF_CURSOR_SIZE | cursor size |
META_PREF_RESIZE_WITH_RIGHT_BUTTON | resize with right button |
META_PREF_EDGE_TILING | edge tiling |
META_PREF_FORCE_FULLSCREEN | force fullscreen |
META_PREF_WORKSPACES_ONLY_ON_PRIMARY | workspaces only on primary |
META_PREF_DRAGGABLE_BORDER_WIDTH | draggable border width |
META_PREF_AUTO_MAXIMIZE | auto-maximize |

### enum MetaKeyBindingAction

#### Members

META_KEYBINDING_ACTION_NONE | FILLME |
META_KEYBINDING_ACTION_WORKSPACE_1 | FILLME |
META_KEYBINDING_ACTION_WORKSPACE_2 | FILLME |
META_KEYBINDING_ACTION_WORKSPACE_3 | FILLME |
META_KEYBINDING_ACTION_WORKSPACE_4 | FILLME |
META_KEYBINDING_ACTION_WORKSPACE_5 | FILLME |
META_KEYBINDING_ACTION_WORKSPACE_6 | FILLME |
META_KEYBINDING_ACTION_WORKSPACE_7 | FILLME |
META_KEYBINDING_ACTION_WORKSPACE_8 | FILLME |
META_KEYBINDING_ACTION_WORKSPACE_9 | FILLME |
META_KEYBINDING_ACTION_WORKSPACE_10 | FILLME |
META_KEYBINDING_ACTION_WORKSPACE_11 | FILLME |
META_KEYBINDING_ACTION_WORKSPACE_12 | FILLME |
META_KEYBINDING_ACTION_WORKSPACE_LEFT | FILLME |
META_KEYBINDING_ACTION_WORKSPACE_RIGHT | FILLME |
META_KEYBINDING_ACTION_WORKSPACE_UP | FILLME |
META_KEYBINDING_ACTION_WORKSPACE_DOWN | FILLME |
META_KEYBINDING_ACTION_SWITCH_APPLICATIONS | FILLME |
META_KEYBINDING_ACTION_SWITCH_APPLICATIONS_BACKWARD | FILLME |
META_KEYBINDING_ACTION_SWITCH_GROUP | FILLME |
META_KEYBINDING_ACTION_SWITCH_GROUP_BACKWARD | FILLME |
META_KEYBINDING_ACTION_SWITCH_WINDOWS | FILLME |
META_KEYBINDING_ACTION_SWITCH_WINDOWS_BACKWARD | FILLME |
META_KEYBINDING_ACTION_SWITCH_PANELS | FILLME |
META_KEYBINDING_ACTION_SWITCH_PANELS_BACKWARD | FILLME |
META_KEYBINDING_ACTION_CYCLE_GROUP | FILLME |
META_KEYBINDING_ACTION_CYCLE_GROUP_BACKWARD | FILLME |
META_KEYBINDING_ACTION_CYCLE_WINDOWS | FILLME |
META_KEYBINDING_ACTION_CYCLE_WINDOWS_BACKWARD | FILLME |
META_KEYBINDING_ACTION_CYCLE_PANELS | FILLME |
META_KEYBINDING_ACTION_CYCLE_PANELS_BACKWARD | FILLME |
META_KEYBINDING_ACTION_SHOW_DESKTOP | FILLME |
META_KEYBINDING_ACTION_PANEL_MAIN_MENU | FILLME |
META_KEYBINDING_ACTION_PANEL_RUN_DIALOG | FILLME |
META_KEYBINDING_ACTION_TOGGLE_RECORDING | FILLME |
META_KEYBINDING_ACTION_SET_SPEW_MARK | FILLME |
META_KEYBINDING_ACTION_ACTIVATE_WINDOW_MENU | FILLME |
META_KEYBINDING_ACTION_TOGGLE_FULLSCREEN | FILLME |
META_KEYBINDING_ACTION_TOGGLE_MAXIMIZED | FILLME |
META_KEYBINDING_ACTION_TOGGLE_TILED_LEFT | FILLME |
META_KEYBINDING_ACTION_TOGGLE_TILED_RIGHT | FILLME |
META_KEYBINDING_ACTION_TOGGLE_ABOVE | FILLME |
META_KEYBINDING_ACTION_MAXIMIZE | FILLME |
META_KEYBINDING_ACTION_UNMAXIMIZE | FILLME |
META_KEYBINDING_ACTION_TOGGLE_SHADED | FILLME |
META_KEYBINDING_ACTION_MINIMIZE | FILLME |
META_KEYBINDING_ACTION_CLOSE | FILLME |
META_KEYBINDING_ACTION_BEGIN_MOVE | FILLME |
META_KEYBINDING_ACTION_BEGIN_RESIZE | FILLME |
META_KEYBINDING_ACTION_TOGGLE_ON_ALL_WORKSPACES | FILLME |
META_KEYBINDING_ACTION_MOVE_TO_WORKSPACE_1 | FILLME |
META_KEYBINDING_ACTION_MOVE_TO_WORKSPACE_2 | FILLME |
META_KEYBINDING_ACTION_MOVE_TO_WORKSPACE_3 | FILLME |
META_KEYBINDING_ACTION_MOVE_TO_WORKSPACE_4 | FILLME |
META_KEYBINDING_ACTION_MOVE_TO_WORKSPACE_5 | FILLME |
META_KEYBINDING_ACTION_MOVE_TO_WORKSPACE_6 | FILLME |
META_KEYBINDING_ACTION_MOVE_TO_WORKSPACE_7 | FILLME |
META_KEYBINDING_ACTION_MOVE_TO_WORKSPACE_8 | FILLME |
META_KEYBINDING_ACTION_MOVE_TO_WORKSPACE_9 | FILLME |
META_KEYBINDING_ACTION_MOVE_TO_WORKSPACE_10 | FILLME |
META_KEYBINDING_ACTION_MOVE_TO_WORKSPACE_11 | FILLME |
META_KEYBINDING_ACTION_MOVE_TO_WORKSPACE_12 | FILLME |
META_KEYBINDING_ACTION_MOVE_TO_WORKSPACE_LEFT | FILLME |
META_KEYBINDING_ACTION_MOVE_TO_WORKSPACE_RIGHT | FILLME |
META_KEYBINDING_ACTION_MOVE_TO_WORKSPACE_UP | FILLME |
META_KEYBINDING_ACTION_MOVE_TO_WORKSPACE_DOWN | FILLME |
META_KEYBINDING_ACTION_MOVE_TO_MONITOR_LEFT | FILLME |
META_KEYBINDING_ACTION_MOVE_TO_MONITOR_RIGHT | FILLME |
META_KEYBINDING_ACTION_MOVE_TO_MONITOR_UP | FILLME |
META_KEYBINDING_ACTION_MOVE_TO_MONITOR_DOWN | FILLME |
META_KEYBINDING_ACTION_RAISE_OR_LOWER | FILLME |
META_KEYBINDING_ACTION_RAISE | FILLME |
META_KEYBINDING_ACTION_LOWER | FILLME |
META_KEYBINDING_ACTION_MAXIMIZE_VERTICALLY | FILLME |
META_KEYBINDING_ACTION_MAXIMIZE_HORIZONTALLY | FILLME |
META_KEYBINDING_ACTION_MOVE_TO_CORNER_NW | FILLME |
META_KEYBINDING_ACTION_MOVE_TO_CORNER_NE | FILLME |
META_KEYBINDING_ACTION_MOVE_TO_CORNER_SW | FILLME |
META_KEYBINDING_ACTION_MOVE_TO_CORNER_SE | FILLME |
META_KEYBINDING_ACTION_MOVE_TO_SIDE_N | FILLME |
META_KEYBINDING_ACTION_MOVE_TO_SIDE_S | FILLME |
META_KEYBINDING_ACTION_MOVE_TO_SIDE_E | FILLME |
META_KEYBINDING_ACTION_MOVE_TO_SIDE_W | FILLME |
META_KEYBINDING_ACTION_MOVE_TO_CENTER | FILLME |
META_KEYBINDING_ACTION_OVERLAY_KEY | FILLME |
META_KEYBINDING_ACTION_ISO_NEXT_GROUP |  |
META_KEYBINDING_ACTION_ALWAYS_ON_TOP | FILLME |
META_KEYBINDING_ACTION_LAST | FILLME |

### enum MetaKeyBindingFlags

#### Members

META_KEY_BINDING_NONE | none |
META_KEY_BINDING_PER_WINDOW | per-window |
META_KEY_BINDING_BUILTIN | built-in |
META_KEY_BINDING_REVERSES | reverses |
META_KEY_BINDING_IS_REVERSED | is reversed |