14.1.6 Setting and Reading the WM_HINTS Property

Xlib provides functions that you can use to set and read the WM_HINTS property for a given window. These functions use the flags and the XWMHints structure, as defined in the X11/Xutil.h header file.
Xlib には指定されたウィンドウに対して WM_HINTS プロパティの読み書きを行うための関数が用意されている。 これらの関数はヘッダファイル X11/Xutil.h で定義されているフラグと XWMHints 構造体を使う。

To allocate an XWMHints structure, use XAllocWMHints().
XWMHints 構造体を割り当てるには XAllocWMHints() を使う。

The XWMHints structure contains:
XWMHints 以下は構造体の内容である。


/* Window manager hints mask bits */

#define	InputHint	(1L << 0)
#define	StateHint	(1L << 1)
#define	IconPixmapHint	(1L << 2)
#define	IconWindowHint	(1L << 3)
#define	IconPositionHint	(1L << 4)
#define	IconMaskHint	(1L << 5)
#define	WindowGroupHint	(1L << 6)
#define	UrgencyHint	(1L << 8)
#define	AllHints 	(InputHint|StateHint|IconPixmapHint|IconWindowHint|IconPositionHint|IconMaskHint|WindowGroupHint)


/* Values */

typedef struct {
	long flags;		/* marks which fields in this structure are defined */
	Bool input;		/* does this application rely on the window manager to
				   get keyboard input? */
	int initial_state;	/* see below */
	Pixmap icon_pixmap;	/* pixmap to be used as icon */
	Window icon_window;	/* window to be used as icon */
	int icon_x, icon_y;	/* initial position of icon */
	Pixmap icon_mask;	/* pixmap to be used as mask for icon_pixmap */
	XID window_group;	/* id of related window group */
	/* this structure may be extended in the future */
} XWMHints;

The input member is used to communicate to the window manager the input focus model used by the application. Applications that expect input but never explicitly set focus to any of their subwindows (that is, use the push model of focus management), such as X Version 10 style applications that use real-estate driven focus, should set this member to True. Similarly, applications that set input focus to their subwindows only when it is given to their top-level window by a window manager should also set this member to True. Applications that manage their own input focus by explicitly setting focus to one of their subwindows whenever they want keyboard input (that is, use the pull model of focus management) should set this member to False. Applications that never expect any keyboard input also should set this member to False.
input メンバはアプリケーションが使う入力フォーカスモデルをウィンドウマネージャに伝えるために用いられる。 リアルエステートドリブンフォーカス(real-estate driven focus)を使う X バージョン 10 スタイルのアプリケーションのように、 入力を期待するが明示的にサブウィンドウにフォーカスを設定しない (つまりフォーカス管理のプッシュモデルを使っている) アプリケーションでは、 このメンバを True に設定すべきである。 同様にウィンドウマネージャによってトップレベルウィンドウにフォーカスが与えられた時だけ入力フォーカスがサブウィンドウに設定されるアプリケーションでも、 このメンバを True に設定すべきである。 キーボードの入力が必要なときには明示的にフォーカスをサブウィンドウに設定することによって自分自身で入力を管理するような (つまり、フォーカス管理のプルモデルを使っている) アプリケーションでは、 このメンバを False に設定すべきである。 キーボードの入力を全く使わないアプリケーションでも、 このメンバを False に設定すべきである。

Pull model window managers should make it possible for push model applications to get input by setting input focus to the top-level windows of applications whose input member is True. Push model window managers should make sure that pull model applications do not break them by resetting input focus to PointerRoot when it is appropriate (for example, whenever an application whose input member is False sets input focus to one of its subwindows).
プルモデルのウィンドウマネージャは、 input メンバが True であるアプリケーションのトップレベルウィンドウに入力フォーカスを設定することによって、 プッシュモデルのアプリケーションが入力を取得できるようにしなければならない。 プッシュモデルのウィンドウマネージャは、 しかるべきタイミング (例えば input メンバが False であるアプリケーションが入力フォーカスをサブウィンドウに設定したとき) に入力フォーカスを PointerRoot にリセットすることによって、 プルモデルのアプリケーションがウィンドウマネージャを破壊してしまわないように注意しなければならない。

The definitions for the initial_state flag are:
initial_state フラグの定義を以下に示す。


#define	WithdrawnState	0
#define	NormalState	1	/* most applications start this way */
#define	IconicState	3	/* application wants to start as an icon */
The icon_mask specifies which pixels of the icon_pixmap should be used as the icon. This allows for nonrectangular icons. Both icon_pixmap and icon_mask must be bitmaps. The icon_window lets an application provide a window for use as an icon for window managers that support such use. The window_group lets you specify that this window belongs to a group of other windows. For example, if a single application manipulates multiple top-level windows, this allows you to provide enough information that a window manager can iconify all of the windows rather than just the one window.
icon_mask は icon_pixmap のどのピクセルがアイコンとして使用されるかを指定する。 これを使えば非矩形のアイコンを利用できる。 icon_pixmapicon_mask はいずれもビットマップでなければならない。 icon_window は与えたウィンドウをアイコンとして使うことができるウィンドウマネージャのために、 アプリケーションにウィンドウを提供させる。 window_group はこのウィンドウが他のウィンドウのグループに属していることを示す。 例えばある単独のアプリケーションが複数のトップレベルウィンドウを操作する場合に window_group を使えば、 ウィンドウマネージャが 1 つのウィンドウだけでなく全てのウィンドウを同時にアイコン化させるために十分な情報を与えることができる。

The UrgencyHint flag, if set in the flags field, indicates that the client deems the window contents to be urgent, requiring the timely response of the user. The window manager will make some effort to draw the user's attention to this window while this flag is set. The client must provide some means by which the user can cause the urgency flag to be cleared (either mitigating the condition that made the window urgent or merely shutting off the alarm) or the window to be withdrawn.
UrgencyHint フラグが flags フィールドに設定されていれば、 クライアントはウィンドウの内容が緊急事項であり、 ユーザの適時な応答を必要とすることを示す。 ウィンドウマネージャはこのフラグが設定されている間、 ユーザの注意を引くために何らかの動作をする。 クライアントはユーザがこの urgency フラグをクリアするための何らかの手段 (ウィンドウの urgent フラグの条件を緩和するか、 単にアラームを止める)か、 ウィンドウを消すための手段を用意しなければならない。

To set a window's WM_HINTS property, use XSetWMHints().
ウィンドウの WM_HINTS プロパティを設定するには XSetWMHints() を使う。

To read a window's WM_HINTS property, use XGetWMHints().
ウィンドウの WM_HINTS プロパティを取得するには XGetWMHints() を指定する。

Next: Setting and Reading the WM_NORMAL_HINTS Property

Christophe Tronche, ch.tronche@computer.org