Compartilhar via

Classe CVSListBox

  • Artigo

A classe CVSListBox oferece suporte a um controle de lista editável.

Sintaxe

class CVSListBox : public CVSListBoxBase

Membros

Construtores públicos

Nome Descrição
CVSListBox::CVSListBox Constrói um objeto CVSListBox.
CVSListBox::~CVSListBox Destruidor.

Métodos públicos

Nome Descrição
CVSListBox::AddItem Adiciona uma cadeia de caracteres a um controle de lista. (Substitui CVSListBoxBase::AddItem.)
CVSListBox::EditItem Inicia uma operação de edição no texto de um item de controle de lista. (Substitui CVSListBoxBase::EditItem.)
CVSListBox::GetCount Recupera o número de cadeias de caracteres em um controle de lista editável. (Substitui CVSListBoxBase::GetCount.)
CVSListBox::GetItemData Recupera um valor de 32 bits específico do aplicativo associado a um item de controle de lista editável. (Substitui CVSListBoxBase::GetItemData.)
CVSListBox::GetItemText Recupera o texto de um item de controle de lista editável. (Substitui CVSListBoxBase::GetItemText.)
CVSListBox::GetSelItem Recupera o índice de base zero do item atualmente selecionado em um controle de lista editável. (Substitui CVSListBoxBase::GetSelItem.)
CVSListBox::PreTranslateMessage Converte mensagens de janela antes de serem enviadas para as funções TranslateMessage e DispatchMessage de Windows. Para mais informações e sintaxe de método, confira CWnd::PreTranslateMessage. (Substitui CVSListBoxBase::PreTranslateMessage.)
CVSListBox::RemoveItem Remove um item de um controle de lista editável. (Substitui CVSListBoxBase::RemoveItem.)
CVSListBox::SelectItem Seleciona uma cadeia de caracteres de controle de lista editável. (Substitui CVSListBoxBase::SelectItem.)
CVSListBox::SetItemData Associa um valor de 32 bits específico do aplicativo com um item de controle de lista editável. (Substitui CVSListBoxBase::SetItemData.)

Métodos protegidos

Nome Descrição
CVSListBox::GetListHwnd Retorna o identificador para o controle de exibição de lista inserida atual.

Comentários

A classe CVSListBox oferece um conjunto de botões de edição que permitem que o usuário crie, modifique, exclua ou reorganize os itens em um controle de lista.

Veja a seguir uma imagem do controle de lista editável. A segunda entrada de lista, que é intitulada "Item2", é selecionada para edição.

Controle CVSListBox.

Se você usar o editor de recursos para adicionar um controle de lista editável, observe que o painel Caixa de Ferramentas do editor não fornece um controle de lista editável predefinido. Em vez disso, adicione um controle estático, como o controle Caixa de Grupo. A estrutura usa o controle estático como um espaço reservado para especificar o tamanho e a posição do controle de lista editável.

Para usar um controle de lista editável em um modelo de caixa de diálogo, declare uma variável CVSListBox em sua classe de caixa de diálogo. Para dar suporte à troca de dados entre a variável e o controle, defina uma entrada de macro DDX_Control no método da caixa de diálogo DoDataExchange. Por padrão, o controle de lista editável é criado sem botões de edição. Use o método CVSListBoxBase::SetStandardButtons herdado para habilitar os botões de edição.

Para obter mais informações, consulte o diretório Exemplos, o exemplo New Controls, os arquivos Page3.cpp e Page3.h.

Hierarquia de herança

CObject

CCmdTarget

CWnd

CStatic

CVSListBoxBase

CVSListBox

Requisitos

Cabeçalho: afxvslistbox.h

CVSListBox::AddItem

Adiciona uma cadeia de caracteres a um controle de lista.

virtual int AddItem(
    const CString& strIext,
    DWORD_PTR dwData=0,
    int iIndex=-1);

Parâmetros

strIext
[in] Uma referência a uma cadeia de caracteres.

dwData
[in] Um valor de 32 bits específico do aplicativo associado à cadeia de caracteres. O valor padrão é 0.

