DtWsmAddWorkspaceModifiedCallback(3) — Subroutines

CDE

NAME

DtWsmAddWorkspaceModifiedCallback − add a callback to be called when any workspace is changed

SYNOPSIS

#include <Dt/Wsm.h> DtWsmCBContext DtWsmAddWorkspaceModifiedCallback(Widget widget, DtWsmWsModifiedProc ws_change, Pointer client_data);

DESCRIPTION

The DtWsmAddWorkspaceModifiedCallback function works with the workspace manager CDE workspace manager, dtwm1, and registers a function to be called when a workspace is added, deleted or modified.

The widget argument is a realized widget.

The ws_change argument is the procedure to be called when a workspace is modified.

The client_data argument points to arbitrary client data to be passed back to ws_change.

The header defines the DtWsmWsModifiedProc callback prototype as follows:

typedef void (∗DtWsmWsModifiedProc)(Widget widget,
Atom aWorkspace,
DtWsmWsReason reason,
Pointer client_data);

The widget argument is the ID of the widget to be registered with the callback.

The aWorkspace argument is the name of the new current workspace (converted to an X atom).

The reason argument is a type of modification:
A new workspace was added.
The backdrop for the workspace changed.
A different workspace was made the current workspace.
A workspace was deleted.
The workspace title changed.

The client_data argument points to the client data to be registered with the callback.

RETURN VALUE

Upon successful completion, the DtWsmAddWorkspaceModifiedCallback function returns a workspace callback registration context.

APPLICATION USAGE

The DtWsmAddWorkspaceModifiedCallback function returns a registration context that the application must save in order to remove this callback later.

DtWsmAddWorkspaceModifiedCallback requires a window; thus, a gadget is not acceptable for the widget argument.

The DtWsmRemoveWorkspaceCallback3 function needs a registration context to remove the callback.