CJumpList クラス
CJumpListは、タスク バーのアイコンを右クリックしたときに表示されるショートカットの一覧です。
構文
class CJumpList;
メンバー
パブリック コンストラクター
| 名前 | 説明 |
|---|---|
| CJumpList::CJumpList | CJumpList オブジェクトを構築します。 |
| CJumpList::~CJumpList | CJumpList オブジェクトを破棄します。 |
| 名前 | 説明 |
|---|---|
| CJumpList::AbortList | コミットせずにリスト構築トランザクションを中止します。 |
| CJumpList::AddDestination | 過負荷です。 リストに宛先を追加します。 |
| CJumpList::AddKnownCategory | 既知のカテゴリをリストに追加します。 |
| CJumpList::AddTask | 過負荷です。 正規のタスク カテゴリに項目を追加します。 |
| CJumpList::AddTasks | 正規のタスク カテゴリに項目を追加します。 |
| CJumpList::AddTaskSeparator | タスク間に区切り記号を追加します。 |
| CJumpList::ClearAll | これまでに CJumpList の現在のインスタンスに追加されたすべてのタスクと宛先を削除します。 |
| CJumpList::ClearAllDestinations | これまでに CJumpList の現在のインスタンスに追加されたすべての宛先を削除します。 |
| CJumpList::CommitList | リスト構築トランザクションを終了し、報告されたリストを関連付けられたストア (この場合はレジストリ) にコミットします。 |
| CJumpList::GetDestinationList | 宛先リストへのインターフェイス ポインターを取得します。 |
| CJumpList::GetMaxSlots | 呼び出し元アプリケーションの宛先メニューに表示できるカテゴリ ヘッダーを含む、項目の最大数を取得します。 |
| CJumpList::GetRemovedItems | 削除された宛先を表す項目の配列を返します。 |
| CJumpList::InitializeList | リスト構築トランザクションを開始します。 |
| CJumpList::SetAppID | ビルドするリストのアプリケーション ユーザー モデル ID を設定します。 |
継承階層
要件
Header: afxadv.h
CJumpList::~CJumpList
CJumpList オブジェクトを破棄します。
~CJumpList();
CJumpList::AbortList
コミットせずにリスト構築トランザクションを中止します。
void AbortList();
解説
このメソッドを呼び出すと、CommitListを呼び出さずにCJumpListを破棄する場合と同じ効果があります。
CJumpList::AddDestination
リストに宛先を追加します。
BOOL AddDestination(
LPCTSTR lpcszCategoryName,
LPCTSTR strDestinationPath);
BOOL AddDestination(
LPCTSTR strCategoryName,
IShellItem* pShellItem);
BOOL AddDestination(
LPCTSTR strCategoryName,
IShellLink* pShellLink);
パラメーター
lpcszCategoryName
カテゴリ名を指定します。 指定したカテゴリが存在しない場合は、作成されます。
strDestinationPath
コピー先ファイルへのパスを指定します。
strCategoryName
カテゴリ名を指定します。 指定したカテゴリが存在しない場合は、作成されます。
pShellItem
追加する宛先を表すシェル項目を指定します。
pShellLink
追加する宛先を表すシェル リンクを指定します。
戻り値
解説
CJumpListのインスタンスは、追加された宛先を内部的に蓄積し、CommitListでコミットします。
CJumpList::AddKnownCategory
既知のカテゴリをリストに追加します。
BOOL AddKnownCategory(KNOWNDESTCATEGORY category);
パラメーター
category
既知のカテゴリの種類を指定します。 KDC_RECENTまたはKDC_KNOWNを指定できます。
戻り値
解説
既知のカテゴリは、 SHAddToRecentDocs を利用するすべてのアプリケーションに対して自動的に計算する頻度と最近のカテゴリです (または、一部のシナリオではシェルがアプリケーションの代わりに呼び出すので間接的に使用します)。
CJumpList::AddTask
正規のタスク カテゴリに項目を追加します。
BOOL AddTask(
LPCTSTR strTargetExecutablePath,
LPCTSTR strCommandLineArgs,
LPCTSTR strTitle,
LPCTSTR strIconLocation,
int iIconIndex);
BOOL AddTask(IShellLink* pShellLink);
パラメーター
strTargetExecutablePath
ターゲット タスクのパスを指定します。
strCommandLineArgs
strTargetExecutablePath で指定された実行可能ファイルのコマンド ライン引数を指定します。
strTitle
宛先リストに表示されるタスク名。
strIconLocation
タイトルと共に宛先リストに表示されるアイコンの場所。
iIconIndex
アイコンインデックス。
pShellLink
追加するタスクを表すシェル リンク。
戻り値
解説
CJumpListのインスタンスは、指定したタスクを蓄積し、CommitList中に宛先リストに追加します。 タスク項目は、アプリケーションの移動先メニューの下部にあるカテゴリに表示されます。 このカテゴリは、UI に入力されるときに、他のすべてのカテゴリよりも優先されます。
CJumpList::AddTasks
正規のタスク カテゴリに項目を追加します。
BOOL AddTasks(IObjectArray* pObjectCollection);
パラメーター
pObjectCollection
追加するタスクのコレクション。
戻り値
解説
CJumpList のインスタンスは、指定されたタスクを蓄積し、 CommitList中に宛先リストに追加します。 タスク項目は、アプリケーションの移動先メニューの下部にあるカテゴリに表示されます。 このカテゴリは、UI に入力されるときに、他のすべてのカテゴリよりも優先されます。
CJumpList::AddTaskSeparator
タスク間に区切り記号を追加します。
BOOL AddTaskSeparator();
戻り値
成功した場合は 0 以外、そうでない場合は 0。
CJumpList::CJumpList
CJumpList オブジェクトを構築します。
CJumpList(BOOL bAutoCommit = TRUE);
パラメーター
bAutoCommit
このパラメーターが FALSE の場合、リストはデストラクターで自動的にコミットされません。
CJumpList::ClearAll
これまでに CJumpList の現在のインスタンスに追加されたすべてのタスクと宛先を削除します。
void ClearAll();
解説
このメソッドは、すべてのデータと内部インターフェイスをクリアして解放します。
CJumpList::ClearAllDestinations
これまでに CJumpList の現在のインスタンスに追加されたすべての宛先を削除します。
void ClearAllDestinations();
解説
宛先リスト作成の現在のセッションでこれまでに追加されたすべての宛先を削除し、他の宛先を再度追加する必要がある場合は、この関数を呼び出します。 内部 ICustomDestinationList が初期化されている場合は、そのまま残ります。
CJumpList::CommitList
リスト構築トランザクションを終了し、報告されたリストを関連付けられたストア (この場合はレジストリ) にコミットします。
BOOL CommitList();
戻り値
解説
コミットはアトミックです。 コミットが失敗した場合、エラーが返されます。 CommitListが呼び出されると、削除された項目の現在の一覧がクリーンアップされます。 このメソッドを呼び出すと、アクティブなリスト構築トランザクションが存在しないようにオブジェクトがリセットされます。 リストを更新するには、 BeginList を再度呼び出す必要があります。
CJumpList::GetDestinationList
宛先リストへのインターフェイス ポインターを取得します。
ICustomDestinationList* GetDestinationList();
戻り値
解説
ジャンプ リストが初期化されていない場合、またはコミットまたは中止された場合、戻り値は NULL になります。
CJumpList::GetMaxSlots
呼び出し元アプリケーションの宛先メニューに表示できるカテゴリ ヘッダーを含む、項目の最大数を取得します。
UINT GetMaxSlots() const;
戻り値
解説
アプリケーションでは、この値まで組み合わされた多数のアイテムとカテゴリ ヘッダーのみを報告できます。 AppendCategory、AppendKnownCategory、またはAddUserTasksへの呼び出しがこの数を超えると、エラーが返されます。
CJumpList::GetRemovedItems
削除された宛先を表す項目の配列を返します。
IObjectArray* GetRemovedItems();
戻り値
解説
削除された移動先は、ジャンプ リストの初期化中に取得されます。 新しい宛先リストを生成する場合、アプリケーションは最初に削除された宛先リストを処理し、削除されたリスト列挙子によって返されるすべての項目の追跡データをクリアすることが期待されます。 現在の呼び出し BeginList 開始されたトランザクションで削除された項目をアプリケーションが指定しようとすると、その項目を再追加したメソッド呼び出しは失敗し、アプリケーションが削除されたリストを確実に尊重するようになります。
CJumpList::InitializeList
リスト構築トランザクションを開始します。
BOOL InitializeList();
戻り値
解説
GetDestinationListを使用してICustomDestinationListへのポインター、GetMaxSlotsを使用して使用可能なスロットの数、またはGetRemovedItemsを使用して削除された項目の一覧を取得する場合を除き、このメソッドを明示的に呼び出す必要はありません。
CJumpList::SetAppID
ビルドするリストのアプリケーション ユーザー モデル ID を設定します。
void SetAppID(LPCTSTR strAppID);
パラメーター
strAppID
アプリケーション ユーザー モデル ID を指定する文字列。