Preferences: Muffin Reference Manual

## Preferences Preferences — Muffin 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 ()
MetaVirtualModifier | meta_prefs_get_mouse_button_zoom_mods ()
gboolean | meta_prefs_get_mouse_zoom_enabled ()
guint | meta_prefs_get_mouse_button_resize ()
guint | meta_prefs_get_mouse_button_menu ()
CDesktopFocusMode | meta_prefs_get_focus_mode ()
CDesktopFocusNewWindows | 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_workspace_cycle ()
gboolean | meta_prefs_get_dynamic_workspaces ()
gboolean | meta_prefs_get_unredirect_fullscreen_windows ()
gboolean | meta_prefs_get_application_based ()
gboolean | meta_prefs_get_disable_workarounds ()
gboolean | meta_prefs_get_auto_raise ()
int | meta_prefs_get_auto_raise_delay ()
gboolean | meta_prefs_get_gnome_accessibility ()
gboolean | meta_prefs_get_gnome_animations ()
gboolean | meta_prefs_get_edge_tiling ()
gboolean | meta_prefs_get_edge_resistance_window ()
const char * | meta_prefs_get_screenshot_command ()
const char * | meta_prefs_get_window_screenshot_command ()
const char * | meta_prefs_get_terminal_command ()
void | meta_prefs_get_button_layout ()
CDesktopTitlebarAction | meta_prefs_get_action_double_click_titlebar ()
CDesktopTitlebarAction | meta_prefs_get_action_middle_click_titlebar ()
CDesktopTitlebarAction | meta_prefs_get_action_right_click_titlebar ()
CDesktopTitlebarScrollAction | meta_prefs_get_action_scroll_wheel_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_compositing_manager ()
void | meta_prefs_set_force_fullscreen ()
gboolean | meta_prefs_get_workspaces_only_on_primary ()
int | meta_prefs_get_draggable_border_width ()
int | meta_prefs_get_tile_hud_threshold ()
int | meta_prefs_get_resize_threshold ()
unsigned int * | meta_prefs_get_snap_modifier ()
gboolean | meta_prefs_get_legacy_snap ()
gboolean | meta_prefs_get_invert_flip_direction ()
gboolean | meta_prefs_get_tile_maximize ()
gint | meta_prefs_get_min_win_opacity ()
gint | meta_prefs_get_ui_scale ()
void | (*MetaKeyHandlerFunc) ()
GList * | meta_prefs_get_keybindings ()
MetaKeyBindingAction | meta_prefs_get_keybinding_action ()
void | meta_prefs_get_window_binding ()
gboolean | meta_prefs_get_visual_bell ()
gboolean | meta_prefs_bell_is_audible ()
CDesktopVisualBellType | meta_prefs_get_visual_bell_type ()
MetaPlacementMode | meta_prefs_get_placement_mode ()

## Types and Values

enum | MetaPreference
enum | MetaKeyBindingAction
enum | MetaKeyBindingFlags
| MetaKeyHandler

## Description

## Functions

### MetaPrefsChangedFunc ()

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

### meta_prefs_add_listener ()

    void
    meta_prefs_add_listener (MetaPrefsChangedFunc func,
                             gpointer data);

[skip]

### meta_prefs_remove_listener ()

    void
    meta_prefs_remove_listener (MetaPrefsChangedFunc func,
                                gpointer data);

[skip]

### 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_zoom_mods ()

    MetaVirtualModifier
    meta_prefs_get_mouse_button_zoom_mods (void);

### meta_prefs_get_mouse_zoom_enabled ()

    gboolean
    meta_prefs_get_mouse_zoom_enabled (void);

### meta_prefs_get_mouse_button_resize ()

    guint
    meta_prefs_get_mouse_button_resize (void);

### meta_prefs_get_mouse_button_menu ()

    guint
    meta_prefs_get_mouse_button_menu (void);

### meta_prefs_get_focus_mode ()

    CDesktopFocusMode
    meta_prefs_get_focus_mode (void);

### meta_prefs_get_focus_new_windows ()

    CDesktopFocusNewWindows
    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_workspace_cycle ()

    gboolean
    meta_prefs_get_workspace_cycle (void);

### meta_prefs_get_dynamic_workspaces ()

    gboolean
    meta_prefs_get_dynamic_workspaces (void);

### meta_prefs_get_unredirect_fullscreen_windows ()

    gboolean
    meta_prefs_get_unredirect_fullscreen_windows
                                   (void);

