SFBClipboard

IClipboard インターフェースのラッパークラスです。

#include <SFBClipboard.h.hpp>

class SFBClipboard : public SFBBase;

SFMTYPEDEFWRAPPER(SFBClipboard)

継承図

バージョン

BREW 2.0	BREW 2.1	BREW 3.1	BREW 4.0
○	○	○	○

参照

BREW API IClipboard

メンバ

パブリック関数
`SFCError`	ClearData( `ACharConstPtr` format ) クリップボードの指定した形式の内容を消去します。
`SFCError`	ClearData( `SFXAnsiStringConstRef` format ) クリップボードの指定した形式の内容を消去します。
`SFCError`	Empty( `Void` ) クリップボードから、すべての形式のすべてのデータを削除します。
`Bool`	EnumInit( `Void` ) クリップボード内の形式の列挙内容を初期化します。
`Bool`	EnumNext( `CBItemInfo*` itemInfo ) 次に使用可能な / 登録されているクリップボード形式を取得します。
`SFCError`	GetData( `ACharConstPtr` format , `VoidPtr` data , `SInt32Ptr` size ) 指定した形式のクリップボードデータをバッファにコピーします。
`SFCError`	GetData( `ACharConstPtr` format , `SFXBufferPtr` data ) 指定した形式のクリップボードデータをバッファにコピーします。
`SFCError`	GetData( `SFXAnsiStringConstRef` format , `VoidPtr` data , `SInt32Ptr` size ) 指定した形式のクリップボードデータをバッファにコピーします。
`SFCError`	GetData( `SFXAnsiStringConstRef` format , `SFXBufferPtr` data ) 指定した形式のクリップボードデータをバッファにコピーします。
`UInt32`	GetSequence( `Void` ) クリップボードのシーケンス番号を取得します。
`UInt32`	MaxFreeBlock( `UInt32Ptr` total = null , `UInt32Ptr` used = null ) クリップボードの最大空きブロックサイズ、合計サイズ、合計使用サイズを取得します。
static `SFBClipboardSmp`	NewInstance( `SFCErrorPtr` exception = null ) SFBClipboard インスタンスを生成します。
static `SFBClipboardSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) SFBClipboard インスタンスを生成します。
`SFCError`	SetData( `ACharConstPtr` format , `VoidPtr` data , `SInt32` size ) クリップボードの形式用にデータを設定します。
`SFCError`	SetData( `ACharConstPtr` format , `SFXBufferPtr` data ) クリップボードの形式用にデータを設定します。
`SFCError`	SetData( `SFXAnsiStringConstRef` format , `VoidPtr` data , `SInt32` size ) クリップボードの形式用にデータを設定します。
`SFCError`	SetData( `SFXAnsiStringConstRef` format , `SFXBufferPtr` data ) クリップボードの形式用にデータを設定します。

プロテクト関数
static `SFBBaseSmp`	FactoryByCreate( `AEECLSID` id , `SFCErrorPtr` exception = null ) (SFBBase から継承) 指定したクラス ID のインターフェースのインスタンスを生成します。
static `SFBBaseSmp`	FactoryByQuery( `SFBQuerySmpConstRef` query , `AEECLSID` id , `SFCErrorPtr` exception = null ) (SFBBase から継承) 指定したクラス ID のインターフェースのインスタンスを指定した SFBQuery インスタンスを使用して生成します。

SFBClipboard::ClearData

クリップボードの指定した形式の内容を消去します。

[ public ]
SFCError ClearData(
    ACharConstPtr format   // 形式名
);

[ public ]
SFCError ClearData(
    SFXAnsiStringConstRef format   // 形式名
);

戻り値

成功したとき: SFERR_NO_ERROR
メモリ不足のとき: SFERR_NO_MEMORY
失敗したとき: SFERR_FAILED

参照

SFBClipboard::SetData

SFBClipboard::Empty

クリップボードから、すべての形式のすべてのデータを削除します。

[ public ]
SFCError Empty(Void);

戻り値

成功したとき: SFERR_NO_ERROR
失敗したとき: SFERR_FAILED

参照

BREW API ICLIPBOARD_Empty

SFBClipboard::EnumInit

クリップボード内の形式の列挙内容を初期化します。

[ public ]
Bool EnumInit(Void);

戻り値

クリップボード形式が使用可能なとき: true
登録済みの形式がないとき: false

参照

BREW API ICLIPBOARD_EnumInit | SFBClipboard::EnumNext

SFBClipboard::EnumNext

次に使用可能な / 登録されているクリップボード形式を取得します。

[ public ]
Bool EnumNext(
    CBItemInfo* itemInfo   
);

引数

itemInfo: 項目情報を格納するポインタ。この関数をコールする前に、itemInfo パラメータの pszName および nNameLen メンバ、たとえば CBItemInfo 構造体を正しく設定する必要があります。リターン時に、pszName には形式の名前が格納され、 nDataSize には実際のデータのサイズが格納されています。入力時: itemInfo -> pszName は、文字列を格納できる有効なポインタであること。 itemInfo -> nNameLen は、ポインタのサイズ( バイト数 )を指定する。 itemInfo -> pszName は格納する。リターン時: itemInfo -> pszName は、形式名を格納する。 itemInfo -> nDataLen は、クリップボード内のこの形式のデータのサイズを格納する。

戻り値

形式が返されたとき: true
これ以上項目がないとき: false

参照

BREW API ICLIPBOARD_EnumNext | SFBClipboard::EnumInit

SFBClipboard::GetData

指定した形式のクリップボードデータをバッファにコピーします。

[ public ]
SFCError GetData(
    ACharConstPtr format   // 形式の名前
    VoidPtr data           // 宛先バッファへのポインタ
    SInt32Ptr size         // 宛先バッファの入力サイズと、コピーされた出力サイズ
);

[ public ]
SFCError GetData(
    ACharConstPtr format   // 形式の名前
    SFXBufferPtr data      // 宛先バッファへのポインタ
                           // サイズは自動的にコピーされた出力サイズに設定される
);

[ public ]
SFCError GetData(
    SFXAnsiStringConstRef format   // 形式の名前
    VoidPtr data                   // 宛先バッファへのポインタ
    SInt32Ptr size                 // 宛先バッファの入力サイズと、コピーされた出力サイズ
);

[ public ]
SFCError GetData(
    SFXAnsiStringConstRef format   // 形式の名前
    SFXBufferPtr data              // 宛先バッファへのポインタ
                                   // サイズは自動的にコピーされた出力サイズに設定される
);

戻り値

成功したとき: SFERR_NO_ERROR
引数が不正なとき: SFERR_INVALID_PARAM
メモリ不足のとき: SFERR_NO_MEMORY
形式がサポートされていないとき: SFERR_FAILED

解説

注意：バッファサイズは SInt32 の値までの制限があります。

参照

BREW API ICLIPBOARD_GetData | SFBClipboard::SetData

SFBClipboard::GetSequence

クリップボードのシーケンス番号を取得します。

[ public ]
UInt32 GetSequence(Void);

解説

この関数は、クリップボードが更新されたかどうかを判断するためにあります。クリップボードの更新には、データの追加 / 削除が含まれます。

参照

BREW API ICLIPBOARD_GetSequence

SFBClipboard::MaxFreeBlock

クリップボードの最大空きブロックサイズ、合計サイズ、合計使用サイズを取得します。

[ public ]
UInt32 MaxFreeBlock(
    UInt32Ptr total = null   // クリップボードメモリーの合計サイズ( バイト数 )を格納するポインタ( 非 null の場合 )
    UInt32Ptr used = null    // クリップボードの合計使用領域( バイト数 )を格納するポインタ( 非 null の場合 )
);

参照

BREW API ICLIPBOARD_MaxFreeBlock

SFBClipboard::NewInstance

SFBClipboard インスタンスを生成します。

[ public, static ]
SFBClipboardSmp NewInstance(
    SFCErrorPtr exception = null   // エラー値
);

[ public, static ]
SFBClipboardSmp NewInstance(
    AEECLSID id                    // クラスID
    SFCErrorPtr exception = null   // エラー値
);

SFBClipboard::SetData

クリップボードの形式用にデータを設定します。

[ public ]
SFCError SetData(
    ACharConstPtr format   // 形式名
    VoidPtr data           // データポインタ
    SInt32 size            // データオブジェクトのサイズ
);

[ public ]
SFCError SetData(
    ACharConstPtr format   // 形式名
    SFXBufferPtr data      // null の場合、 null と 0 がパラメータとして渡される
);

[ public ]
SFCError SetData(
    SFXAnsiStringConstRef format   // 形式名
    VoidPtr data                   // データポインタ
    SInt32 size                    // データオブジェクトのサイズ
);

[ public ]
SFCError SetData(
    SFXAnsiStringConstRef format   // 形式名
    SFXBufferPtr data              // null の場合、 null と 0 がパラメータとして渡される
);

戻り値

成功したとき: SFERR_NO_ERROR
メモリ不足のとき: SFERR_NO_MEMORY
失敗したとき: SFERR_FAILED

解説

SFBClipboard::SetData 関数はバッファの内容をクリップボードの形式用にしてコピーします。

	注意
	クリップボードのデータはアプリケーションのライフサイクルを超えて利用可能なので、アプリケーション間でデータを共有するのに使えます。

参照

BREW API ICLIPBOARD_SetData | SFBClipboard::GetData