wnck_screen_get_default ()

WnckScreen *
wnck_screen_get_default (void);

Gets the default WnckScreen on the default display.

wnck_screen_get ()

WnckScreen *
wnck_screen_get (int index);

Gets the WnckScreen for a given screen on the default display.

wnck_screen_get_for_root ()

WnckScreen *
wnck_screen_get_for_root (gulong root_window_id);

Gets the WnckScreen for the root window at root_window_id , or NULL if no WnckScreen exists for this root window.

This function does not work if wnck_screen_get() was not called for the sought WnckScreen before, and returns NULL.

wnck_screen_get_number ()

int
wnck_screen_get_number (WnckScreen *screen);

Gets the index of screen on the display to which it belongs. The first WnckScreen has an index of 0.

Since: 2.20

wnck_screen_get_width ()

int
wnck_screen_get_width (WnckScreen *screen);

Gets the width of screen .

wnck_screen_get_height ()

int
wnck_screen_get_height (WnckScreen *screen);

Gets the height of screen .

wnck_screen_force_update ()

void
wnck_screen_force_update (WnckScreen *screen);

Synchronously and immediately updates the list of WnckWindow on screen . This bypasses the standard update mechanism, where the list of WnckWindow is updated in the idle loop.

This is usually a bad idea for both performance and correctness reasons (to get things right, you need to write model-view code that tracks changes, not get a static list of open windows). However, this function can be useful for small applications that just do something and then exit.

wnck_screen_get_window_manager_name ()

const char *
wnck_screen_get_window_manager_name (WnckScreen *screen);

Gets the name of the window manager.

Since: 2.20

wnck_screen_net_wm_supports ()

gboolean
wnck_screen_net_wm_supports (WnckScreen *screen,
                             const char *atom);

Gets whether the window manager for screen supports a certain hint from the Extended Window Manager Hints specification (EWMH).

When using this function, keep in mind that the window manager can change over time; so you should not use this function in a way that impacts persistent application state. A common bug is that your application can start up before the window manager does when the user logs in, and before the window manager starts wnck_screen_net_wm_supports() will return FALSE for every property.

See also gdk_x11_screen_supports_net_wm_hint() in GDK.

wnck_screen_get_active_window ()

WnckWindow *
wnck_screen_get_active_window (WnckScreen *screen);

Gets the active WnckWindow on screen . May return NULL sometimes, since not all window managers guarantee that a window is always active.

wnck_screen_get_previously_active_window ()

WnckWindow *
wnck_screen_get_previously_active_window
                               (WnckScreen *screen);

Gets the previously active WnckWindow on screen . May return NULL sometimes, since not all window managers guarantee that a window is always active.

Since: 2.8

wnck_screen_get_windows ()

GList *
wnck_screen_get_windows (WnckScreen *screen);

Gets the list of WnckWindow on screen . The list is not in a defined order, but should be "stable" (windows should not be reordered in it). However, the stability of the list is established by the window manager, so don't blame libwnck if it breaks down.

wnck_screen_get_windows_stacked ()

GList *
wnck_screen_get_windows_stacked (WnckScreen *screen);

Gets the list of WnckWindow on screen in bottom-to-top order.

wnck_screen_get_active_workspace ()

WnckWorkspace *
wnck_screen_get_active_workspace (WnckScreen *screen);

Gets the active WnckWorkspace on screen . May return NULL sometimes, if libwnck is in a weird state due to the asynchronous nature of the interaction with the window manager.

wnck_screen_get_workspaces ()

GList *
wnck_screen_get_workspaces (WnckScreen *screen);

Gets the list of WnckWorkspace on screen . The list is ordered: the first element in the list is the first WnckWorkspace, etc..

Since: 2.20

wnck_screen_get_workspace ()

WnckWorkspace *
wnck_screen_get_workspace (WnckScreen *screen,
                           int workspace);

Gets the WnckWorkspace numbered workspace on screen .

wnck_screen_get_workspace_count ()

int
wnck_screen_get_workspace_count (WnckScreen *screen);

Gets the number of WnckWorkspace on screen .

wnck_screen_change_workspace_count ()

void
wnck_screen_change_workspace_count (WnckScreen *screen,
                                    int count);

Asks the window manager to change the number of WnckWorkspace on screen .

Since: 2.2

wnck_screen_try_set_workspace_layout ()

int
wnck_screen_try_set_workspace_layout (WnckScreen *screen,
                                      int current_token,
                                      int rows,
                                      int columns);

Tries to modify the layout of WnckWorkspace on screen . To do this, tries to acquire ownership of the layout. If the current process is the owner of the layout, current_token is used to determine if the caller is the owner (there might be more than one part of the same process trying to set the layout). Since no more than one application should set this property of screen at a time, setting the layout is not guaranteed to work.

If rows is 0, the actual number of rows will be determined based on columns and the number of WnckWorkspace. If columns is 0, the actual number of columns will be determined based on rows and the number of WnckWorkspace. rows and columns must not be 0 at the same time.

You have to release the ownership of the layout with wnck_screen_release_workspace_layout() when you do not need it anymore.

wnck_screen_release_workspace_layout ()

void
wnck_screen_release_workspace_layout (WnckScreen *screen,
                                      int current_token);

