Класс 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::P reTranslateMessage. (Переопределяет CVSListBoxBase::PreTranslateMessage.) |
| CVSListBox::RemoveItem | Удаляет элемент из элемента управления редактируемым списком. (Переопределяет CVSListBoxBase::RemoveItem.) |
| CVSListBox::SelectItem | Выбирает строку элемента управления редактируемым списком. (Переопределяет CVSListBoxBase::SelectItem.) |
| CVSListBox::SetItemData | Связывает 32-разрядное значение для конкретного приложения с элементом управления списком с редактируемым элементом управления списком. (Переопределяет CVSListBoxBase::SetItemData.) |
Защищенные методы
| Имя | Описание |
|---|---|
| CVSListBox::GetListHwnd | Возвращает дескриптор текущего внедренного элемента управления представления списка. |
Замечания
Класс CVSListBox предоставляет набор кнопок редактирования, позволяющих пользователю создавать, изменять, удалять или изменять элементы в элементе управления списком.
Ниже приведен рисунок элемента управления редактируемым списком. Вторая запись списка, которая называется Item2, выбрана для редактирования.
Если вы используете редактор ресурсов для добавления элемента управления редактируемым списком, обратите внимание, что панель элементов редактора не предоставляет предопределенный элемент управления редактируемым списком. Вместо этого добавьте статический элемент управления, например элемент управления Group Box . Платформа использует статический элемент управления в качестве заполнителя, чтобы указать размер и положение редактируемого элемента управления списком.
Чтобы использовать редактируемый элемент управления списком в шаблоне диалогового окна, объявите CVSListBox переменную в классе диалогового окна. Чтобы обеспечить обмен данными между переменной и элементом управления, определите DDX_Control запись макроса в DoDataExchange методе диалогового окна. По умолчанию элемент управления редактируемым списком создается без кнопок редактирования. Используйте метод 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;
Возвращаемое значение
Число элементов в элементе управления "Список".
Замечания
Обратите внимание, что число больше, чем значение индекса последнего элемента, так как индекс основан на нулях.
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-разрядное значение. Это значение может быть целым числом приложения или указателем на другие данные.