matewnck_screen_get_default ()

MatewnckScreen *
matewnck_screen_get_default (void);

Gets the default MatewnckScreen on the default display.

matewnck_screen_get ()

MatewnckScreen *
matewnck_screen_get (int index);

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

matewnck_screen_get_for_root ()

MatewnckScreen *
matewnck_screen_get_for_root (gulong root_window_id);

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

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

matewnck_screen_get_number ()

int
matewnck_screen_get_number (MatewnckScreen *screen);

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

Since 2.20

matewnck_screen_get_width ()

int
matewnck_screen_get_width (MatewnckScreen *screen);

Gets the width of screen .

matewnck_screen_get_height ()

int
matewnck_screen_get_height (MatewnckScreen *screen);

Gets the height of screen .

matewnck_screen_force_update ()

void
matewnck_screen_force_update (MatewnckScreen *screen);

Synchronously and immediately updates the list of MatewnckWindow on screen . This bypasses the standard update mechanism, where the list of MatewnckWindow 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.

matewnck_screen_get_window_manager_name ()

const char *
matewnck_screen_get_window_manager_name
                               (MatewnckScreen *screen);

Gets the name of the window manager.

Since 2.20

matewnck_screen_net_wm_supports ()

gboolean
matewnck_screen_net_wm_supports (MatewnckScreen *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 matewnck_screen_net_wm_supports() will return FALSE for every property.

See also gdk_x11_screen_supports_net_wm_hint() in GDK.

matewnck_screen_get_active_window ()

MatewnckWindow *
matewnck_screen_get_active_window (MatewnckScreen *screen);

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

matewnck_screen_get_previously_active_window ()

MatewnckWindow *
matewnck_screen_get_previously_active_window
                               (MatewnckScreen *screen);

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

Since 2.8

matewnck_screen_get_windows ()

GList *
matewnck_screen_get_windows (MatewnckScreen *screen);

Gets the list of MatewnckWindow 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 libmatewnck if it breaks down.

matewnck_screen_get_windows_stacked ()

GList *
matewnck_screen_get_windows_stacked (MatewnckScreen *screen);

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

matewnck_screen_get_active_workspace ()

MatewnckWorkspace *
matewnck_screen_get_active_workspace (MatewnckScreen *screen);

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

matewnck_screen_get_workspaces ()

GList *
matewnck_screen_get_workspaces (MatewnckScreen *screen);

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

Since 2.20

matewnck_screen_get_workspace ()

MatewnckWorkspace *
matewnck_screen_get_workspace (MatewnckScreen *screen,
                               int workspace);

Gets the MatewnckWorkspace numbered workspace on screen .

matewnck_screen_get_workspace_index ()

int
matewnck_screen_get_workspace_index (MatewnckScreen *screen,
                                     MatewnckWorkspace *space);

Gets the index of space on screen . The first MatewnckWorkspace has an index of 0. See also matewnck_workspace_get_number().

Since 2.14

matewnck_screen_get_workspace_neighbor ()

MatewnckWorkspace *
matewnck_screen_get_workspace_neighbor
                               (MatewnckScreen *screen,
                                MatewnckWorkspace *space,
                                MatewnckMotionDirection direction);

Gets the neighbor MatewnckWorkspace of space in the direction direction on screen .

Since 2.14

matewnck_screen_get_workspace_count ()

int
matewnck_screen_get_workspace_count (MatewnckScreen *screen);

Gets the number of MatewnckWorkspace on screen .

matewnck_screen_change_workspace_count ()

void
matewnck_screen_change_workspace_count
                               (MatewnckScreen *screen,
                                int count);

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

Since 2.2

matewnck_screen_try_set_workspace_layout ()

int
matewnck_screen_try_set_workspace_layout
                               (MatewnckScreen *screen,
                                int current_token,
                                int rows,
                                int columns);

Tries to modify the layout of MatewnckWorkspace 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 MatewnckWorkspace. If columns is 0, the actual number of columns will be determined based on rows and the number of MatewnckWorkspace. rows and columns must not be 0 at the same time.

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

matewnck_screen_release_workspace_layout ()

void
matewnck_screen_release_workspace_layout
                               (MatewnckScreen *screen,
                                int current_token);

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

matewnck_screen_calc_workspace_layout ()

void
matewnck_screen_calc_workspace_layout (MatewnckScreen *screen,
                                       int num_workspaces,
                                       int space_index,
                                       MatewnckWorkspaceLayout *layout);

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

Since 2.12

matewnck_screen_free_workspace_layout ()

void
matewnck_screen_free_workspace_layout (MatewnckWorkspaceLayout *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

matewnck_screen_move_viewport ()

void
matewnck_screen_move_viewport (MatewnckScreen *screen,
                               int x,
                               int y);

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

Since 2.4

matewnck_screen_get_background_pixmap ()

gulong
matewnck_screen_get_background_pixmap (MatewnckScreen *screen);

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

matewnck_screen_get_showing_desktop ()

gboolean
matewnck_screen_get_showing_desktop (MatewnckScreen *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

matewnck_screen_toggle_showing_desktop ()

void
matewnck_screen_toggle_showing_desktop
                               (MatewnckScreen *screen,
                                gboolean show);

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

Since 2.2

struct MatewnckScreen

struct MatewnckScreen;

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

enum MatewnckMotionDirection

Type defining a direction in which to search a neighbor MatewnckWorkspace.

Since 2.14

struct MatewnckWorkspaceLayout

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

The MatewnckWorkspaceLayout struct contains information about the layout of MatewnckWorkspace on a MatewnckScreen, and the exact position of a specific MatewnckWorkspace.

Since 2.12

The “active-window-changed” signal

void
user_function (MatewnckScreen *screen,
               MatewnckWindow *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 (MatewnckScreen    *screen,
               MatewnckWorkspace *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 (MatewnckScreen      *screen,
               MatewnckApplication *app,
               gpointer             user_data)

Emitted when a MatewnckApplication is closed on screen .

Flags: Run Last

The “application-opened” signal

void
user_function (MatewnckScreen      *screen,
               MatewnckApplication *app,
               gpointer             user_data)

Emitted when a new MatewnckApplication is opened on screen .

Flags: Run Last

The “background-changed” signal

void
user_function (MatewnckScreen *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 (MatewnckScreen     *screen,
               MatewnckClassGroup *class_group,
               gpointer            user_data)

Emitted when a MatewnckClassGroup is closed on screen .

Flags: Run Last

Since 2.20

The “class-group-opened” signal

void
user_function (MatewnckScreen     *screen,
               MatewnckClassGroup *class_group,
               gpointer            user_data)

Emitted when a new MatewnckClassGroup is opened on screen .

Flags: Run Last

Since 2.20

The “showing-desktop-changed” signal

void
user_function (MatewnckScreen *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 (MatewnckScreen *screen,
               gpointer        user_data)

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

Flags: Run Last

Since 2.20

The “window-closed” signal

void
user_function (MatewnckScreen *screen,
               MatewnckWindow *window,
               gpointer        user_data)

Emitted when a MatewnckWindow is closed on screen .

Flags: Run Last

The “window-manager-changed” signal

void
user_function (MatewnckScreen *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 (MatewnckScreen *screen,
               MatewnckWindow *window,
               gpointer        user_data)

Emitted when a new MatewnckWindow is opened on screen .

Flags: Run Last

The “window-stacking-changed” signal

void
user_function (MatewnckScreen *screen,
               gpointer        user_data)

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

Flags: Run Last

The “workspace-created” signal

void
user_function (MatewnckScreen    *screen,
               MatewnckWorkspace *space,
               gpointer           user_data)

Emitted when a MatewnckWorkspace is created on screen .

Flags: Run Last

The “workspace-destroyed” signal

void
user_function (MatewnckScreen    *screen,
               MatewnckWorkspace *space,
               gpointer           user_data)

Emitted when a MatewnckWorkspace is destroyed on screen .

Flags: Run Last