CVSListBox クラス
CVSListBox クラスは、編集可能なリスト コントロールをサポートしています。
構文
class CVSListBox : public CVSListBoxBase
メンバー
パブリック コンストラクター
| 名前 | 説明 |
|---|---|
| CVSListBox::CVSListBox | CVSListBox オブジェクトを構築します。 |
CVSListBox::~CVSListBox |
デストラクターです。 |
パブリック メソッド
| 名前 | 説明 |
|---|---|
| CVSListBox::AddItem | リスト コントロールに文字列を追加します。 ( CVSListBoxBase::AddItemをオーバーライドします)。 |
| CVSListBox::EditItem | リスト コントロール項目のテキストに対する編集操作を開始します。 ( CVSListBoxBase::EditItemをオーバーライドします)。 |
| CVSListBox::GetCount | 編集可能なリスト コントロール内の文字列の数を取得します。 ( CVSListBoxBase::GetCountをオーバーライドします)。 |
| CVSListBox::GetItemData | 編集可能なリスト コントロール項目に関連付けられているアプリケーション固有の 32 ビット値を取得します。 ( CVSListBoxBase::GetItemDataをオーバーライドします)。 |
| CVSListBox::GetItemText | 編集可能なリスト コントロール項目のテキストを取得します。 ( CVSListBoxBase::GetItemTextをオーバーライドします)。 |
| CVSListBox::GetSelItem | 編集可能なリスト コントロールで現在選択されている項目の 0 から始まるインデックスを取得します。 ( CVSListBoxBase::GetSelItemをオーバーライドします)。 |
CVSListBox::PreTranslateMessage |
ウィンドウ メッセージを TranslateMessage および DispatchMessage Windows 関数にディスパッチする前に変換します。 詳細とメソッドの構文については、「 CWnd::P reTranslateMessageを参照してください。 ( CVSListBoxBase::PreTranslateMessageをオーバーライドします)。 |
| CVSListBox::RemoveItem | 編集可能なリスト コントロールから項目を削除します。 ( CVSListBoxBase::RemoveItemをオーバーライドします)。 |
| CVSListBox::SelectItem | 編集可能なリスト コントロール文字列を選択します。 ( CVSListBoxBase::SelectItemをオーバーライドします)。 |
| CVSListBox::SetItemData | アプリケーション固有の 32 ビット値を編集可能なリスト コントロール項目に関連付けます。 ( CVSListBoxBase::SetItemDataをオーバーライドします)。 |
保護メソッド
| 名前 | 説明 |
|---|---|
| CVSListBox::GetListHwnd | 現在の埋め込みリスト ビュー コントロールへのハンドルを返します。 |
解説
CVSListBox クラスには、ユーザーがリスト コントロール内の項目を作成、変更、削除、または再配置できるようにする一連の編集ボタンが用意されています。
編集可能なリスト コントロールの図を次に示します。 2 番目のリスト エントリ ("Item2" というタイトル) が編集用に選択されています。
リソース エディターを使用して編集可能なリスト コントロールを追加する場合は、エディターの Toolbox ペインに定義済みの編集可能なリスト コントロールが表示されないことに注意してください。 代わりに、 Group Box コントロールなどの静的コントロールを追加します。 フレームワークでは、静的コントロールをプレースホルダーとして使用して、編集可能なリスト コントロールのサイズと位置を指定します。
ダイアログ ボックス テンプレートで編集可能なリスト コントロールを使用するには、ダイアログ ボックス クラスで CVSListBox 変数を宣言します。 変数とコントロール間のデータ交換をサポートするには、ダイアログ ボックスの DoDataExchange メソッドでDDX_Controlマクロ エントリを定義します。 既定では、編集可能なリスト コントロールは編集ボタンなしで作成されます。 継承された CVSListBoxBase::SetStandardButtons メソッドを使用して、編集ボタンを有効にします。
詳細については、Samples ディレクトリ、 New Controls サンプル、Page3.cppおよび Page3.h ファイルを参照してください。
継承階層
CVSListBoxBase
要件
Header: afxvslistbox.h
CVSListBox::AddItem
リスト コントロールに文字列を追加します。
virtual int AddItem(
const CString& strIext,
DWORD_PTR dwData=0,
int iIndex=-1);
パラメーター
strIext
[in]文字列への参照。
dwData
[in]文字列に関連付けられているアプリケーション固有の 32 ビット値。 既定値は0です。
iIndex
[in]文字列を保持する位置の 0 から始まるインデックス。 iIndex パラメーターが -1 の場合、文字列がリストの末尾に追加されます。 既定値は -1 です。
戻り値
リスト コントロール内の文字列の位置の 0 から始まるインデックス。
解説
CVSListBox::GetItemData メソッドを使用して、dwData パラメーターで指定された値を取得します。 この値には、アプリケーション固有の整数または他のデータへのポインターを指定できます。
CVSListBox::CVSListBox
CVSListBox オブジェクトを構築します。
CVSListBox();
戻り値
解説
CVSListBox::EditItem
リスト コントロール項目のテキストに対する編集操作を開始します。
virtual BOOL EditItem(int iIndex);
パラメーター
iIndex
[in]リスト コントロール項目の 0 から始まるインデックス。
戻り値
編集操作が正常に開始された場合は TRUE。それ以外の場合は FALSE。
解説
ユーザーは、アイテムのラベルをダブルクリックするか、項目にフォーカスがあるときに F2 キーまたは SPACEBAR キーを押して編集操作を開始します。
CVSListBox::GetCount
編集可能なリスト コントロール内の文字列の数を取得します。
virtual int GetCount() const;
戻り値
リスト コントロールの項目の数。
解説
インデックスは 0 から始まるため、カウントは最後の項目のインデックス値より 1 大きい値であることに注意してください。
CVSListBox::GetItemData
編集可能なリスト コントロール項目に関連付けられているアプリケーション固有の 32 ビット値を取得します。
virtual DWORD_PTR GetItemData(int iIndex) const;
パラメーター
iIndex
[in]編集可能なリスト コントロール項目の 0 から始まるインデックス。
戻り値
指定した項目に関連付けられている 32 ビット値。
解説
CVSListBox::SetItemData または CVSListBox::AddItem メソッドを使用して、32 ビット値をリスト コントロール項目に関連付けます。 この値には、アプリケーション固有の整数または他のデータへのポインターを指定できます。
CVSListBox::GetItemText
編集可能なリスト コントロール項目のテキストを取得します。
virtual CString GetItemText(int iIndex) const;
パラメーター
iIndex
[in]編集可能なリスト コントロール項目の 0 から始まるインデックス。
戻り値
指定した項目のテキストを格納する CString オブジェクト。
解説
CVSListBox::GetListHwnd
現在の埋め込みリスト ビュー コントロールへのハンドルを返します。
virtual HWND GetListHwnd() const;
戻り値
埋め込みリスト ビュー コントロールのハンドル。
解説
このメソッドを使用して、 CVSListBox クラスをサポートする埋め込みリスト ビュー コントロールへのハンドルを取得します。
CVSListBox::GetSelItem
編集可能なリスト コントロールで現在選択されている項目の 0 から始まるインデックスを取得します。
virtual int GetSelItem() const;
戻り値
このメソッドが成功した場合、現在選択されている項目の 0 から始まるインデックス。それ以外の場合は -1。
解説
CVSListBox::RemoveItem
編集可能なリスト コントロールから項目を削除します。
virtual BOOL RemoveItem(int iIndex);
パラメーター
iIndex
[in]編集可能なリスト コントロール項目の 0 から始まるインデックス。
戻り値
指定した項目が削除された場合は TRUE。それ以外の場合は FALSE。
解説
CVSListBox::SelectItem
編集可能なリスト コントロール文字列を選択します。
virtual BOOL SelectItem(int iItem);
パラメーター
iItem
[in]編集可能なリスト コントロール項目の 0 から始まるインデックス。
戻り値
このメソッドが成功した場合は TRUE。それ以外の場合は FALSE。
解説
このメソッドは、指定された項目を選択し、必要な場合は、項目をビューにスクロールします。
CVSListBox::SetItemData
アプリケーション固有の 32 ビット値を編集可能なリスト コントロール項目に関連付けます。
virtual void SetItemData(
int iIndex,
DWORD_PTR dwData);
パラメーター
iIndex
[in]編集可能なリスト コントロール項目の 0 から始まるインデックス。
dwData
[in]32 ビット値。 この値には、アプリケーション固有の整数または他のデータへのポインターを指定できます。