iIndex
[in] O índice com base em zero da posição que manterá a cadeia de caracteres. Se esse parâmetro iIndex for -1, a cadeia de caracteres será adicionada ao final da lista. O valor padrão é -1.

Valor de retorno

O índice com base em zero da posição da cadeia de caracteres no controle de lista.

Comentários

Use o método CVSListBox::GetItemData para recuperar o valor especificado pelo parâmetro dwData. Esse valor pode ser um inteiro específico do aplicativo ou um ponteiro para outros dados.

CVSListBox::CVSListBox

Constrói um objeto CVSListBox.

CVSListBox();

Valor de retorno

Comentários

CVSListBox::EditItem

Inicia uma operação de edição no texto de um item de controle de lista.

virtual BOOL EditItem(int iIndex);

Parâmetros

iIndex
[in] Índice com base em zero de um item de controle de lista.

Valor de retorno

TRUE se a operação de edição iniciar com êxito, caso contrário, FALSE.

Comentários

O usuário inicia uma operação de edição clicando duas vezes no rótulo de um item ou pressionando a tecla F2 ou BARRA DE ESPAÇOS quando um item tem o foco.

CVSListBox::GetCount

Recupera o número de cadeias de caracteres em um controle de lista editável.

virtual int GetCount() const;

Valor de retorno

O número de itens no controle de lista.

Comentários

Observe que a contagem é maior que o valor do índice do último item, porque o índice é baseado em zero.

CVSListBox::GetItemData

Recupera um valor de 32 bits específico do aplicativo associado a um item de controle de lista editável.

virtual DWORD_PTR GetItemData(int iIndex) const;

Parâmetros

iIndex
[in] O índice baseado em zero de um item de controle de lista editável.

Valor de retorno

O valor de 32 bits que é associado ao item especificado.

Comentários

Use o método CVSListBox::SetItemData ou CVSListBox::AddItem para associar o valor de 32 bits ao item de controle de lista. Esse valor pode ser um inteiro específico do aplicativo ou um ponteiro para outros dados.

CVSListBox::GetItemText

Recupera o texto de um item de controle de lista editável.

virtual CString GetItemText(int iIndex) const;

Parâmetros

iIndex
[in] O índice baseado em zero de um item de controle de lista editável.

Valor de retorno

Um objeto CString que contém o texto do item especificado.

Comentários

CVSListBox::GetListHwnd

Retorna o identificador para o controle de exibição de lista inserida atual.

virtual HWND GetListHwnd() const;

Valor de retorno

Um identificador para o controle de exibição de lista inserida.

Comentários

Use esse método para recuperar um identificador para o controle de exibição de lista inserida que dá suporte à classe CVSListBox.

CVSListBox::GetSelItem

Recupera o índice de base zero do item atualmente selecionado em um controle de lista editável.

virtual int GetSelItem() const;

Valor de retorno

Se esse método for bem-sucedido, o índice baseado em zero do item selecionado no momento; caso contrário, -1.

Comentários

CVSListBox::RemoveItem

Remove um item de um controle de lista editável.

virtual BOOL RemoveItem(int iIndex);

Parâmetros

iIndex
[in] O índice baseado em zero de um item de controle de lista editável.

Valor de retorno

TRUE se o item especificado for removido; caso contrário, FALSE.

Comentários

CVSListBox::SelectItem

Seleciona uma cadeia de caracteres de controle de lista editável.

virtual BOOL SelectItem(int iItem);

Parâmetros

iItem
[in] O índice baseado em zero de um item de controle de lista editável.

Valor de retorno

TRUE se o método for bem-sucedido; caso contrário, FALSE.

Comentários

Esse método seleciona o item especificado e, se for necessário, rola o item para exibição.

CVSListBox::SetItemData

Associa um valor de 32 bits específico do aplicativo com um item de controle de lista editável.

virtual void SetItemData(
    int iIndex,
    DWORD_PTR dwData);

Parâmetros

iIndex
[in] O índice baseado em zero de um item de controle de lista editável.

dwData
[IN] é um valor de 32 bits. Esse valor pode ser um inteiro específico do aplicativo ou um ponteiro para outros dados.

Comentários

Confira também

Gráfico da hierarquia
Classes