名称

XmClipboardStartRetrieve — クリップボードからのコピーを始める関数

形式

#include        <Xm/Xm.h>
#include        <Xm/CutPaste.h> int XmClipboardStartRetrieve (display, window, timestamp)
Display∗ display;
Windowwindow;
Timetimestamp;

解説

XmClipboardStartRetrieve は、アプリケーションがクリップボードから項目のコピーを始める準備ができたことをクリップボードルーチンに知せます。 クリップボードにはこのルーチンによってロックがかかり、XmClipboardEndRetrieve が呼び出されるまでロックがかかったままになります。 XmClipboardStartRetrieve と XmClipboardEndRetrieve が呼び出される間に、 同じフォーマット名で XmClipboardRetrieve を複数回呼び出すと、そのフォーマットのデータがすべてコピーされるまでは連続してクリップボードからコピーされます。

XmClipboardRetrieve のリターン値が ClipboardTruncate の時は、与えられたフォーマットでコピーできるデータがまだ残っていることを示しています。 アプリケーションがクリップボードからのコピーで必要とする Inquire 関数の呼び出しは、すべて XmClipboardStartRetrieve と最初の XmClipboardRetrieve の呼び出しの間に行うことを勧めます。 そうすれば、アプリケーションが XmClipboardLock と XmClipboardUnlock を呼ぶ必要はありません。 アプリケーションは、XmClipboardStartRetrieve と XmClipboardEndRetrieve を使う必要はなく、その場合も XmClipboardRetrieve は以前のように働きます。

display以前の XOpenDisplay または XtDisplay の呼び出しで返された Display 構造体へのポインタを指定します。

windowアプリケーションウィンドウとクリップボードとを関連づけるための widget のウィンドウ ID を指定します。 widget のウィンドウ ID は XtWindow を用いることによって得られます。 同じアプリケーションのインスタンスは、呼び出す各クリップボード関数に対して同じウィンドウ ID を渡さねばなりません。

timestampコピーを引き起こしたイベントの時間を指定します。

リターン値

ClipboardSuccess
関数の実行に成功しました。

ClipboardLocked
クリップボードが他のアプリケーションにロックされているため、関数の実行に失敗しました。 アプリケーションはロックが解除されるまで同じ引数で何度も関数を呼び続けることができます。 このことを利用して、アプリケーションはユーザに操作を試み続けるかあきらめるかたずねることができます。

関連事項

XmClipboardEndRetrieve(3XM), XmClipboardInquireCount(3XM), XmClipboardInquireFormat(3XM), XmClipboardInquireLength(3XM), XmClipboardInquirePendingItems(3XM), XmClipboardLock(3XM), XmClipboardRetrieve(3XM), XmClipboardStartCopy(3XM), XmClipboardUnlock(3XM)

NEWS-OSRelease 4.1C