XRotateWindowProperties

Syntax

XRotateWindowProperties(display, w, properties, num_prop, npositions)
      Display *display;
      Window w;
      Atom properties[];
      int num_prop;
      int npositions;

Arguments

display Specifies the connection to the X server.
Xサーバへの接続を指定。
w Specifies the window.
ウィンドウを指定。
properties Specifies the array of properties that are to be rotated.
ローテートさせるプロパティの配列を指定。
num_prop Specifies the length of the properties array.
プロパティの配列の長さを指定。
npositions Specifies the rotation amount.
ローテーションの量を指定。

Description

The XRotateWindowProperties() function allows you to rotate properties on a window and causes the X server to generate PropertyNotify events. If the property names in the properties array are viewed as being numbered starting from zero and if there are num_prop property names in the list, then the value associated with property name I becomes the value associated with property name (I + npositions) mod N for all I from zero to N - 1. The effect is to rotate the states by npositions places around the virtual ring of property names (right for positive npositions, left for negative npositions). If npositions mod N is nonzero, the X server generates a PropertyNotify event for each property in the order that they are listed in the array. If an atom occurs more than once in the list or no property with that name is defined for the window, a BadMatch error results. If a BadAtom or BadMatch error results, no properties are changed.
関数 XRotateWindowProperties() を使うとウィンドウのプロパティをローテートさせることができる。 また、この関数は X サーバに PropertyNotify イベントを生成させる。 プロパティ配列内のプロパティ名にゼロから始まる番号が付けられ、 リスト中に num_prop プロパティ名がある場合には、 プロパティ名 I に割り当てられる値は ゼロから N - 1 までのIのうち プロパティ名 (I + npositions) mod N に割り付けられた値になる。 プロパティ名 (I + npositions) mod N に対応する値となる(I の値はゼロか N-1 まで)。 この関数の効果は、状態をプロパティ名の仮想的なリングの周りで npositions 分の位置だけローテートさせることである(npositions が正ならば 右周りで、負ならば左回り)。 npositions mod N がゼロでなければ、 X サーバは配列中に列挙されている順に 各プロパティに対する PropertyNotifyイベントを生成する。 1つのアトムがリスト中に2度以上現われた場合とウィンドウに対して その名前のプロパティが定義されていない場合には、 エラー BadMatch となる。 エラー BadAtom あるいは BadMatch が起きた場合、プロパティは 変更されない。

XRotateWindowProperties() can generate BadAtom , BadMatch , and BadWindow errors.
XRotateWindowPropertiesはエラー BadAtom ,BadMatch ,BadWindow を起こすことがある。

Diagnostics

BadAtom A value for an Atom argument does not name a defined Atom.
BadMatch An InputOnly window is used as a Drawable.
BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request.
BadPixmap A value for a Pixmap argument does not name a defined Pixmap.
BadWindow A value for a Window argument does not name a defined Window.

See also

XChangeProperty(), XDeleteProperty(), XGetWindowProperty(), XListProperties(), "Obtaining and Changing Window Properties"
Christophe Tronche, ch.tronche@computer.org