Releases the ownership of the layout of WnckWorkspace on screen . current_token is used to verify that the caller is the owner of the layout. If the verification fails, nothing happens.

wnck_screen_calc_workspace_layout ()

void
wnck_screen_calc_workspace_layout (WnckScreen *screen,
                                   int num_workspaces,
                                   int space_index,
                                   WnckWorkspaceLayout *layout);

Calculates the layout of WnckWorkspace, with additional information like the row and column of the WnckWorkspace with index space_index .

Since: 2.12

wnck_screen_free_workspace_layout ()

void
wnck_screen_free_workspace_layout (WnckWorkspaceLayout *layout);

Frees the content of layout . This does not free layout itself, so you might want to free layout yourself after calling this.

Since: 2.12

wnck_screen_move_viewport ()

void
wnck_screen_move_viewport (WnckScreen *screen,
                           int x,
                           int y);

Asks the window manager to move the viewport of the current WnckWorkspace on screen .

Since: 2.4

wnck_screen_get_background_pixmap ()

gulong
wnck_screen_get_background_pixmap (WnckScreen *screen);

Gets the X window ID of the background pixmap of screen .

wnck_screen_get_showing_desktop ()

gboolean
wnck_screen_get_showing_desktop (WnckScreen *screen);

Gets whether screen is in the "showing the desktop" mode. This mode is changed when a “showing-desktop-changed” signal gets emitted.

Since: 2.2

wnck_screen_toggle_showing_desktop ()

void
wnck_screen_toggle_showing_desktop (WnckScreen *screen,
                                    gboolean show);

Asks the window manager to set the "showing the desktop" mode on screen according to show .

Since: 2.2

struct WnckScreen

struct WnckScreen;

The WnckScreen struct contains only private fields and should not be directly accessed.

struct WnckWorkspaceLayout

struct WnckWorkspaceLayout {
  int rows;
  int cols;
  int *grid;
  int grid_area;
  int current_row;
  int current_col;
};

The WnckWorkspaceLayout struct contains information about the layout of WnckWorkspace on a WnckScreen, and the exact position of a specific WnckWorkspace.

Since: 2.12

The “active-window-changed” signal

void
user_function (WnckScreen *screen,
               WnckWindow *previously_active_window,
               gpointer    user_data)

Emitted when the active window on screen has changed.

Flags: Run Last

The “active-workspace-changed” signal

void
user_function (WnckScreen    *screen,
               WnckWorkspace *previously_active_space,
               gpointer       user_data)

Emitted when the active workspace on screen has changed.

Flags: Run Last

The “application-closed” signal

void
user_function (WnckScreen      *screen,
               WnckApplication *app,
               gpointer         user_data)

Emitted when a WnckApplication is closed on screen .

Flags: Run Last

The “application-opened” signal

void
user_function (WnckScreen      *screen,
               WnckApplication *app,
               gpointer         user_data)

Emitted when a new WnckApplication is opened on screen .

Flags: Run Last

The “background-changed” signal

void
user_function (WnckScreen *screen,
               gpointer    user_data)

Emitted when the background on the root window of screen has changed.

Flags: Run Last

The “class-group-closed” signal

void
user_function (WnckScreen     *screen,
               WnckClassGroup *class_group,
               gpointer        user_data)

Emitted when a WnckClassGroup is closed on screen .

Flags: Run Last

Since: 2.20

The “class-group-opened” signal

void
user_function (WnckScreen     *screen,
               WnckClassGroup *class_group,
               gpointer        user_data)

Emitted when a new WnckClassGroup is opened on screen .

Flags: Run Last

Since: 2.20

The “showing-desktop-changed” signal

void
user_function (WnckScreen *screen,
               gpointer    user_data)

Emitted when "showing the desktop" mode of screen is toggled.

Flags: Run Last

Since: 2.20

The “viewports-changed” signal

void
user_function (WnckScreen *screen,
               gpointer    user_data)

Emitted when a viewport position has changed in a WnckWorkspace of screen or when a WnckWorkspace of screen gets or loses its viewport.

Flags: Run Last

Since: 2.20

The “window-closed” signal

void
user_function (WnckScreen *screen,
               WnckWindow *window,
               gpointer    user_data)

Emitted when a WnckWindow is closed on screen .

Flags: Run Last

The “window-manager-changed” signal

void
user_function (WnckScreen *screen,
               gpointer    user_data)

Emitted when the window manager on screen has changed.

Flags: Run Last

Since: 2.20

The “window-opened” signal

void
user_function (WnckScreen *screen,
               WnckWindow *window,
               gpointer    user_data)

Emitted when a new WnckWindow is opened on screen .

Flags: Run Last

The “window-stacking-changed” signal

void
user_function (WnckScreen *screen,
               gpointer    user_data)

Emitted when the stacking order of WnckWindow on screen has changed.

Flags: Run Last

The “workspace-created” signal

void
user_function (WnckScreen    *screen,
               WnckWorkspace *space,
               gpointer       user_data)

Emitted when a WnckWorkspace is created on screen .

Flags: Run Last

The “workspace-destroyed” signal

void
user_function (WnckScreen    *screen,
               WnckWorkspace *space,
               gpointer       user_data)

Emitted when a WnckWorkspace is destroyed on screen .

Flags: Run Last