Shell Reference Manual: ShellWM

## ShellWM ShellWM |

## Synopsis

    struct              ShellWMClass;
    ShellWM *           shell_wm_new                        (MetaPlugin *plugin);
    void                shell_wm_completed_minimize         (ShellWM *wm,
                                                             MetaWindowActor *actor);
    void                shell_wm_completed_maximize         (ShellWM *wm,
                                                             MetaWindowActor *actor);
    void                shell_wm_completed_unmaximize       (ShellWM *wm,
                                                             MetaWindowActor *actor);
    void                shell_wm_completed_map              (ShellWM *wm,
                                                             MetaWindowActor *actor);
    void                shell_wm_completed_destroy          (ShellWM *wm,
                                                             MetaWindowActor *actor);
    void                shell_wm_completed_switch_workspace (ShellWM *wm);
    void                shell_wm_complete_display_change    (ShellWM *wm,
                                                             gboolean ok);
                        ShellWM;

## Object Hierarchy

      GObject
       +----ShellWM

## Signals

      "confirm-display-change"                         : Run Last
      "destroy"                                        : Run Last
      "filter-keybinding"                              : Run Last
      "kill-switch-workspace"                          : Run Last
      "kill-window-effects"                            : Run Last
      "map"                                            : Run Last
      "maximize"                                       : Run Last
      "minimize"                                       : Run Last
      "switch-workspace"                               : Run Last
      "unmaximize"                                     : Run Last

## Description

## Details

### struct ShellWMClass

    struct ShellWMClass {
      GObjectClass parent_class;
    };

### shell_wm_new ()

    ShellWM *           shell_wm_new                        (MetaPlugin *plugin);

Creates a new window management interface by hooking into `plugin`.

`plugin` : | the MetaPlugin
Returns : | the new window-management interface

### shell_wm_completed_minimize ()

    void                shell_wm_completed_minimize         (ShellWM *wm,
                                                             MetaWindowActor *actor);

The plugin must call this when it has completed a window minimize effect.

`wm` : | the ShellWM
`actor` : | the MetaWindowActor actor

### shell_wm_completed_maximize ()

    void                shell_wm_completed_maximize         (ShellWM *wm,
                                                             MetaWindowActor *actor);

The plugin must call this when it has completed a window maximize effect.

`wm` : | the ShellWM
`actor` : | the MetaWindowActor actor

### shell_wm_completed_unmaximize ()

    void                shell_wm_completed_unmaximize       (ShellWM *wm,
                                                             MetaWindowActor *actor);

The plugin must call this when it has completed a window unmaximize effect.

`wm` : | the ShellWM
`actor` : | the MetaWindowActor actor

### shell_wm_completed_map ()

    void                shell_wm_completed_map              (ShellWM *wm,
                                                             MetaWindowActor *actor);

The plugin must call this when it has completed a window map effect.

`wm` : | the ShellWM
`actor` : | the MetaWindowActor actor

### shell_wm_completed_destroy ()

    void                shell_wm_completed_destroy          (ShellWM *wm,
                                                             MetaWindowActor *actor);

The plugin must call this when it has completed a window destroy effect.

`wm` : | the ShellWM
`actor` : | the MetaWindowActor actor

### shell_wm_completed_switch_workspace ()

    void                shell_wm_completed_switch_workspace (ShellWM *wm);

The plugin must call this when it has finished switching the workspace.

`wm` : | the ShellWM

### shell_wm_complete_display_change ()

    void                shell_wm_complete_display_change    (ShellWM *wm,
                                                             gboolean ok);

The plugin must call this after the user responded to the confirmation dialog.

`wm` : | the ShellWM
`ok` : | if the new configuration was OK

### ShellWM

    typedef struct _ShellWM ShellWM;

## Signal Details

### The `"confirm-display-change"` signal

    void                user_function                      (ShellWM *shellwm,
                                                            gpointer user_data)      : Run Last

### The `"destroy"` signal

    void                user_function                      (ShellWM         *shellwm,
                                                            MetaWindowActor *arg1,
                                                            gpointer         user_data)      : Run Last

### The `"filter-keybinding"` signal

    gboolean            user_function                      (ShellWM        *shellwm,
                                                            MetaKeyBinding *arg1,
                                                            gpointer        user_data)      : Run Last

### The `"kill-switch-workspace"` signal

    void                user_function                      (ShellWM *shellwm,
                                                            gpointer user_data)      : Run Last

### The `"kill-window-effects"` signal

    void                user_function                      (ShellWM         *shellwm,
                                                            MetaWindowActor *arg1,
                                                            gpointer         user_data)      : Run Last

### The `"map"` signal

    void                user_function                      (ShellWM         *shellwm,
                                                            MetaWindowActor *arg1,
                                                            gpointer         user_data)      : Run Last

### The `"maximize"` signal

    void                user_function                      (ShellWM         *shellwm,
                                                            MetaWindowActor *arg1,
                                                            gint             arg2,
                                                            gint             arg3,
                                                            gint             arg4,
                                                            gint             arg5,
                                                            gpointer         user_data)      : Run Last

### The `"minimize"` signal

    void                user_function                      (ShellWM         *shellwm,
                                                            MetaWindowActor *arg1,
                                                            gpointer         user_data)      : Run Last

### The `"switch-workspace"` signal

    void                user_function                      (ShellWM *shellwm,
                                                            gint     arg1,
                                                            gint     arg2,
                                                            gint     arg3,
                                                            gpointer user_data)      : Run Last

### The `"unmaximize"` signal

    void                user_function                      (ShellWM         *shellwm,
                                                            MetaWindowActor *arg1,
                                                            gint             arg2,
                                                            gint             arg3,
                                                            gint             arg4,
                                                            gint             arg5,
                                                            gpointer         user_data)      : Run Last