コンテンツにスキップ

Clipboard

Clipboard クラスは OSのクリップボードにアクセスする機能を提供するクラスです。このクラスからオブジェクトを作成することはできません。

Windows ネイティブ ( WINVER ) ビルドと SDL3 ビルドの双方で利用できます ( SDL3 ビルドは 2026-08-16 に対応。それ以前は何もしない空実装でした )。 クリップボードを持たないプラットフォーム向けのビルドでは、書き込みは無視され 読み出しは常に void 、hasFormat は常に偽になります。

ビットマップ ( setAsBitmap / getAsBitmap ) は 現在 Windows ネイティブ ( WINVER ) ビルドのみの対応で、 それ以外のビルドでは常に偽を返して何もしません。

メンバー一覧

プロパティ

メソッド


asText

プロパティ \ アクセス: r/w

解説

テキスト形式

クリップボードに現在あるテキスト形式のデータを表します。値を書き込むこともできます。

値を読み出すと、現在クリップボードにあるテキスト形式のデータを得ることができます。クリップボードにテキスト形式のデータがない場合は、void が得られます。

値を書き込むと、クリップボードにテキスト形式のデータを格納することができます。


hasFormat

メソッド

引数

引数 既定値 説明
format   存在を確認したいフォーマットを指定します。
cbfText ( テキスト形式 ) と cbfBitmap ( ビットマップ形式 ) が指定できます。

戻り値

指定されたフォーマットがクリップボード内に存在すれば真、存在しなければ偽

解説

指定されたフォーマットがクリップボード内に存在するか

指定されたフォーマットがクリップボード内に存在するかどうかを調べることができます。

OS の提供するクリップボードは、同時に複数のフォーマットを持つことができるため、その中に特定のフォーマットがあるかどうかをこのメソッドで調べることができます。


setAsBitmap

メソッド

引数

引数 既定値 説明
layer   書き込む画像を持つ Layer オブジェクトを指定します。

戻り値

クリップボードへ書き込めた場合は真、そうでない場合は偽

解説

レイヤの画像をクリップボードへ書き込む

指定されたレイヤのメイン画像を、ビットマップ形式でクリップボードへ格納します。

他のアプリケーションへ渡す都合上、α値は 255 ( 不透明 ) に潰されます。


getAsBitmap

メソッド

引数

引数 既定値 説明
layer   画像の読み込み先となる Layer オブジェクトを指定します。

戻り値

クリップボードから読み込めた場合は真、ビットマップ形式のデータがない場合などは偽

解説

クリップボードの画像をレイヤへ読み込む

クリップボードにあるビットマップ形式のデータを、指定されたレイヤへ読み込みます。

レイヤの画像サイズはクリップボード内の画像に合わせて変更されます ( レイヤの表示サイズは変わらないので、必要なら Layer.setSizeToImageSize を呼んでください )。