SFBClipboard

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

#include <SFBClipboard.h.hpp>

class SFBClipboard : public SFBBase;

SFMTYPEDEFWRAPPER(SFBClipboard)

継承図

協調図

参照

BREW API IClipboard

バグ情報

ICLIPBOARD_GetSequence
ドキュメントエラー	BREW API リファレンス 2.0.1.5

説明には、クリップボードからデータを削除した際にはカウントが減ると記述がありますが、実際にはカウントは減りません。一方的に増えます。

補記：BREW API リファレンス 2.1 (英語版) にて修正されました。日本語版は未修正です。

ICLIPBOARD_MaxFreeBlock
バグ	BREW エミュレータ 2.0.1.5

現在、この API は正常に動作しません。第 3 引数の pdwUsed は常に O が返ります。

メンバ

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

SFBClipboard::ClearData

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

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

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

参照

SFBClipboard::SetData

SFBClipboard::Empty

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

[ public ]
SFCError Empty(Void);

参照

BREW API ICLIPBOARD_Empty

SFBClipboard::EnumInit

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

[ public ]
Bool EnumInit(Void);

参照

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 は、クリップボード内のこの形式のデータのサイズを格納する。

参照

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              // 宛先バッファへのポインタ。 サイズは自動的にコピーされた出力サイズに設定されます。
);

解説

注意：バッファサイズは 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(Void);

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 がパラメータとして渡されます。
);

解説

クリップボードデータはアプリケーションの寿命を超えて使用可能であるため、この関数は新しいメモリを割り当て、クリップボードの内容を新しいバッファにコピーします。 Attention: the maximum buffer size is an SInt32 value.

参照

BREW API ICLIPBOARD_SetData | SFBClipboard::GetData