### meta_prefs_get_application_based ()

    gboolean
    meta_prefs_get_application_based (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_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_edge_resistance_window ()

    gboolean
    meta_prefs_get_edge_resistance_window (void);

### meta_prefs_get_screenshot_command ()

    const char *
    meta_prefs_get_screenshot_command (void);

### meta_prefs_get_window_screenshot_command ()

    const char *
    meta_prefs_get_window_screenshot_command
                                   (void);

### meta_prefs_get_terminal_command ()

    const char *
    meta_prefs_get_terminal_command (void);

### meta_prefs_get_button_layout ()

    void
    meta_prefs_get_button_layout (MetaButtonLayout *button_layout);

### meta_prefs_get_action_double_click_titlebar ()

    CDesktopTitlebarAction
    meta_prefs_get_action_double_click_titlebar
                                   (void);

### meta_prefs_get_action_middle_click_titlebar ()

    CDesktopTitlebarAction
    meta_prefs_get_action_middle_click_titlebar
                                   (void);

### meta_prefs_get_action_right_click_titlebar ()

    CDesktopTitlebarAction
    meta_prefs_get_action_right_click_titlebar
                                   (void);

### meta_prefs_get_action_scroll_wheel_titlebar ()

    CDesktopTitlebarScrollAction
    meta_prefs_get_action_scroll_wheel_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_compositing_manager ()

    void
    meta_prefs_set_compositing_manager (gboolean whether);

### 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_tile_hud_threshold ()

    int
    meta_prefs_get_tile_hud_threshold (void);

### meta_prefs_get_resize_threshold ()

    int
    meta_prefs_get_resize_threshold (void);

### meta_prefs_get_snap_modifier ()

    unsigned int *
    meta_prefs_get_snap_modifier (void);

### meta_prefs_get_legacy_snap ()

    gboolean
    meta_prefs_get_legacy_snap (void);

### meta_prefs_get_invert_flip_direction ()

    gboolean
    meta_prefs_get_invert_flip_direction (void);

### meta_prefs_get_tile_maximize ()

    gboolean
    meta_prefs_get_tile_maximize (void);

### meta_prefs_get_min_win_opacity ()

    gint
    meta_prefs_get_min_win_opacity (void);

### meta_prefs_get_ui_scale ()

    gint
    meta_prefs_get_ui_scale (void);

### MetaKeyHandlerFunc ()

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

#### Parameters

event | . | [type gpointer]

### meta_prefs_get_keybindings ()

    GList *
    meta_prefs_get_keybindings (void);

#### Returns

.

[element-type MetaKeyPref][transfer container]

### 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 ()

    CDesktopVisualBellType
    meta_prefs_get_visual_bell_type (void);

### meta_prefs_get_placement_mode ()

    MetaPlacementMode
    meta_prefs_get_placement_mode (void);

## Types and Values

### enum MetaPreference

#### Members

META_PREF_MOUSE_BUTTON_MODS |  |
META_PREF_FOCUS_MODE |  |
META_PREF_FOCUS_NEW_WINDOWS |  |
META_PREF_ATTACH_MODAL_DIALOGS |  |
META_PREF_RAISE_ON_CLICK |  |
META_PREF_ACTION_DOUBLE_CLICK_TITLEBAR |  |
META_PREF_ACTION_MIDDLE_CLICK_TITLEBAR |  |
META_PREF_ACTION_RIGHT_CLICK_TITLEBAR |  |
META_PREF_ACTION_SCROLL_WHEEL_TITLEBAR |  |
META_PREF_AUTO_RAISE |  |
META_PREF_AUTO_RAISE_DELAY |  |
META_PREF_THEME |  |
META_PREF_TITLEBAR_FONT |  |
META_PREF_NUM_WORKSPACES |  |
META_PREF_DYNAMIC_WORKSPACES |  |
META_PREF_UNREDIRECT_FULLSCREEN_WINDOWS |  |
META_PREF_APPLICATION_BASED |  |
META_PREF_KEYBINDINGS |  |
META_PREF_DISABLE_WORKAROUNDS |  |
META_PREF_BUTTON_LAYOUT |  |
META_PREF_WORKSPACE_NAMES |  |
META_PREF_WORKSPACE_CYCLE |  |
META_PREF_VISUAL_BELL |  |
META_PREF_AUDIBLE_BELL |  |
META_PREF_VISUAL_BELL_TYPE |  |
META_PREF_GNOME_ANIMATIONS |  |
META_PREF_CURSOR_THEME |  |
META_PREF_CURSOR_SIZE |  |
META_PREF_RESIZE_WITH_RIGHT_BUTTON |  |
META_PREF_EDGE_TILING |  |
META_PREF_FORCE_FULLSCREEN |  |
META_PREF_EDGE_RESISTANCE_WINDOW |  |
META_PREF_WORKSPACES_ONLY_ON_PRIMARY |  |
META_PREF_DRAGGABLE_BORDER_WIDTH |  |
META_PREF_TILE_HUD_THRESHOLD |  |
META_PREF_RESIZE_THRESHOLD |  |
META_PREF_SNAP_MODIFIER |  |
META_PREF_LEGACY_SNAP |  |
META_PREF_INVERT_WORKSPACE_FLIP_DIRECTION |  |
META_PREF_TILE_MAXIMIZE |  |
META_PREF_PLACEMENT_MODE |  |
META_PREF_MIN_WIN_OPACITY |  |
META_PREF_MOUSE_ZOOM_ENABLED |  |
META_PREF_MOUSE_BUTTON_ZOOM_MODS |  |

### enum MetaKeyBindingAction

#### Members

META_KEYBINDING_ACTION_NONE |  |
META_KEYBINDING_ACTION_WORKSPACE_1 |  |
META_KEYBINDING_ACTION_WORKSPACE_2 |  |
META_KEYBINDING_ACTION_WORKSPACE_3 |  |
META_KEYBINDING_ACTION_WORKSPACE_4 |  |
META_KEYBINDING_ACTION_WORKSPACE_5 |  |
META_KEYBINDING_ACTION_WORKSPACE_6 |  |
META_KEYBINDING_ACTION_WORKSPACE_7 |  |
META_KEYBINDING_ACTION_WORKSPACE_8 |  |
META_KEYBINDING_ACTION_WORKSPACE_9 |  |
META_KEYBINDING_ACTION_WORKSPACE_10 |  |
META_KEYBINDING_ACTION_WORKSPACE_11 |  |
META_KEYBINDING_ACTION_WORKSPACE_12 |  |
META_KEYBINDING_ACTION_WORKSPACE_LEFT |  |
META_KEYBINDING_ACTION_WORKSPACE_RIGHT |  |
META_KEYBINDING_ACTION_WORKSPACE_UP |  |
META_KEYBINDING_ACTION_WORKSPACE_DOWN |  |
META_KEYBINDING_ACTION_SWITCH_GROUP |  |
META_KEYBINDING_ACTION_SWITCH_GROUP_BACKWARD |  |
META_KEYBINDING_ACTION_SWITCH_WINDOWS |  |
META_KEYBINDING_ACTION_SWITCH_WINDOWS_BACKWARD |  |
META_KEYBINDING_ACTION_SWITCH_PANELS |  |
META_KEYBINDING_ACTION_SWITCH_PANELS_BACKWARD |  |
META_KEYBINDING_ACTION_CYCLE_GROUP |  |
META_KEYBINDING_ACTION_CYCLE_GROUP_BACKWARD |  |
META_KEYBINDING_ACTION_CYCLE_WINDOWS |  |
META_KEYBINDING_ACTION_CYCLE_WINDOWS_BACKWARD |  |
META_KEYBINDING_ACTION_CYCLE_PANELS |  |
META_KEYBINDING_ACTION_CYCLE_PANELS_BACKWARD |  |
META_KEYBINDING_ACTION_TAB_POPUP_SELECT |  |
META_KEYBINDING_ACTION_TAB_POPUP_CANCEL |  |
META_KEYBINDING_ACTION_SHOW_DESKTOP |  |
META_KEYBINDING_ACTION_PANEL_RUN_DIALOG |  |
META_KEYBINDING_ACTION_TOGGLE_RECORDING |  |
META_KEYBINDING_ACTION_SET_SPEW_MARK |  |
META_KEYBINDING_ACTION_ACTIVATE_WINDOW_MENU |  |
META_KEYBINDING_ACTION_TOGGLE_FULLSCREEN |  |
META_KEYBINDING_ACTION_TOGGLE_MAXIMIZED |  |
META_KEYBINDING_ACTION_PUSH_TILE_LEFT |  |
META_KEYBINDING_ACTION_PUSH_TILE_RIGHT |  |
META_KEYBINDING_ACTION_PUSH_TILE_UP |  |
META_KEYBINDING_ACTION_PUSH_TILE_DOWN |  |
META_KEYBINDING_ACTION_PUSH_SNAP_LEFT |  |
META_KEYBINDING_ACTION_PUSH_SNAP_RIGHT |  |
META_KEYBINDING_ACTION_PUSH_SNAP_UP |  |
META_KEYBINDING_ACTION_PUSH_SNAP_DOWN |  |
META_KEYBINDING_ACTION_TOGGLE_ABOVE |  |
META_KEYBINDING_ACTION_MAXIMIZE |  |
META_KEYBINDING_ACTION_UNMAXIMIZE |  |
META_KEYBINDING_ACTION_TOGGLE_SHADED |  |
META_KEYBINDING_ACTION_MINIMIZE |  |
META_KEYBINDING_ACTION_CLOSE |  |
META_KEYBINDING_ACTION_BEGIN_MOVE |  |
META_KEYBINDING_ACTION_BEGIN_RESIZE |  |
META_KEYBINDING_ACTION_TOGGLE_ON_ALL_WORKSPACES |  |
META_KEYBINDING_ACTION_MOVE_TO_WORKSPACE_1 |  |
META_KEYBINDING_ACTION_MOVE_TO_WORKSPACE_2 |  |
META_KEYBINDING_ACTION_MOVE_TO_WORKSPACE_3 |  |
META_KEYBINDING_ACTION_MOVE_TO_WORKSPACE_4 |  |
META_KEYBINDING_ACTION_MOVE_TO_WORKSPACE_5 |  |
META_KEYBINDING_ACTION_MOVE_TO_WORKSPACE_6 |  |
META_KEYBINDING_ACTION_MOVE_TO_WORKSPACE_7 |  |
META_KEYBINDING_ACTION_MOVE_TO_WORKSPACE_8 |  |
META_KEYBINDING_ACTION_MOVE_TO_WORKSPACE_9 |  |
META_KEYBINDING_ACTION_MOVE_TO_WORKSPACE_10 |  |
META_KEYBINDING_ACTION_MOVE_TO_WORKSPACE_11 |  |
META_KEYBINDING_ACTION_MOVE_TO_WORKSPACE_12 |  |
META_KEYBINDING_ACTION_MOVE_TO_WORKSPACE_LEFT |  |
META_KEYBINDING_ACTION_MOVE_TO_WORKSPACE_RIGHT |  |
META_KEYBINDING_ACTION_MOVE_TO_WORKSPACE_UP |  |
META_KEYBINDING_ACTION_MOVE_TO_WORKSPACE_DOWN |  |
META_KEYBINDING_ACTION_MOVE_TO_WORKSPACE_NEW |  |
META_KEYBINDING_ACTION_MOVE_TO_MONITOR_LEFT |  |
META_KEYBINDING_ACTION_MOVE_TO_MONITOR_RIGHT |  |
META_KEYBINDING_ACTION_MOVE_TO_MONITOR_DOWN |  |
META_KEYBINDING_ACTION_MOVE_TO_MONITOR_UP |  |
META_KEYBINDING_ACTION_RAISE_OR_LOWER |  |
META_KEYBINDING_ACTION_RAISE |  |
META_KEYBINDING_ACTION_LOWER |  |
META_KEYBINDING_ACTION_MAXIMIZE_VERTICALLY |  |
META_KEYBINDING_ACTION_MAXIMIZE_HORIZONTALLY |  |
META_KEYBINDING_ACTION_MOVE_TO_CORNER_NW |  |
META_KEYBINDING_ACTION_MOVE_TO_CORNER_NE |  |
META_KEYBINDING_ACTION_MOVE_TO_CORNER_SW |  |
META_KEYBINDING_ACTION_MOVE_TO_CORNER_SE |  |
META_KEYBINDING_ACTION_MOVE_TO_SIDE_N |  |
META_KEYBINDING_ACTION_MOVE_TO_SIDE_S |  |
META_KEYBINDING_ACTION_MOVE_TO_SIDE_E |  |
META_KEYBINDING_ACTION_MOVE_TO_SIDE_W |  |
META_KEYBINDING_ACTION_MOVE_TO_CENTER |  |
META_KEYBINDING_ACTION_INCREASE_OPACITY |  |
META_KEYBINDING_ACTION_DECREASE_OPACITY |  |
META_KEYBINDING_ACTION_CUSTOM |  |
META_KEYBINDING_ACTION_LAST |  |

### enum MetaKeyBindingFlags

#### Members

META_KEY_BINDING_NONE |  |
META_KEY_BINDING_PER_WINDOW |  |
META_KEY_BINDING_BUILTIN |  |
META_KEY_BINDING_REVERSES |  |
META_KEY_BINDING_IS_REVERSED |  |

### MetaKeyHandler

    typedef struct _MetaKeyHandler MetaKeyHandler;