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 | 检索可编辑列表控件中当前选定项的从零开始的索引。 (替代 CVSListBoxBase::GetSelItem 。) |
CVSListBox::PreTranslateMessage |
在将窗口消息发送到 TranslateMessage 和 DispatchMessage Windows 函数之前,对此消息进行转换。 有关详细信息和方法语法,请参阅 CWnd::PreTranslateMessage。 (替代 CVSListBoxBase::PreTranslateMessage 。) |
CVSListBox::RemoveItem | 从可编辑列表控件中删除项。 (替代 CVSListBoxBase::RemoveItem 。) |
CVSListBox::SelectItem | 选择可编辑列表控件字符串。 (替代 CVSListBoxBase::SelectItem 。) |
CVSListBox::SetItemData | 将应用程序特定的 32 位值与可编辑列表控件项关联。 (替代 CVSListBoxBase::SetItemData 。) |
受保护方法
名称 | 描述 |
---|---|
CVSListBox::GetListHwnd | 返回当前嵌入列表视图控件的句柄。 |
备注
CVSListBox
类提供一组编辑按钮,使用户能够创建、修改、删除或重新排列列表控件中的项。
下面是可编辑列表控件的图片。 选择标题为“Item2”的第二个列表条目进行编辑。
如果使用资源编辑器添加可编辑列表控件,请注意编辑器的“工具箱”窗格不提供预定义的可编辑列表控件。 而应添加一个静态控件,例如“分组框”控件。 框架使用静态控件作为占位符来指定可编辑列表控件的大小和位置。
若要在对话框模板中使用可编辑列表控件,请在对话框类中声明 CVSListBox
变量。 若要支持变量与控件之间的数据交换,请在对话框的 DoDataExchange
方法中定义 DDX_Control
宏条目。 默认情况下,无需“编辑”按钮即可创建可编辑列表控件。 使用继承的 CVSListBoxBase::SetStandardButtons 方法来启用“编辑”按钮。
有关详细信息,请参阅 Samples 目录、New Controls
示例、Page3.cpp 和 Page3.h 文件。
继承层次结构
CVSListBoxBase
要求
标头: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] 将保存字符串的位置的从零开始的索引。 如果 iIndex 参数为 -1,则字符串将被添加到列表末尾。 默认值为 -1。
返回值
列表控件中字符串位置的从零开始的索引。
注解
使用 CVSListBox::GetItemData 方法检索 dwData 参数指定的值。 该值可以是应用程序特定的整数或指向其他数据的指针。
CVSListBox::CVSListBox
构造 CVSListBox
对象。
CVSListBox();
返回值
备注
CVSListBox::EditItem
对列表控件项的文本启动编辑操作。
virtual BOOL EditItem(int iIndex);
参数
iIndex
[in] 列表控件项的从零开始的索引。
返回值
如果编辑操作顺利开始,则返回 TRUE;否则返回 FALSE。
注解
用户可以通过双击项标签,或在项具有焦点时按 F2 或空格键来启动编辑操作。
CVSListBox::GetCount
检索可编辑列表控件中的字符串数。
virtual int GetCount() const;
返回值
列表控件中的项数。
注解
请注意,计数比最后一项的索引值大 1,因为索引从零开始。
CVSListBox::GetItemData
检索与可编辑列表控件项关联的应用程序特定的 32 位值。
virtual DWORD_PTR GetItemData(int iIndex) const;
参数
iIndex
[in] 可编辑列表控件项的从零开始的索引。
返回值
与指定项关联的 32 位值。
备注
使用 CVSListBox::SetItemData 或 CVSListBox::AddItem 方法将 32 位值与列表控件项相关联。 该值可以是应用程序特定的整数或指向其他数据的指针。
CVSListBox::GetItemText
检索可编辑列表控件项的文本。
virtual CString GetItemText(int iIndex) const;
参数
iIndex
[in] 可编辑列表控件项的从零开始的索引。
返回值
一个包含指定项文本的 CString 对象。
注解
CVSListBox::GetListHwnd
返回当前嵌入列表视图控件的句柄。
virtual HWND GetListHwnd() const;
返回值
嵌入列表视图控件的句柄。
注解
使用此方法检索支持 CVSListBox
类的嵌入列表视图控件的句柄。
CVSListBox::GetSelItem
检索可编辑列表控件中当前选定项的从零开始的索引。
virtual int GetSelItem() const;
返回值
如果此方法成功,则为当前所选项的从零开始的索引;否则为 -1。
备注
CVSListBox::RemoveItem
从可编辑列表控件中删除项。
virtual BOOL RemoveItem(int iIndex);
参数
iIndex
[in] 可编辑列表控件项的从零开始的索引。
返回值
如果删除指定项,则返回 TRUE;否则返回 FALSE。
注解
CVSListBox::SelectItem
选择可编辑列表控件字符串。
virtual BOOL SelectItem(int iItem);
参数
iItem
[in] 可编辑列表控件项的从零开始的索引。
返回值
如果此方法成功,则返回 TRUE;否则返回 FALSE。
备注
此方法选择指定的项,如果需要,会将该项滚动到视图中。
CVSListBox::SetItemData
将应用程序特定的 32 位值与可编辑列表控件项关联。
virtual void SetItemData(
int iIndex,
DWORD_PTR dwData);
参数
iIndex
[in] 可编辑列表控件项的从零开始的索引。
dwData
[in] 一个 32 位值。 该值可以是应用程序特定的整数或指向其他数据的指针。