クリップボードアクセスクラス [詳解]
#include <TnbClipboard.h>
CClipboard の継承関係図
公開メンバ関数 | |
| CClipboard (HWND hWnd=NULL, DWORD dwOpenTimeout=500, bool boHasErrBox=false) | |
| コンストラクタ [詳解] | |
| bool | Empty (void) |
| [操作] 空化. [詳解] | |
| HBITMAP | GetBitmap (void) const |
| [取得] ビットマップ取得. [詳解] | |
| CStr | GetString (void) const |
| [取得] 文字列取得. [詳解] | |
| bool | GetUserData (CWorkMem &_data, UINT dataTypeId) const |
| [取得] ユーザ定義データ取得. [詳解] | |
| bool | IsAvailable (UINT uFormat=0) const |
| [確認] 存在確認. [詳解] | |
| bool | SetBitmap (HBITMAP bmp, bool isAdd=false) |
| [設定] ビットマップ登録. [詳解] | |
| void | SetHandle (HWND hWnd) |
| [登録] ウィンドウハンドル設定 [詳解] | |
| bool | SetString (LPCTSTR lpszText, bool isAdd=false) |
| [設定] 文字列登録. [詳解] | |
| bool | SetUserData (UINT dataTypeId, size_t dataSize, LPCVOID pData, bool isAdd=false) |
| [設定] ユーザ定義データ設定. [詳解] | |
静的公開メンバ関数 | |
| static CStr | GetFormatName (UINT uFormat) |
| [取得] データ型名取得 [詳解] | |
| static UINT | RegisterUserDataType (LPCTSTR lpszDataTypeName) |
| [登録] ユーザ定義データ型登録. [詳解] | |
詳解
クリップボードアクセスクラス
- 必要ファイル
- TnbClipboard.h
- 日付
- 06/06/13 新規作成
- 06/06/26 GetAll , SetAll ,新規
- 07/05/10 クラス名変更。
- 09/02/13 ビットマップのアクセサ追加。
- 09/10/29 再構成。
- 10/04/14 ユーザデータ対応。
TnbClipboard.h の 48 行目に定義があります。
構築子と解体子
◆ CClipboard()
|
explicit |
コンストラクタ
- 引数
-
hWnd 親ウィンドウハンドル。省略することも出来ます。 dwOpenTimeout クリップボードオープン時のタイムアウト。 指定msの間、リトライします。 boHasErrBox trueを指定するとエラー時にダイアログを出します。 省略すると出しません。
TnbClipboard.h の 60 行目に定義があります。
関数詳解
◆ Empty()
| bool Empty | ( | void | ) |
◆ GetBitmap()
| HBITMAP GetBitmap | ( | void | ) | const |
[取得] ビットマップ取得.
クリップボードからビットマップを取得します。
- 戻り値
-
NULL なかった NULL以外 成功。値は HBITMAP。
TnbClipboard.h の 245 行目に定義があります。
◆ GetFormatName()
|
static |
[取得] データ型名取得
- 覚え書き
- uFormat は 0xC000〜0xFFFF 以外なら失敗します。
- 引数
-
uFormat データ型
- 戻り値
- 型名
TnbClipboard.h の 119 行目に定義があります。
◆ GetString()
| CStr GetString | ( | void | ) | const |
◆ GetUserData()
| bool GetUserData | ( | CWorkMem & | _data, |
| UINT | dataTypeId | ||
| ) | const |
[取得] ユーザ定義データ取得.
クリップボードから、指定のユーザデータを取り出します。
- 覚え書き
- RegisterUserDataType() でユーザ定義を登録しておく必要があります。
- 引数
-
[out] _data データ [in] dataTypeId データ型ID( RegisterUserDataType() の戻り値)。
- 戻り値
-
true 成功 false 失敗
TnbClipboard.h の 196 行目に定義があります。
◆ IsAvailable()
| bool IsAvailable | ( | UINT | uFormat = 0 | ) | const |
[確認] 存在確認.
現在のクリップボードにデータがあるか確認します。
- 引数
-
uFormat クリップボードフォーマットID。テキストを指定したい場合省略できます。
- 戻り値
-
true 成功 false 失敗
TnbClipboard.h の 98 行目に定義があります。
◆ RegisterUserDataType()
|
static |
◆ SetBitmap()
| bool SetBitmap | ( | HBITMAP | bmp, |
| bool | isAdd = false |
||
| ) |
[設定] ビットマップ登録.
クリップボードにビットマップを登録します。
- 引数
-
bmp ビットマップ。 isAdd true なら現在のクリップボード情報をクリアせず、追加します。
- 戻り値
-
true 成功 false 失敗
TnbClipboard.h の 271 行目に定義があります。
◆ SetHandle()
| void SetHandle | ( | HWND | hWnd | ) |
◆ SetString()
| bool SetString | ( | LPCTSTR | lpszText, |
| bool | isAdd = false |
||
| ) |
[設定] 文字列登録.
クリップボードに文字列を登録します。
- 引数
-
lpszText 文字列。 isAdd true なら現在のクリップボード情報をクリアせず、追加します。
- 戻り値
-
true 成功 false 失敗
TnbClipboard.h の 174 行目に定義があります。
◆ SetUserData()
| bool SetUserData | ( | UINT | dataTypeId, |
| size_t | dataSize, | ||
| LPCVOID | pData, | ||
| bool | isAdd = false |
||
| ) |
[設定] ユーザ定義データ設定.
クリップボードに、指定のユーザデータを設定します。
- 覚え書き
- RegisterUserDataType() でユーザ定義を登録しておく必要があります。
- 引数
-
dataTypeId データ型ID( RegisterUserDataType() の戻り値)。 dataSize データサイズ pData データ isAdd true なら現在のクリップボード情報をクリアせず、追加します。
- 戻り値
-
true 成功 false 失敗
TnbClipboard.h の 225 行目に定義があります。
