Classe CMFCRibbonComboBox
A classe CMFCRibbonComboBox implementa um controle de caixa de combinação que você pode adicionar a uma barra de faixa de opções, um painel de faixa de opções ou um menu pop-up da faixa de opções.
Sintaxe
class CMFCRibbonComboBox : public CMFCRibbonEdit
Membros
Construtores
| Nome | Descrição |
|---|---|
| CMFCRibbonComboBox::CMFCRibbonComboBox | Constrói um objeto CMFCRibbonComboBox. |
Métodos públicos
| Nome | Descrição |
|---|---|
| CMFCRibbonComboBox::AddItem | Acrescenta um item exclusivo à caixa de listagem. |
| CMFCRibbonComboBox::DeleteItem | Exclui um item especificado da caixa de listagem. |
| CMFCRibbonComboBox::EnableDropDownListResize | Especifica se a caixa de listagem pode alterar o tamanho ao mostrar as opções suspensas. |
| CMFCRibbonComboBox::FindItem | Retorna o índice do primeiro item na caixa de listagem que corresponde a uma cadeia de caracteres especificada. |
| CMFCRibbonComboBox::GetCount | Retorna o número de itens na caixa de listagem. |
| CMFCRibbonComboBox::GetCurSel | Obtém o índice do item selecionado no momento na caixa de listagem. |
| CMFCRibbonComboBox::GetDropDownHeight | Obtém a altura da caixa de listagem ao abrir as opções suspensas da caixa de listagem. |
| CMFCRibbonComboBox::GetIntermediateSize | Retorna o tamanho da caixa de combinação, conforme exibido no modo intermediário. |
| CMFCRibbonComboBox::GetItem | Retorna a cadeia de caracteres associada a um item em um índice especificado na caixa de listagem. |
| CMFCRibbonComboBox::GetItemData | Retorna os dados associados a um item em um índice especificado na caixa de listagem. |
| CMFCRibbonComboBox::HasEditBox | Indica se o controle contém uma caixa de edição. |
| CMFCRibbonComboBox::IsResizeDropDownList | Indica se a caixa de listagem pode ou não ser redimensionada. |
| CMFCRibbonComboBox::OnSelectItem | Chamado pela estrutura quando o usuário seleciona um item na caixa de listagem. |
| CMFCRibbonComboBox::RemoveAllItems | Exclui todos os itens da caixa de listagem e limpa a caixa de edição. |
| CMFCRibbonComboBox::SelectItem | Seleciona um item na caixa de listagem. |
| CMFCRibbonComboBox::SetDropDownHeight | Define a altura da caixa de listagem quando ela é acionada. |
Comentários
A caixa de combinação da faixa de opções consiste em uma caixa de listagem combinada com uma etiqueta estática ou etiqueta que pode ser editada pelo usuário. Você deve especificar qual tipo deseja ao criar a caixa de combinação da faixa de opções.
Exemplo
O exemplo a seguir demonstra como construir um objeto da classe CMFCRibbonComboBox, adicionar um item à caixa de combinação, selecionar um item na caixa de combinação e adicionar uma caixa de combinação a um painel.
// Create a simple combo box with two entries:
// The first parameter is the id of the combo box.
// The third parameter is the width of the combo box in pixels.
// The fourth parameter is the display label of the combo box.
// The fifth parameter is the index of the small image of the combo box.
CMFCRibbonComboBox *pComboSimple = new CMFCRibbonComboBox(-1, FALSE, -1, 0, -1);
// Add two items to the combo box and select the first item in the list:
pComboSimple->AddItem(_T("Hi!"));
pComboSimple->AddItem(_T("Hello!"));
pComboSimple->SelectItem(0);
// Add combo button to "Favorites" panel:
// CMFCRibbonPanel* pPanelFavorites
pPanelFavorites->Add(pComboSimple);
Hierarquia de herança
Requisitos
Cabeçalho: afxribboncombobox.h
CMFCRibbonComboBox::AddItem
Acrescenta um item exclusivo à caixa de listagem.
virtual INT_PTR AddItem(
LPCTSTR lpszItem,
DWORD_PTR dwData=0);
Parâmetros
lpszItem
[in] A cadeia de caracteres do item a ser adicionado.
dwData
[in] Os dados associados ao item a ser adicionado.
Valor de retorno
O índice baseado em zero do item acrescentado.
CMFCRibbonComboBox::CMFCRibbonComboBox
Constrói um objeto CMFCRibbonComboBox.
public:
CMFCRibbonComboBox(
UINT nID,
BOOL bHasEditBox=TRUE,
Int nWidth=-1,
LPCTSTR lpszLabel=NULL,
Int nImage=-1);
protected:
CMFCRibbonComboBox();
Parâmetros
Nid
[in] A ID da caixa de combinação.
bHasEditBox
[in] TRUE se você quiser uma caixa de edição dentro do controle; caso contrário, FALSE.
nWidth
[in] Largura da caixa de combinação em pixels; ou -1 para a largura padrão.
lpszLabel
[in] A etiqueta de exibição da caixa de combinação.
nImage
[in] O índice de imagem pequena da caixa de combinação.
Comentários
A largura padrão é de 108 pixels.
CMFCRibbonComboBox::DeleteItem
Exclui um item especificado da caixa de listagem.
BOOL DeleteItem(int iIndex);
BOOL DeleteItem(DWORD_PTR dwData);
BOOL DeleteItem(LPCTSTR lpszText);
Parâmetros
iIndex
[in] O índice de base zero do item a ser excluído.
dwData
[in] Os dados associados ao item a ser excluído.
lpszTexto
[in] A cadeia de caracteres do item a ser excluído. Se houver vários itens com a mesma cadeia de caracteres, o primeiro item será excluído.
Valor de retorno
TRUE se o item especificado tiver sido excluído; caso contrário, FALSE.
Comentários
CMFCRibbonComboBox::EnableDropDownListResize
Especifica se a caixa de listagem pode alterar o tamanho ao mostrar as opções suspensas.
void EnableDropDownListResize(BOOL bEnable=FALSE);
Parâmetros
bEnable
[in] TRUE para habilitar o redimensionamento; FALSE para desabilitar o redimensionamento.
Comentários
Quando o redimensionamento estiver habilitado, a caixa de listagem alterará o tamanho para se ajustar aos itens exibidos.
CMFCRibbonComboBox::FindItem
Retorna o índice do primeiro item na caixa de listagem que corresponde a uma cadeia de caracteres especificada.
int FindItem(LPCTSTR lpszText) const;
Parâmetros
lpszTexto
[in] A cadeia de caracteres de um item na caixa de listagem.
Valor de retorno
O índice baseado em zero do item; ou -1 se o item não for encontrado.
Comentários
CMFCRibbonComboBox::GetCount
Retorna o número de itens na caixa de listagem.
INT_PTR GetCount() const;
Valor de retorno
O número de itens na caixa de listagem ou 0 se a caixa de listagem não contiver itens.
Comentários
CMFCRibbonComboBox::GetCurSel
Obtém o índice do item selecionado no momento na caixa de listagem.
int GetCurSel() const;
Valor de retorno
O índice baseado em zero do item selecionado no momento na caixa de listagem; ou -1 se nenhum item estiver selecionado.
CMFCRibbonComboBox::GetDropDownHeight
Obtém a altura da caixa de listagem ao abrir as opções suspensas da caixa de listagem.
int GetDropDownHeight();
Valor de retorno
A altura, em pixels, da caixa de listagem.
Comentários
CMFCRibbonComboBox::GetIntermediateSize
Retorna o tamanho da caixa de combinação, conforme exibido no modo intermediário.
virtual CSize GetIntermediateSize(CDC* pDC);
Parâmetros
pDC
[in] Ponteiro para um contexto de dispositivo para a caixa de combinação.
Valor de retorno
O tamanho da caixa de combinação.
Comentários
O tamanho retornado é baseado no tamanho da caixa de combinação quando exibe imagens pequenas.
CMFCRibbonComboBox::GetItem
Retorna a cadeia de caracteres associada a um item em um índice especificado na caixa de listagem.
LPCTSTR GetItem(int iIndex) const;
Parâmetros
iIndex
[in] O índice baseado em zero de um item na caixa de listagem.
Valor de retorno
Um ponteiro para a cadeia de caracteres associada ao item; caso contrário, NULL se o parâmetro de índice for inválido ou se o parâmetro de índice for -1 e não houver nenhum item selecionado na caixa de combinação.
Comentários
CMFCRibbonComboBox::GetItemData
Retorna os dados associados a um item em um índice especificado na caixa de listagem.
DWORD_PTR GetItemData(int iIndex) const;
Parâmetros
iIndex
[in] O índice baseado em zero de um item na caixa de listagem.
Valor de retorno
Os dados associados ao item; ou 0 se o item não existir ou se o parâmetro de índice for -1 e não houver nenhum item selecionado na caixa de listagem.
CMFCRibbonComboBox::HasEditBox
Indica se o controle contém uma caixa de edição.
BOOL HasEditBox() const;
Valor de retorno
TRUE se o controle contiver uma caixa de edição; caso contrário, FALSE.
Comentários
CMFCRibbonComboBox::IsResizeDropDownList
Indica se a caixa de listagem pode ou não ser redimensionada.
BOOL IsResizeDropDownList() const;
Valor de retorno
TRUE se a caixa de listagem puder ser redimensionada; caso contrário, FALSE. CMFCRibbonComboBox::EnableDropDownListResize
Comentários
Você pode habilitar o redimensionamento da caixa de listagem usando o método CMFCRibbonComboBox::EnableDropDownListResize.
CMFCRibbonComboBox::OnSelectItem
Chamado pela estrutura quando um usuário seleciona um item na caixa de listagem.
virtual void OnSelectItem(int nItem);
Parâmetros
nItem
[in] O índice do item selecionado.
Comentários
Substitua esse método se você quiser processar uma seleção de entrada de usuário.
CMFCRibbonComboBox::RemoveAllItems
Exclui todos os itens da caixa de listagem e limpa a caixa de edição.
void RemoveAllItems();
Comentários
CMFCRibbonComboBox::SelectItem
Seleciona um item na caixa de listagem.
BOOL SelectItem(int iIndex);
BOOL SelectItem(DWORD_PTR dwData);
BOOL SelectItem(LPCTSTR lpszText);
Parâmetros
iIndex
[in] O índice baseado em zero de um item na caixa de listagem.
dwData
[in] Os dados associados a um item na caixa de listagem.
lpszTexto
[in] A cadeia de caracteres de um item na caixa de listagem.
Valor de retorno
TRUE se o método foi bem-sucedido; caso contrário, FALSE.
Comentários
CMFCRibbonComboBox::SetDropDownHeight
Define a altura da caixa de listagem quando ela é acionada.
void SetDropDownHeight(int nHeight);
Parâmetros
nHeight
[in] A altura, em pixels, da caixa de listagem.
Comentários
A altura padrão é 150 pixels.