書式

XIconSize *XAllocIconSize()

XSetIconSizes(display, w, size_list, count)

      Display *display;

      Window w;

      XIconSize *size_list;

      int count;

Status XGetIconSizes(display, w, size_list_return, count_return)

      Display *display;

      Window w;

      XIconSize **size_list_return;

      int *count_return;

引き数

display

X サーバへの接続を指定する。

count

サイズのリスト中の要素数を指定する。

count_return

サイズのリスト中の要素数が返される。

size_list

サイズのリストを指定する。

size_list_return

サイズのリストが返される。

w

ウィンドウを指定する。

説明

関数 XAllocIconSize は XIconSize 構造体を割り当て、この構造体を指すポインタを返す。 XIconSize の全てのフィールドは 0 で初期化される。 十分なメモリが確保できない場合、 XAllocIconSize は NULL を返す。 この構造体に割り当てられたメモリを解放するには、 XFree を使用すること。

関数 XSetIconSizes はウィンドウマネージャだけが使う関数で、サポートしているアイコンの サイズを設定する。

XSetIconSizes はエラー BadAlloc, BadWindow を起こすことがある。

関数 XGetIconSizes は、ウィンドウマネージャがアイコンのサイズをまだ設定していなければ 0 を返し、すでに設定していれば 0 でない値を返す。 XGetIconSize をアプリケーションが呼び出すべきなのは、 自分の上位にあるウィンドウマネージャにとって最も適切なアイコンサイズを 調べたい場合である。 その後、そのアプリケーションはサポートされているサイズの中から ピクスマップやウィンドウを選び、XSetWMHints を用いてこれらを ウィンドウマネージャに渡すべきである。 size_list_return に対して割り当てられたデータを解放するには、 XFree を使用すること。

XGetIconSizes はエラー BadWindow を起こすことがある。

プロパティ

WM_ICON_SIZES

ウィンドウマネージャは、サポートしているアイコンのサイズを指定するため にルートウィンドウのこのプロパティを設定する。 このプロパティの C 言語における型は XIconSize である。

構造体

XIconSize 構造体の内容を示す。

typedef struct {
     int min_width, min_height;
     int max_width, max_height;
     int width_inc, height_inc;
} XIconSize;

width_inc と height_inc メンバは、サポートされているアイコンのサイズを 表す、サイズの増分(最小値から最大値まで)を定義する。

返り値

BadAlloc

要求されたリソースやサーバメモリの割り当てにサーバが失敗した。

BadWindow

引き数 Window の値が、定義されている Window を指していない。