CToolBarCtrl Classe

Fornece a funcionalidade do controle comum da barra de ferramentas do Windows.

Sintaxe

class CToolBarCtrl : public CWnd

Membros

Construtores Públicos

Métodos Públicos

Observações

Este controlo (e, portanto, a CToolBarCtrl classe) está disponível apenas para programas a correr sob Windows 95/98 e Windows NT versão 3.51 e posteriores.

Um controlo comum na barra de ferramentas do Windows é uma janela retangular filha que contém um ou mais botões. Estes botões podem mostrar uma imagem bitmap, uma cadeia, ou ambos. Quando o utilizador escolhe um botão, envia uma mensagem de comando para a janela proprietária da barra de ferramentas. Normalmente, os botões numa barra de ferramentas correspondem a itens no menu da aplicação; Oferecem uma forma mais direta para o utilizador aceder aos comandos de uma aplicação.

CToolBarCtrl Os objetos contêm várias estruturas de dados internas importantes: uma lista de bitmaps de imagem de botão ou uma lista de imagens, uma lista de cadeias de etiquetas de botões e uma lista de TBBUTTON estruturas que associam uma imagem e/ou cadeia à posição, estilo, estado e ID de comando do botão. Cada um dos elementos dessas estruturas de dados é referido por um índice baseado em zero. Antes de usar um CToolBarCtrl objeto, você deve configurar essas estruturas de dados. A lista de cordas só pode ser usada para etiquetas de botões; Não consegues recuperar strings da barra de ferramentas.

Para usar um CToolBarCtrl objeto, normalmente segue estes passos:

1. Constrói o CToolBarCtrl objeto.

2. Chama Create para criar o controlo comum da barra de ferramentas do Windows e anexá-lo ao CToolBarCtrl objeto. Indique o estilo da barra de ferramentas usando estilos, como TBSTYLE_TRANSPARENT para uma barra transparente ou TBSTYLE_DROPDOWN para uma barra de ferramentas que suporta botões de estilo suspenso.

3. Identifique como quer que os botões na barra de ferramentas sejam exibidos:

   • Para usar imagens bitmap para botões, adicione os bitmaps de botões à barra de ferramentas chamando AddBitmap.

   • Para usar imagens exibidas de uma lista de imagens para botões, especifique a lista de imagens chamando SetImageList, SetHotImageList, ou SetDisabledImageList.

   • Para usar etiquetas de strings para botões, adicione as strings à barra de ferramentas chamando AddString e/ou AddStrings.

4. Adicionar estruturas de botões à barra de ferramentas chamando AddButtons.

5. Se quiseres dicas de ferramenta para um botão de barra de ferramentas numa janela de proprietário que não seja um CFrameWnd, tens de tratar as TTN_NEEDTEXT mensagens na janela de proprietário da barra de ferramentas, conforme descrito em Notificações de Gestão de Dicas de Ferramenta. Se a janela principal da barra de ferramentas for derivada de CFrameWnd, as dicas de ferramenta são exibidas sem qualquer esforço extra da sua parte porque CFrameWnd fornece um handler padrão.

6. Se você quiser que o usuário possa personalizar a barra de ferramentas, manipule as mensagens de notificação de personalização na janela do proprietário, conforme descrito em Manipulando notificações de personalização.

Podes usar SaveState para guardar o estado atual de um controlo da barra de ferramentas no registo e RestoreState restaurar o estado com base na informação previamente armazenada no registo. Para além de guardar o estado da barra de ferramentas entre utilizações da aplicação, as aplicações normalmente armazenam o estado antes do utilizador começar a personalizar a barra de ferramentas, caso mais tarde queira restaurar a barra de ferramentas ao seu estado original.

Suporte para Internet Explorer Versão 4.0 e Posteriores

Para suportar funcionalidades introduzidas no Internet Explorer, versão 4.0 e posteriores, o MFC oferece suporte para listas de imagens e estilos transparentes e planos para controlos de barra de ferramentas.

Uma barra de ferramentas transparente permite que o cliente sob a barra de ferramentas apareça através dela. Para criar uma barra de ferramentas transparente, use ambos TBSTYLE_FLAT os estilos.TBSTYLE_TRANSPARENT As barras de ferramentas transparentes apresentam hot tracking; ou seja, quando o ponteiro do rato se move sobre um botão quente na barra de ferramentas, a aparência do botão muda. As barras de ferramentas criadas apenas com o TBSTYLE_FLAT estilo contêm botões que não são transparentes.

O suporte para listas de imagens permite um controlo com maior flexibilidade para comportamento padrão, imagens quentes e imagens desativadas. Use GetImageList, GetHotImageList, e GetDisabledImageList com a barra de ferramentas transparente para manipular a imagem de acordo com o seu estado:

Para mais informações sobre a utilização CToolBarCtrlde , veja Controlos e Utilização CToolBarCtrlde .

Hierarquia de herança

CObject

CCmdTarget

CWnd

CToolBarCtrl

Requerimentos

Cabeçalho:afxcmn.h

CToolBarCtrl::AddBitmap

Adiciona uma ou mais imagens de botão à lista de imagens de botão armazenadas no controlo da barra de ferramentas.

int AddBitmap(
    int nNumButtons,
    UINT nBitmapID);

int AddBitmap(
    int nNumButtons,
    CBitmap* pBitmap);

Parâmetros

nNumButtons
Número de imagens de botões no bitmap.

nBitmapID
Identificador de recurso do bitmap que contém a imagem do botão ou imagens a adicionar.

pBitmap
Apontar para o CBitmap objeto que contém a imagem ou imagens do botão para adicionar.

Valor de retorno

Índice base zero da primeira nova imagem se bem-sucedido; caso contrário - 1.

Observações

Podes usar a API CreateMappedBitmap do Windows para mapear cores antes de adicionar o bitmap à barra de ferramentas. Se passar um ponteiro para um CBitMap objeto, deve garantir que o bitmap não é destruído até depois da barra de ferramentas ser destruída.

CToolBarCtrl::AddButtons

Adiciona um ou mais botões ao controlo da barra de ferramentas.

BOOL AddButtons(
    int nNumButtons,
    LPTBBUTTON lpButtons);

Parâmetros

nNumButtons
Número de botões para adicionar.

lpButtons
Endereço de um array de TBBUTTON estruturas que contém informação sobre os botões a adicionar. Deve haver o mesmo número de elementos no array que os botões especificados por nNumButtons.

Valor de retorno

Não nulo se for bem-sucedido; caso contrário, zero.

Observações

O lpButtons ponteiro aponta para um array de TBBUTTON estruturas. Cada TBBUTTON estrutura associa o botão a ser adicionado ao estilo do botão, imagem e/ou string, ID de comando, estado e dados definidos pelo utilizador:

typedef struct _TBBUTTON {
    int iBitmap;    // zero-based index of button image
    int idCommand;  // command to be sent when button pressed
    BYTE fsState;   // button state--see below
    BYTE fsStyle;   // button style--see below
    DWORD dwData;   // application-defined value
    int iString;    // zero-based index of button label string
} TBBUTTON;

Os membros são os seguintes:

• iBitmap

  Índice zero da imagem do botão, -1 se não existe imagem para este botão.

• idCommand

  Identificador de comando associado ao botão. Este identificador é enviado numa WM_COMMAND mensagem quando o botão é escolhido. Se o fsStyle membro tiver o valor, TBSTYLE_SEP esse membro deve ser zero.

• fsState

  Bandeiras do estado do botão. Pode ser uma combinação dos valores listados abaixo:

  • TBSTATE_CHECKED O botão tem o TBSTYLE_CHECKED estilo e está a ser pressionado.

  • TBSTATE_ENABLED O botão aceita a entrada do utilizador. Um botão que não tem este estado não aceita a entrada do utilizador e fica cinzento.

  • TBSTATE_HIDDEN O botão não é visível e não pode receber a entrada do utilizador.

  • TBSTATE_INDETERMINATE O botão está cinzento.

  • TBSTATE_PRESSED O botão está a ser pressionado.

  • TBSTATE_WRAP Uma quebra de linha segue o botão. O botão também deve ter o TBSTATE_ENABLED estado.

• fsStyle

  Estilo de botões. Pode ser uma combinação dos valores listados abaixo:

  • TBSTYLE_BUTTON Cria um botão padrão.

  • TBSTYLE_CHECK Cria um botão que alterna entre os estados pressionado e não pressionado cada vez que o utilizador clica. O botão tem uma cor de fundo diferente quando está no estado pressionado.

  • TBSTYLE_CHECKGROUP Cria um botão de verificação que permanece pressionado até que outro botão do grupo seja pressionado.

  • TBSTYLE_GROUP Cria um botão que permanece pressionado até que outro botão do grupo seja pressionado.

  • TBSTYLE_SEP Cria um separador, criando um pequeno espaço entre os grupos de botões. Um botão com este estilo não recebe a entrada do utilizador.

• dwData

  Dados definidos pelo utilizador.

• iString

  Índice em base zero da cadeia para usar como etiqueta do botão, -1 se não houver sequência para este botão.

A imagem e/ou cadeia cujo índice forneces deve ter sido previamente adicionada à lista do controlo da barra de ferramentas usando AddBitmap, AddString, e/ou AddStrings.

CToolBarCtrl::AddString

Adiciona uma nova string, passada como um ID de recurso, à lista interna de strings da barra de ferramentas.

int AddString(UINT nStringID);

Parâmetros

nStringID
Identificador de recurso do recurso string para adicionar à lista de strings do controlo da barra de ferramentas.

Valor de retorno

O índice baseado em zero da primeira nova cadeia adicionado se bem-sucedido; caso contrário -1.

CToolBarCtrl::AddStrings

Adiciona uma nova cadeia ou cadeias à lista de cadeias disponíveis para um controlo da barra de ferramentas.

int AddStrings(LPCTSTR lpszStrings);

Parâmetros

lpszStrings
Endereço de um buffer que contém uma ou mais NULLstrings -terminated para adicionar à lista de strings da barra de ferramentas. A última cadeia deve ser terminada com dois NULL caracteres.

Valor de retorno

O índice baseado em zero da primeira nova cadeia adicionado se bem-sucedido; caso contrário -1.

Observações

As cadeias no buffer devem ser separadas por um NULL carácter. Deves garantir que a última cadeia tem dois NULL terminadores. Para formatar corretamente uma cadeia constante, pode escrevê-la como:

// one null added automatically
lpszStrings = _T("Only one string to add\0");

or:

// adds three strings with one call
lpszStrings = _T("String 1\0String 2\0String 3\0");

Não deves passar um CString objeto para esta função, pois não é possível ter mais do que um NULL carácter num CString.

CToolBarCtrl::AutoSize

Redimensiona todo o controlo da barra de ferramentas.

void AutoSize();

Observações

Deve chamar esta função quando o tamanho da janela pai muda ou quando o tamanho da barra de ferramentas muda (como quando define o tamanho do botão ou bitmap, ou adiciona strings).

CToolBarCtrl::ChangeBitmap

Altera o bitmap para um botão no controlo atual da barra de ferramentas.

BOOL ChangeBitmap(
    int idButton,
    int iBitmap);

Parâmetros

idButton
[dentro] Identificador de comando do botão que vai receber um novo bitmap.

iBitmap
[dentro] Índice base zero de uma imagem na lista de imagens do controlo atual da barra de ferramentas.

Valor de retorno

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

Observações

Se este método for bem-sucedido, o sistema apresenta a imagem especificada no botão especificado.

Este método envia a TB_CHANGEBITMAP mensagem, que é descrita no SDK do Windows.

Example

O exemplo de código seguinte altera o bitmap do botão de Gravação de Ficheiros para o bitmap do botão Sobre .

{
   // Change the bitmap for the File Save button, whose
   // command ID is ID_FILE_SAVE, to the bitmap for the
   // About button, whose index is 7.
   CToolBarCtrl &m_toolBarCtrl = m_wndToolBar.GetToolBarCtrl();
   BOOL bRet = m_toolBarCtrl.ChangeBitmap(ID_FILE_SAVE, 7);
}

CToolBarCtrl::CheckButton

Verifica ou limpa um dado botão num controlo da barra de ferramentas.

BOOL CheckButton(
    int nID,
    BOOL bCheck = TRUE);

Parâmetros

nID
Identificador do comando do botão para verificar ou limpar.

bCheck
TRUE para verificar o botão, FALSE para o limpar.

Valor de retorno

Não nulo se for bem-sucedido; caso contrário, zero.

Observações

Quando um botão foi verificado, parece que foi pressionado. Se quiseres mudar o estado de mais do que um botão, considera ligar SetState em vez disso.

CToolBarCtrl::CommandToIndex

Recupera o índice baseado em zero para o botão associado ao identificador de comando especificado.

UINT CommandToIndex(UINT nID) const;

Parâmetros

nID
ID de comando cujo índice de botão queres encontrar.

Valor de retorno

O índice baseado em zero para o botão associado ao ID do comando.

Observações

CToolBarCtrl::Create

Cria um controlo na barra de ferramentas e anexa-o a um CToolBarCtrl objeto.

virtual BOOL Create(
    DWORD dwStyle,
    const RECT& rect,
    CWnd* pParentWnd,
    UINT nID);

Parâmetros

dwStyle
Especifica o estilo do controlo da barra de ferramentas. As barras de ferramentas devem ter sempre esse WS_CHILD estilo. Além disso, pode especificar qualquer combinação de estilos de barra de ferramentas e estilos de janela, conforme descrito em Observações.

rect
Opcionalmente, especifica o tamanho e a posição do controlo da barra de ferramentas. Pode ser um CRect objeto ou uma RECT estrutura.

pParentWnd
Especifica a janela principal do controlo da barra de ferramentas. Não pode ser NULL.

nID
Especifica o ID do controlo da barra de ferramentas.

Valor de retorno

Não nulo se for bem-sucedido; caso contrário, zero.

Observações

Constróis um A CToolBarCtrl em dois passos. Primeiro, chama o construtor, e depois chama Create, que cria o controlo da barra de ferramentas e o anexa ao CToolBarCtrl objeto. Aplique os seguintes estilos de janela a um controlo da barra de ferramentas.

• WS_CHILD Sempre

• WS_VISIBLE Normalmente

• WS_DISABLED Raramente

Veja CreateWindow no SDK do Windows uma descrição dos estilos de janelas.

Opcionalmente, aplique uma combinação de estilos de controlo comuns, conforme descrito no SDK do Windows.

Aplique uma combinação de estilos de barra de ferramentas ao controlo ou aos próprios botões. Os estilos são descritos no tópico Controlo da Barra de Ferramentas e Estilos de Botões no SDK do Windows.

Para usar estilos de barra de ferramentas estendidos, chame SetExtendedStyle depois de chamar Create. Para criar uma barra de ferramentas com estilos de janela estendidos, chame CToolBarCtrl::CreateEx em vez de Create.

O controlo da barra de ferramentas define automaticamente o tamanho e a posição da janela da barra de ferramentas. A altura baseia-se na altura dos botões na barra de ferramentas. A largura é igual à largura da área cliente da janela principal. Os CCS_TOP estilos e CCS_BOTTOM determinam se a barra de ferramentas está posicionada no topo ou na parte inferior da área do cliente. Por defeito, uma barra de ferramentas tem esse CCS_TOP estilo.

CToolBarCtrl::CreateEx

Cria um controlo (uma janela filha) e associa-o ao CToolBarCtrl objeto.

virtual BOOL CreateEx(
    DWORD dwExStyle,
    DWORD dwStyle,
    const RECT& rect,
    CWnd* pParentWnd,
    UINT nID);

Parâmetros

dwExStyle
Especifica o estilo estendido do controlo que está a ser criado. Para uma lista de estilos extensos do Windows, consulte o dwExStyle parâmetro para CreateWindowEx no SDK do Windows.

dwStyle
Especifica o estilo do controlo da barra de ferramentas. As barras de ferramentas devem ter sempre esse WS_CHILD estilo. Além disso, pode especificar qualquer combinação de estilos de barra de ferramentas e estilos de janela, conforme descrito na secção Observações de Create.

rect
Uma referência a uma RECT estrutura que descreve o tamanho e a posição da janela a ser criada, em coordenadas cliente de pParentWnd.

pParentWnd
Um apontador para a janela que é o pai do controlo.

nID
O ID da janela criança do controlo.

Valor de retorno

Não nulo se for bem-sucedido; caso contrário, 0.

Observações

Use CreateEx em vez de Create para aplicar estilos estendidos do Windows, especificados pelo prefácio WS_EX_de estilo estendido do Windows . CreateEx cria o controlo com os estilos estendidos do Windows especificados por dwExStyle. Defina estilos estendidos específicos para um controlo usando SetExtendedStyle. Por exemplo, use CreateEx para definir estilos como WS_EX_CONTEXTHELP, mas use SetExtendedStyle para definir estilos como TBSTYLE_EX_DRAWDDARROWS. Para mais informações, consulte os estilos descritos em Toolbar Extended Styles no Windows SDK.

CToolBarCtrl::CToolBarCtrl

Constrói um CToolBarCtrl objeto.

CToolBarCtrl();

Observações

Tem de ligar Create para tornar a barra de ferramentas utilizável.

CToolBarCtrl::Customize

Mostra a caixa de diálogo Personalizar Barra de Ferramentas.

void Customize();

Observações

Esta caixa de diálogo permite ao utilizador personalizar a barra de ferramentas adicionando e eliminando botões. Para suportar a personalização, a janela principal da sua barra de ferramentas deve tratar das mensagens de notificação de personalização conforme descrito em Gestão das Notificações de Personalização. A sua barra de ferramentas também deve ter sido criada com o CCS_ADJUSTABLE estilo, conforme descrito em CToolBarCtrl::Create.

CToolBarCtrl::DeleteButton

Apaga um botão do controlo da barra de ferramentas.

BOOL DeleteButton(int nIndex);

Parâmetros

nIndex
Índice zero do botão a eliminar.

Valor de retorno

Não nulo se for bem-sucedido; caso contrário, zero.

Observações

CToolBarCtrl::EnableButton

Ativa ou desativa o botão especificado num controlo da barra de ferramentas.

BOOL EnableButton(
    int nID,
    BOOL bEnable = TRUE);

Parâmetros

nID
Identificador do comando do botão para ativar ou desativar.

bEnable
TRUE para ativar o botão; FALSE para desativar o botão.

Valor de retorno

Não nulo se for bem-sucedido; caso contrário, zero.

Observações

Quando um botão está ativado, pode ser pressionado e verificado. Se quiseres mudar o estado de mais do que um botão, considera ligar SetState em vez disso.

CToolBarCtrl::GetAnchorHighlight

Recupera a definição de destaque âncora para uma barra de ferramentas.

BOOL GetAnchorHighlight() const;

Valor de retorno

Se não for zero, o realce âncora está ativado. Se for zero, o realce âncora está desativado.

Observações

Esta função membro implementa o comportamento da mensagem TB_GETANCHORHIGHLIGHTWin32 , conforme descrito no SDK do Windows.

CToolBarCtrl::GetBitmap

Recupera o índice do bitmap associado a um botão numa barra de ferramentas.

int GetBitmap(int nID) const;

Parâmetros

nID
Identificador de comando do botão cujo índice bitmap deve ser recuperado.

Valor de retorno

Devolve o índice do bitmap se for bem-sucedido, ou zero caso contrário.

Observações

Implementa a funcionalidade de TB_GETBITMAP no SDK do Windows.

CToolBarCtrl::GetBitmapFlags

Recupera as flags bitmap da barra de ferramentas.

UINT GetBitmapFlags() const;

Valor de retorno

A UINT que tem a TBBF_LARGE flag definida se o ecrã suporta bitmaps grandes na barra de ferramentas, limpo caso contrário.

Observações

Deves chamá-lo depois de criares a barra de ferramentas, mas antes de adicionares bitmaps à barra de ferramentas. O valor de retorno indica se o ecrã suporta bitmaps grandes ou não. Se o ecrã suportar bitmaps grandes e se optar por usá-los, chame SetBitmapSize e SetButtonSize antes de adicionar o seu bitmap grande usando AddBitmap.

CToolBarCtrl::GetButton

Recupera informações sobre o botão especificado num controlo da barra de ferramentas.

BOOL GetButton(
    int nIndex,
    LPTBBUTTON lpButton) const;

Parâmetros

nIndex
Índice em base zero do botão para o qual se deve recolher informação.

lpButton
Endereço da TBBUTTON estrutura que deve receber uma cópia da informação do botão. Consulte CToolBarCtrl::AddButtons para informações sobre a TBBUTTON estrutura.

Valor de retorno

Não nulo se for bem-sucedido; caso contrário, zero.

CToolBarCtrl::GetButtonCount

Recupera a contagem dos botões atualmente no controlo da barra de ferramentas.

int GetButtonCount() const;

Valor de retorno

A contagem dos botões.

CToolBarCtrl::GetButtonInfo

Recupera a informação de um botão numa barra de ferramentas.

int GetButtonInfo(
    int nID,
    TBBUTTONINFO* ptbbi) const;

Parâmetros

nID
O identificador do botão.

ptbbi
Um apontador para uma TBBUTTONINFO estrutura que recebe a informação do botão.

Valor de retorno

O índice em base zero do botão, se for bem-sucedido; caso contrário -1.

Observações

Esta função membro implementa o comportamento da mensagem TB_GETBUTTONINFOWin32 , conforme descrito no SDK do Windows.

CToolBarCtrl::GetButtonSize

Fica do tamanho de um botão de barra de ferramentas.

DWORD GetButtonSize() const;

Valor de retorno

Um DWORD valor que contém os valores de largura e altura em e LOWORDHIWORD, respetivamente.

CToolBarCtrl::GetButtonText

Recupera o texto de exibição de um botão especificado no controlo atual da barra de ferramentas.

CString GetButtonText(int idButton) const;

Parâmetros

idButton
[dentro] O identificador do botão cujo texto de exibição é recuperado.

Valor de retorno

A CString que contém o texto de exibição do botão especificado.

Observações

Este método envia a TB_GETBUTTONTEXT mensagem, que é descrita no SDK do Windows.

CToolBarCtrl::GetColorScheme

Recupera o esquema de cores do controlo atual da barra de ferramentas.

BOOL GetColorScheme(COLORSCHEME* lpColorScheme) const;

Parâmetros

lpColorScheme
[fora] Apontador para uma COLORSCHEME estrutura que recebe a informação do esquema de cores. Quando este método regressa, a estrutura descreve a cor de destaque e a cor da sombra do controlo da barra de ferramentas.

Valor de retorno

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

Observações

Este método envia a TB_GETCOLORSCHEME mensagem, que é descrita no SDK do Windows.

CToolBarCtrl::GetDisabledImageList

Recupera a lista de imagens que um controlo da barra de ferramentas usa para mostrar botões desativados.

CImageList* GetDisabledImageList() const;

Valor de retorno

Um ponteiro para um CImageList objeto, ou NULL se não estiver definida nenhuma lista de imagens desativada.

Observações

Esta função membro implementa o comportamento da mensagem TB_GETDISABLEDIMAGELISTWin32 , conforme descrito no SDK do Windows. A implementação MFC de GetDisabledImageList utiliza um CImageList objeto que contém as imagens dos botões do controlo da barra de ferramentas, em vez de um handle para uma lista de imagens.

CToolBarCtrl::GetDropTarget

Recupera a IDropTarget interface de um controlo de barra de ferramentas.

HRESULT GetDropTarget(IDropTarget** ppDropTarget) const;

Parâmetros

ppDropTarget
Um apontador para um IDropTarget ponteiro de interface. Se ocorrer um erro, um NULL ponteiro é colocado nesse endereço.

Valor de retorno

Devolve um HRESULT valor que indica o sucesso ou fracasso da operação.

Observações

Esta função membro implementa o comportamento da mensagem TB_GETOBJECTWin32 , conforme descrito no SDK do Windows.

CToolBarCtrl::GetExtendedStyle

Recupera os estilos estendidos para um controlo de barra de ferramentas.

DWORD GetExtendedStyle() const;

Valor de retorno

A DWORD que representa os estilos estendidos atualmente em uso para o controlo da barra de ferramentas. Para uma lista de estilos, consulte Estilos Estendidos da Barra de Ferramentas, no SDK do Windows.

Observações

Esta função membro implementa o comportamento da mensagem TB_GETEXTENDEDSTYLEWin32 , conforme descrito no SDK do Windows.

CToolBarCtrl::GetHotImageList

Recupera a lista de imagens que um controlo da barra de ferramentas usa para mostrar os botões "quentes". Um botão de acesso aparece destacado quando o ponteiro do rato está por cima.

CImageList* GetHotImageList() const;

Valor de retorno

Um ponteiro para um CImageList objeto, ou NULL se não estiver definida nenhuma lista de imagens desativada.

Observações

Esta função membro implementa o comportamento da mensagem TB_GETHOTIMAGELISTWin32 , conforme descrito no SDK do Windows. Um botão de acesso aparece destacado quando o ponteiro do rato está por cima.

CToolBarCtrl::GetHotItem

Recupera o índice do item quente numa barra de ferramentas.

int GetHotItem() const;

Valor de retorno

O índice zero do item quente numa barra de ferramentas.

Observações

Esta função membro implementa o comportamento da mensagem TB_GETHOTITEMWin32 , conforme descrito no SDK do Windows.

CToolBarCtrl::GetImageList

Recupera a lista de imagens que um controlo da barra de ferramentas usa para mostrar botões no seu estado predefinido.

CImageList* GetImageList() const;

Valor de retorno

Um apontador para um CImageList objeto, ou NULL se não estiver definida uma lista de imagens.

Observações

Esta função membro implementa o comportamento da mensagem TB_GETIMAGELISTWin32 , conforme descrito no SDK do Windows.

CToolBarCtrl::GetInsertMark

Recupera a marca de inserção atual para a barra de ferramentas.

void GetInsertMark(TBINSERTMARK* ptbim) const;

Parâmetros

ptbim
Um ponteiro para uma TBINSERTMARK estrutura que recebe a marca de inserção.

Observações

Esta função membro implementa o comportamento da mensagem TB_GETINSERTMARKWin32 , conforme descrito no SDK do Windows.

CToolBarCtrl::GetInsertMarkColor

Recupera a cor usada para desenhar a marca de inserção da barra de ferramentas.

COLORREF GetInsertMarkColor() const;

Valor de retorno

Um valor que contém a cor atual da COLORREF marca de inserção.

Observações

Esta função membro implementa o comportamento da mensagem TB_GETINSERTMARKCOLORWin32 , conforme descrito no SDK do Windows.

CToolBarCtrl::GetItemRect

Recupera o retângulo delimitador de um botão num controlo da barra de ferramentas.

BOOL GetItemRect(
    int nIndex,
    LPRECT lpRect) const;

Parâmetros

nIndex
Índice em base zero do botão para o qual se deve recolher informação.

lpRect
Endereço de uma RECT estrutura ou objeto CRect que recebe as coordenadas do retângulo delimitador.

Valor de retorno

Não nulo se for bem-sucedido; caso contrário, zero.

Observações

Esta função não recupera o retângulo delimitador para botões cujo estado está definido para TBSTATE_HIDDEN.

CToolBarCtrl::GetMaxSize

Recupera o tamanho total de todos os botões e separadores visíveis na barra de ferramentas.

BOOL GetMaxSize(LPSIZE pSize) const;

Parâmetros

pSize
Um ponteiro para uma SIZE estrutura que recebe o tamanho dos itens.

Valor de retorno

Não nulo se for bem-sucedido; caso contrário, 0.

Observações

Esta função membro implementa o comportamento da mensagem TB_GETMAXSIZEWin32 , conforme descrito no SDK do Windows.

CToolBarCtrl::GetMaxTextRows

Recupera o número máximo de linhas de texto exibidas num botão da barra de ferramentas.

int GetMaxTextRows() const;

Valor de retorno

O número máximo de linhas de texto exibido num botão da barra de ferramentas.

CToolBarCtrl::GetMetrics

Recupera as métricas do CToolBarCtrl objeto.

void GetMetrics(LPTBMETRICS ptbm) const;

Parâmetros

ptbm
Um apontador para a TBMETRICS estrutura do CToolBarCtrl objeto.

Observações

Esta função membro emula a funcionalidade da TB_GETMETRICS mensagem, conforme descrito no SDK do Windows.

CToolBarCtrl::GetPadding

Recupera o preenchimento horizontal e vertical do controlo atual da barra de ferramentas.

BOOL GetPadding(
    int* pnHorzPadding,
    int* pnVertPadding) const;

Parâmetros

pnHorzPadding
[fora] Um inteiro que recebe o preenchimento horizontal do controlo da barra de ferramentas, em pixels.

pnVertPadding
[fora] Um inteiro que recebe o preenchimento vertical do controlo da barra de ferramentas, em pixels.

Valor de retorno

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

Observações

Este método envia a TB_GETPADDING mensagem, que é descrita no SDK do Windows.

CToolBarCtrl::GetPressedImageList

Recupera a lista de imagens que o controlo atual da barra de ferramentas usa para representar botões no estado pressionado.

CImageList* GetPressedImageList();

Valor de retorno

Apontador para um CImageList que contém a lista de imagens para o controlo atual, ou NULL se não estiver definida tal lista de imagens.

Observações

Este método envia a TB_GETPRESSEDIMAGELIST mensagem, que é descrita no SDK do Windows.

CToolBarCtrl::GetRect

Recupera o retângulo delimitador para um botão de barra de ferramentas especificado.

BOOL GetRect(
    int nID,
    LPRECT lpRect) const;

Parâmetros

nID
O identificador do botão.

lpRect
Um ponteiro para uma RECT estrutura para receber a informação do retângulo delimitador.

Valor de retorno

TRUE se for bem-sucedida; caso contrário, FALSE.

Observações

Esta função membro implementa o comportamento da mensagem TB_GETRECTWin32 , conforme descrito no SDK do Windows.

CToolBarCtrl::GetRows

Recupera o número de linhas de botões atualmente apresentadas pelo controlo da barra de ferramentas.

int GetRows() const;

Valor de retorno

Número de filas de botões atualmente exibidos na barra de ferramentas.

Observações

Note que o número de linhas será sempre um, a menos que a barra de ferramentas tenha sido criada com esse TBSTYLE_WRAPABLE estilo.

CToolBarCtrl::GetState

Recupera informações sobre o estado do botão especificado num controlo da barra de ferramentas, como se está ativado, pressionado ou verificado.

int GetState(int nID) const;

Parâmetros

nID
Identificador de comando do botão para obter informação.

Valor de retorno

O botão indica a informação se for bem-sucedido ou se -1 de outra forma. A informação do estado do botão pode ser uma combinação dos valores listados em CToolBarCtrl::AddButtons.

Observações

Esta função é especialmente útil se quiser recuperar mais do que um dos estados dos botões. Para recuperar apenas um estado, use uma das seguintes funções membro: IsButtonEnabled, IsButtonChecked, IsButtonPressed, IsButtonHidden, ou IsButtonIndeterminate. No entanto, a GetState função membro é a única forma de detetar o estado do TBSTATE_WRAP botão.

CToolBarCtrl::GetString

Recupera uma cadeia de ferramentas de ferramentas.

int GetString(
    int nString,
    LPTSTR lpstrString,
    int cchMaxLen) const;

int GetString(
    int nString,
    CString& str) const;

Parâmetros

nString
Índice da corda.

lpstrString
Apontador para um buffer usado para devolver a cadeia.

cchMaxLen
Comprimento do buffer em bytes.

str
A cadeia de caracteres.

Valor de retorno

O comprimento da corda se for bem-sucedido, -1 se não.

Observações

Esta função membro implementa o comportamento da mensagem TB_GETSTRINGWin32 , conforme descrito no SDK do Windows.

CToolBarCtrl::GetStyle

Obtém os estilos atualmente aplicados a um controlo da barra de ferramentas.

DWORD GetStyle() const;

Valor de retorno

A DWORD contendo uma combinação de estilos de controlo da barra de ferramentas, conforme descrito no SDK do Windows.

CToolBarCtrl::GetToolTips

Recupera o alavanca do controlo tooltip, se existir, associado ao controlo da barra de ferramentas.

CToolTipCtrl* GetToolTips() const;

Valor de retorno

Um ponteiro para o CToolTipCtrl objeto associado a esta barra de ferramentas ou NULL , se a barra não tiver controlo de dica de ferramenta associado.

Observações

Como o controlo da barra de ferramentas normalmente cria e mantém o seu próprio controlo de tooltip, a maioria dos programas não precisa de chamar esta função.

CToolBarCtrl::HitTest

Determina onde se encontra um ponto num controlo da barra de ferramentas.

int HitTest(LPPOINT ppt) const;

Parâmetros

ppt
Um apontador para uma POINT estrutura que contém a coordenada x do teste de acerto no x membro e a coordenada y do teste de acerto no y membro. As coordenadas são relativas à área do cliente da barra de ferramentas.

Valor de retorno

Um valor inteiro que indica a localização de um ponto numa barra de ferramentas. Se o valor for zero ou positivo, esse valor de retorno é o índice baseado em zero do item não separador em que o ponto se encontra.

Se o valor de retorno for negativo, o ponto não está dentro de um botão. O valor absoluto do valor de retorno é o índice de um item separador ou do item não separador mais próximo.

Observações

Esta função membro implementa o comportamento da mensagem TB_HITTESTWin32 , conforme descrito no SDK do Windows.

CToolBarCtrl::HideButton

Esconde ou mostra o botão especificado num controlo da barra de ferramentas.

BOOL HideButton(
    int nID,
    BOOL bHide = TRUE);

Parâmetros

nID
Identificador de comando do botão para esconder ou mostrar.

bHide
TRUE para esconder o botão, FALSE para o mostrar.

Valor de retorno

Não nulo se for bem-sucedido; caso contrário, zero.

Observações

Se quiseres mudar o estado de mais do que um botão, considera ligar SetState em vez disso.

CToolBarCtrl::Indeterminate

Define ou limpa o estado indeterminado do botão especificado num controlo da barra de ferramentas.

BOOL Indeterminate(
    int nID,
    BOOL bIndeterminate = TRUE);

Parâmetros

nID
Identificador de comando do botão cujo estado indeterminado deve ser definido ou limpo.

bIndeterminate
TRUE para definir o estado indeterminado para o botão especificado, FALSE para o eliminar.

Valor de retorno

Não nulo se for bem-sucedido; caso contrário, zero.

Observações

Botões indeterminados são apresentados em cinzento, tal como o botão a negrito na barra de ferramentas de um processador de texto ficaria quando o texto selecionado contém caracteres a negrito e regulares. Se quiseres mudar o estado de mais do que um botão, considera ligar SetState em vez disso.

CToolBarCtrl::InsertButton

Insere um botão num controlo da barra de ferramentas.

BOOL InsertButton(
    int nIndex,
    LPTBBUTTON lpButton);

Parâmetros

nIndex
Índice zero de um botão. Esta função insere o novo botão à esquerda deste botão.

lpButton
Endereço de uma TBBUTTON estrutura que contém informação sobre o botão a inserir. Veja CToolBarCtrl::AddButtons para uma descrição da TBBUTTON estrutura.

Valor de retorno

Não nulo se for bem-sucedido; caso contrário, zero.

Observações

A imagem e/ou cadeia cujo índice forneces deve ter sido previamente adicionada à lista do controlo da barra de ferramentas usando AddBitmap, AddString, e/ou AddStrings.

CToolBarCtrl::InsertMarkHitTest

Recupera a informação da marca de inserção de um ponto numa barra de ferramentas.

BOOL InsertMarkHitTest(
    LPPOINT ppt,
    LPTBINSERTMARK ptbim) const;

Parâmetros

ppt
Um apontador para uma POINT estrutura que contém as coordenadas do teste de acerto, em relação à área do cliente da barra de ferramentas.

ptbim
Um ponteiro para uma TBINSERTMARK estrutura que recebe a informação da marca de inserção.

Valor de retorno

Não nulo se for bem-sucedido; caso contrário, zero.

Observações

Esta função membro implementa o comportamento da mensagem TB_INSERTMARKHITTESTWin32 , conforme descrito no SDK do Windows.

CToolBarCtrl::IsButtonChecked

Determina se o botão especificado num controlo da barra de ferramentas está assinalado.

BOOL IsButtonChecked(int nID) const;

Parâmetros

nID
Identificador de comando do botão na barra de ferramentas.

Valor de retorno

Diferente de zero se o botão estiver marcado; caso contrário, zero.

Observações

Considera ligar GetState se quiseres recuperar mais do que um estado de botão.

CToolBarCtrl::IsButtonEnabled

Determina se o botão especificado num controlo da barra de ferramentas está ativado.

BOOL IsButtonEnabled(int nID) const;

Parâmetros

nID
Identificador de comando do botão na barra de ferramentas.

Valor de retorno

Diferente de zero se o botão estiver ativado; caso contrário, zero.

Observações

Considera ligar GetState se quiseres recuperar mais do que um estado de botão.

CToolBarCtrl::IsButtonHidden

Determina se o botão especificado num controlo da barra de ferramentas está oculto.

BOOL IsButtonHidden(int nID) const;

Parâmetros

nID
Identificador de comando do botão na barra de ferramentas.

Valor de retorno

Diferente de zero se o botão estiver escondido; caso contrário, zero.

Observações

Considera ligar GetState se quiseres recuperar mais do que um estado de botão.

CToolBarCtrl::IsButtonHighlighted

Verifica o estado de destaque de um botão da barra de ferramentas.

BOOL IsButtonHighlighted(int nID) const;

Parâmetros

nID
[dentro] O ID do comando para o botão da barra de ferramentas.

Valor de retorno

Inteiro positivo se o botão estiver destacado, 0 se o botão não estiver destacado, ou -1 se ocorrer um erro.

CToolBarCtrl::IsButtonIndeterminate

Determina se o botão especificado num controlo da barra de ferramentas é indeterminado.

BOOL IsButtonIndeterminate(int nID) const;

Parâmetros

nID
[dentro] Identificador de comando do botão na barra de ferramentas.

Valor de retorno

Inteiro positivo se o botão for indeterminado, zero se o botão não for indeterminado, ou -1 se ocorrer um erro.

Observações

Botões indeterminados são exibidos em tons escurecidos, tal como o botão a negrito na barra de ferramentas de um processador de texto aparece quando o texto selecionado contém caracteres a negrito e regulares. Considera ligar GetState se quiseres recuperar mais do que um estado de botão.

CToolBarCtrl::IsButtonPressed

Determina se o botão especificado num controlo da barra de ferramentas é pressionado.

BOOL IsButtonPressed(int nID) const;

Parâmetros

nID
Identificador de comando do botão na barra de ferramentas.

Valor de retorno

Não zero se o botão for pressionado, caso contrário zero.

Observações

Considera ligar GetState se quiseres recuperar mais do que um estado de botão.

CToolBarCtrl::LoadImages

Carrega bitmaps na lista de imagens de um controlo da barra de ferramentas.

void LoadImages(
    int iBitmapID,
    HINSTANCE hinst);

Parâmetros

iBitmapID
ID de um bitmap que contém as imagens a serem carregadas. Para especificar o seu próprio recurso bitmap, defina este parâmetro para o ID de um recurso bitmap e defina hInst para NULL. O seu recurso bitmap será adicionado à lista de imagens como uma única imagem. Pode adicionar bitmaps padrão definidos pelo sistema definindo hinst e HINST_COMMCTRL definindo este parâmetro para um dos seguintes IDs:

hinst
Handle de instância de programa para a aplicação que chama. Este parâmetro pode servir HINST_COMMCTRL para carregar uma lista de imagens padrão.

Observações

Esta função membro implementa o comportamento da mensagem TB_LOADIMAGESWin32 , conforme descrito no SDK do Windows.

CToolBarCtrl::MapAccelerator

Mapeia um carácter acelerador para um botão da barra de ferramentas.

BOOL MapAccelerator(
    TCHAR chAccel,
    UINT* pIDBtn);

Parâmetros

chAccel
Personagem aceleradora a mapear. Este carácter é o mesmo que está sublinhado no texto do botão.

pIDBtn
Um apontador para a UINT que recebe o identificador de comando do botão correspondente ao acelerador especificado em chAccel.

Valor de retorno

Não nulo se for bem-sucedido; caso contrário, zero.

Observações

Esta função membro implementa o comportamento da mensagem TB_MAPACCELERATORWin32 , conforme descrito no SDK do Windows.

CToolBarCtrl::MarkButton

Define o estado de destaque de um dado botão num controlo da barra de ferramentas.

BOOL MarkButton(
    int nID,
    BOOL fHighlight = TRUE);

Parâmetros

nID
O identificador do botão.

fHighlight
Especifica o estado de destaque a definir. Por padrão, TRUE. Se definido para FALSE, o botão é definido para o seu estado predefinido.

Valor de retorno

Não nulo se for bem-sucedido; caso contrário, 0.

Observações

Esta função membro implementa o comportamento da mensagem TB_MARKBUTTONWin32 , conforme descrito no SDK do Windows.

CToolBarCtrl::MoveButton

Move um botão de um índice para outro.

BOOL MoveButton(
    UINT nOldPos,
    UINT nNewPos);

Parâmetros

nOldPos
O índice em base zero do botão a mover.

nNewPos
O índice zero do destino do botão.

Valor de retorno

Não nulo se for bem-sucedido; caso contrário, 0.

Observações

Esta função membro implementa o comportamento da mensagem TB_MOVEBUTTONWin32 , conforme descrito no SDK do Windows.

CToolBarCtrl::PressButton

Pressiona ou solta o botão especificado num controlo da barra de ferramentas.

BOOL PressButton(int nID, BOOL bPress = TRUE);

Parâmetros

nID
[dentro] Identificador de comando do botão a pressionar ou largar.

bPress
[dentro] TRUE para pressionar o botão especificado; FALSE para libertar o botão especificado. O valor predefinido é TRUE.

Valor de retorno

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

Observações

Se quiseres mudar o estado de mais do que um botão, considera ligar SetState em vez disso.

Este método envia a TB_PRESSBUTTON mensagem, que é descrita no SDK do Windows.

CToolBarCtrl::ReplaceBitmap

Substitui o bitmap existente no controlo atual da barra de ferramentas por um novo bitmap.

BOOL ReplaceBitmap(LPTBREPLACEBITMAP pReplaceBitmap);

Parâmetros

pReplaceBitmap
[dentro] Apontador para uma TBREPLACEBITMAP estrutura que descreve o bitmap a substituir e o novo bitmap.

Valor de retorno

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

Observações

Este método envia a TB_REPLACEBITMAP mensagem, que é descrita no SDK do Windows.

Example

O seguinte exemplo de código substitui o bitmap da barra de ferramentas padrão por um bitmap diferente.

{
   // Replace one toolbar bitmap with another.
   TBREPLACEBITMAP tbrb;
   tbrb.hInstOld = ::AfxGetInstanceHandle();
   tbrb.nIDOld = IDR_MAINFRAME;
   tbrb.hInstNew = ::AfxGetInstanceHandle();
   tbrb.nIDNew = IDR_MAINFRAME1;
   tbrb.nButtons = 8;
   CToolBarCtrl &m_toolBarCtrl = m_wndToolBar.GetToolBarCtrl();
   BOOL bRet = m_toolBarCtrl.ReplaceBitmap(&tbrb);
}

CToolBarCtrl::RestoreState

Restaura o estado do controlo da barra de ferramentas a partir da localização no registo especificada pelos parâmetros.

void RestoreState(
    HKEY hKeyRoot,
    LPCTSTR lpszSubKey,
    LPCTSTR lpszValueName);

Parâmetros

hKeyRoot
Identifica uma chave atualmente aberta no registo ou qualquer um dos seguintes valores de handle reservados pré-definidos:

• HKEY_CLASSES_ROOT

• HKEY_CURRENT_USER

• HKEY_LOCAL_MACHINE

• HKEY_USERS

lpszSubKey
Aponta para uma NULLcadeia terminada em que contém o nome da subchave à qual um valor está associado. Este parâmetro pode ser NULL ou um apontador para uma cadeia vazia. Se o parâmetro for NULL, o valor será adicionado à chave identificada pelo hKeyRoot parâmetro.

lpszValueName
Aponta para uma cadeia que contém o nome do valor a recuperar. Se um valor com este nome ainda não estiver presente na chave, a função adiciona-o à chave.

CToolBarCtrl::SaveState

Guarda o estado do controlo da barra de ferramentas na localização no registo especificada pelos parâmetros.

void SaveState(
    HKEY hKeyRoot,
    LPCTSTR lpszSubKey,
    LPCTSTR lpszValueName);

Parâmetros

hKeyRoot
Identifica uma chave atualmente aberta no registo ou qualquer um dos seguintes valores de handle reservados pré-definidos:

• HKEY_CLASSES_ROOT

• HKEY_CURRENT_USER

• HKEY_LOCAL_MACHINE

• HKEY_USERS

lpszSubKey
Aponta para uma NULLcadeia terminada em que contém o nome da subchave à qual um valor está associado. Este parâmetro pode ser NULL ou um apontador para uma cadeia vazia. Se o parâmetro for NULL, o valor será adicionado à chave identificada pelo hKeyRoot parâmetro.

lpszValueName
Aponta para uma cadeia que contém o nome do valor a definir. Se um valor com este nome ainda não estiver presente na chave, a função adiciona-o à chave.

CToolBarCtrl::SetAnchorHighlight

Define a definição de destaque âncora para uma barra de ferramentas.

BOOL SetAnchorHighlight(BOOL fAnchor = TRUE);

Parâmetros

fAnchor
[dentro] Especifica se o realce âncora está ativado ou desativado. Se este valor for diferente de zero, o realce âncora será ativado. Se este valor for zero, o realce âncora será desativado

Valor de retorno

O anterior cenário de âncora. Se o destaque estiver ativado, este valor é diferente de zero. Se o realce não estava ativado, este valor é zero.

Observações

Este método implementa o comportamento da mensagem TB_SETANCHORHIGHLIGHTWin32 , conforme descrito no SDK do Windows.

CToolBarCtrl::SetBitmapSize

Define o tamanho das imagens bitmap reais a serem adicionadas a um controlo da barra de ferramentas.

BOOL SetBitmapSize(CSize size);

Parâmetros

size
Largura e altura, em pixels, das imagens bitmap.

Valor de retorno

Não nulo se for bem-sucedido; caso contrário, zero.

Observações

Esta função deve ser chamada apenas antes de adicionar quaisquer bitmaps à barra de ferramentas. Se a aplicação não definir explicitamente o tamanho do bitmap, por defeito é 16 por 15 píxeis.

CToolBarCtrl::SetButtonInfo

Define a informação para um botão existente numa barra de ferramentas.

BOOL SetButtonInfo(
    int nID,
    TBBUTTONINFO* ptbbi);

Parâmetros

nID
O identificador do botão.

ptbbi
Um apontador para uma TBBUTTONINFO estrutura que recebe a informação do botão.

Valor de retorno

Não nulo se for bem-sucedido; caso contrário, 0.

Observações

A função membro implementa o comportamento da mensagem TB_SETBUTTONINFOWin32 , conforme descrito no SDK do Windows.

CToolBarCtrl::SetButtonSize

Define o tamanho dos botões no controlo da barra de ferramentas.

BOOL SetButtonSize(CSize size);

Parâmetros

size
Largura e altura, em pixels, dos botões.

Valor de retorno

Não nulo se for bem-sucedido; caso contrário, zero.

Observações

O tamanho do botão deve ser sempre pelo menos tão grande quanto o tamanho do bitmap que envolve. Esta função deve ser chamada apenas antes de adicionar quaisquer bitmaps à barra de ferramentas. Se a aplicação não definir explicitamente o tamanho do botão, por defeito passa a ser 24 por 22 píxeis.

Example

Veja o exemplo para CToolBar::GetToolBarCtrl.

CToolBarCtrl::SetButtonStructSize

Especifica o tamanho da TBBUTTON estrutura.

void SetButtonStructSize(int nSize);

Parâmetros

nSize
Tamanho, em bytes, da TBBUTTON estrutura.

Observações

Se quisesse armazenar dados extra na TBBUTTON estrutura, poderia derivar uma nova estrutura a partir de TBBUTTON, adicionando os membros necessários, ou criar uma nova estrutura que contenha uma TBBUTTON estrutura como seu primeiro membro. Depois, chamaria esta função para indicar à barra de ferramentas o controlo do tamanho da nova estrutura.

Consulte CToolBarCtrl::AddButtons para mais informações sobre a TBBUTTON estrutura.

CToolBarCtrl::SetButtonWidth

Define as larguras mínima e máxima dos botões no controlo da barra de ferramentas.

BOOL SetButtonWidth(
    int cxMin,
    int cxMax);

Parâmetros

cxMin
Largura mínima do botão, em pixels. Os botões da barra de ferramentas nunca serão mais estreitos do que este valor.

cxMax
Largura máxima dos botões, em pixels. Se o texto dos botões for demasiado largo, o controlo apresenta-o com pontos de elipse.

Valor de retorno

Não nulo se for bem-sucedido; caso contrário, 0.

Observações

Esta função membro implementa o comportamento da mensagem TB_SETBUTTONWIDTHWin32 , conforme descrito no SDK do Windows.

CToolBarCtrl::SetCmdID

Define o identificador de comando que será enviado para a janela proprietária quando o botão especificado for pressionado.

BOOL SetCmdID(
    int nIndex,
    UINT nID);

Parâmetros

nIndex
O índice baseado em zero do botão cujo ID de comando deve ser definido.

nID
O ID do comando para definir o botão selecionado para.

Valor de retorno

Retorna diferente de zero se bem-sucedido; caso contrário, zero.

CToolBarCtrl::SetColorScheme

Define o esquema de cores do controlo atual da barra de ferramentas.

void SetColorScheme(const COLORSCHEME* lpColorScheme);

Parâmetros

lpColorScheme
[dentro] Apontador para uma COLORSCHEME estrutura que descreve a cor de destaque e a cor da sombra do controlo da barra de ferramentas.

Observações

Este método não tem efeito se um tema visual do Windows Vista for definido.

Este método envia a TB_SETCOLORSCHEME mensagem, que é descrita no SDK do Windows.

Example

O seguinte exemplo de código define o esquema de cores para o controlo atual da barra de ferramentas. O exemplo do código faz com que as bordas esquerda e superior de cada botão de ferramenta fiquem vermelhas e as bordas direita e inferior azuis. Quando o utilizador pressiona o botão, as bordas vermelhas do botão tornam-se azuis e as bordas azuis tornam-se vermelhas.

//Set color scheme for the current toolbar control.
//Make the left and top edges of the tool button red,
//and the right and bottom edges blue. The colors
//reverse when a button is pressed.
//This method has no effect if the Vista visual theme
//is set.
{
   COLORSCHEME cs;
   cs.dwSize = sizeof(COLORSCHEME);
   cs.clrBtnHighlight = RGB(255, 0, 0);
   cs.clrBtnShadow = RGB(0, 0, 255);
   CToolBarCtrl &m_toolBarCtrl = m_wndToolBar.GetToolBarCtrl();
   m_toolBarCtrl.SetColorScheme(&cs);
}

CToolBarCtrl::SetDisabledImageList

Define a lista de imagens que o controlo da barra de ferramentas usará para mostrar os botões desativados.

CImageList* SetDisabledImageList(CImageList* pImageList);

Parâmetros

pImageList
Um ponteiro para um CImageList objeto contendo as imagens a serem usadas pelo controlo da barra de ferramentas para exibir imagens de botões desativados.

Valor de retorno

Um apontador para um CImageList objeto que anteriormente era usado pelo controlo da barra de ferramentas para exibir imagens de botões desativados.

Observações

Esta função membro implementa o comportamento da mensagem TB_SETDISABLEDIMAGELISTWin32 , conforme descrito no SDK do Windows. A implementação MFC de SetDisabledImageList utiliza um CImageList objeto contendo as imagens de botões desativadas do controlo da barra de ferramentas, em vez de um handle para uma lista de imagens.

CToolBarCtrl::SetDrawTextFlags

Define as flags na função DrawTextWin32 , que é usada para desenhar o texto no retângulo especificado, formatado de acordo com a forma como as flags estão definidas.

DWORD SetDrawTextFlags(
    DWORD dwMask,
    DWORD dwDTFlags);

Parâmetros

dwMask
Uma combinação de uma ou mais das DT_ flags, especificadas na função DrawTextWin32, que indica quais os bits em dwDTFlags que serão usados ao desenhar o texto.

dwDTFlags
Uma combinação de uma ou mais das DT_ bandeiras, especificadas na função DrawTextWin32, que indicam como o texto do botão será desenhado. Este valor é passado quando DrawText o texto do botão é desenhado.

Valor de retorno

A contendo o texto anterior a DWORD desenhar bandeiras.

Observações

Esta função membro implementa o comportamento da mensagem TB_SETDRAWTEXTFLAGSWin32 , conforme descrito no SDK do Windows. Esta função membro define as flags na função DrawTextWin32 , que desenha texto no retângulo especificado, formatado de acordo com a forma como as flags estão definidas.

CToolBarCtrl::SetExtendedStyle

Define os estilos estendidos para um controlo da barra de ferramentas.

DWORD SetExtendedStyle(DWORD dwExStyle);

Parâmetros

dwExStyle
Um valor que especifica os novos estilos estendidos. Este parâmetro pode ser uma combinação dos estilos estendidos da barra de ferramentas.

Valor de retorno

A DWORD que representa os estilos estendidos anteriores. Para uma lista de estilos, consulte Estilos Estendidos da Barra de Ferramentas, no SDK do Windows.

Observações

Esta função membro implementa o comportamento da mensagem TB_SETEXTENDEDSTYLEWin32 , conforme descrito no SDK do Windows.

CToolBarCtrl::SetHotImageList

Define a lista de imagens que o controlo da barra de ferramentas usará para mostrar os botões "hot".

CImageList* SetHotImageList(CImageList* pImageList);

Parâmetros

pImageList
Um apontador para um CImageList objeto contendo as imagens a serem usadas pelo controlo da barra de ferramentas para exibir imagens de botão de atalho.

Valor de retorno

Um apontador para um CImageList objeto que anteriormente era usado pelo controlo da barra de ferramentas para mostrar imagens de botão de atalho.

Observações

Esta função membro implementa o comportamento da mensagem TB_SETHOTIMAGELISTWin32 , conforme descrito no SDK do Windows.

A implementação MFC de SetHotImageList utiliza um CImageList objeto que contém as imagens do botão quente do controlo da barra de ferramentas, em vez de um handle para uma lista de imagens. Um botão de atalho aparece destacado quando o ponteiro está por cima.

CToolBarCtrl::SetHotItem

Define o item quente numa barra de ferramentas.

int SetHotItem(int nHot);

Parâmetros

nHot
O número de índice baseado em zero do item que será tornado quente. Se este valor for -1, nenhum dos itens estará quente.

Valor de retorno

O índice do item quente anterior, ou -1 se não houver item quente.

Observações

Esta função membro implementa o comportamento da mensagem TB_SETHOTITEMWin32 , conforme descrito no SDK do Windows.

CToolBarCtrl::SetImageList

Define a lista de imagens que a barra de ferramentas usará para mostrar os botões que estão no seu estado predefinido.

CImageList* SetImageList(CImageList* pImageList);

Parâmetros

pImageList
Um apontador para um CImageList objeto contendo as imagens a serem usadas pelo controlo da barra de ferramentas para exibir imagens de botão no seu estado predefinido.

Valor de retorno

Um apontador para um CImageList objeto que anteriormente era usado pelo controlo da barra de ferramentas para mostrar imagens de botões no seu estado padrão.

Observações

Esta função membro implementa o comportamento da mensagem TB_SETIMAGELISTWin32 , conforme descrito no SDK do Windows.

A implementação MFC de SetImageList utiliza um CImageList objeto que contém as imagens dos botões do controlo da barra de ferramentas, em vez de um handle para uma lista de imagens.

CToolBarCtrl::SetIndent

Define a indentação do primeiro botão num controlo da barra de ferramentas.

BOOL SetIndent(int iIndent);

Parâmetros

iIndent
O valor que especifica a indentação, em pixels.

Valor de retorno

Não nulo se for bem-sucedido; caso contrário, zero.

CToolBarCtrl::SetInsertMark

Define a marca de inserção atual para a barra de ferramentas.

void SetInsertMark(TBINSERTMARK* ptbim);

Parâmetros

ptbim
Um ponteiro para a TBINSERTMARK estrutura que contém a marca de inserção.

Observações

Esta função membro implementa o comportamento da mensagem TB_SETINSERTMARKWin32 , conforme descrito no SDK do Windows.

CToolBarCtrl::SetInsertMarkColor

Define a cor usada para desenhar a marca de inserção da barra de ferramentas.

COLORREF SetInsertMarkColor(COLORREF clrNew);

Parâmetros

clrNew
Um valor que contém a nova cor da COLORREF marca de inserção.

Valor de retorno

Um COLORREF valor que contém a cor da marca de inserção anterior.

Observações

Esta função membro implementa o comportamento da mensagem TB_SETINSERTMARKCOLORWin32 , conforme descrito no SDK do Windows.

CToolBarCtrl::SetMaxTextRows

Define o número máximo de linhas de texto exibidas num botão da barra de ferramentas.

BOOL SetMaxTextRows(int iMaxRows);

Parâmetros

iMaxRows
Número máximo de linhas a definir.

Valor de retorno

Não nulo se for bem-sucedido; caso contrário, zero.

CToolBarCtrl::SetMetrics

Define as métricas do CToolBarCtrl objeto.

void SetMetrics(LPTBMETRICS ptbm);

Parâmetros

ptbm
Um apontador para a TBMETRICS estrutura do CToolBarCtrl objeto.

Observações

Esta função membro emula a funcionalidade da TB_SETMETRICS mensagem, conforme descrito no SDK do Windows.

CToolBarCtrl::SetOwner

Define a janela do proprietário para o controlo da barra de ferramentas.

void SetOwner(CWnd* pWnd);

Parâmetros

pWnd
Apontador para o CWnd objeto - CWndderived que será a nova janela de proprietário para o controlo da barra de ferramentas.

Observações

A janela do proprietário é a janela que recebe notificações da barra de ferramentas.

CToolBarCtrl::SetPadding

Define o preenchimento horizontal e vertical do controlo atual da barra de ferramentas.

DWORD SetPadding(
    int nHorzPadding,
    int nVertPadding);

Parâmetros

nHorzPadding
[dentro] Especifica o preenchimento horizontal do controlo da barra de ferramentas, em pixels.

nVertPadding
[dentro] Especifica o preenchimento vertical do controlo da barra de ferramentas, em pixels.

Valor de retorno

A cuja palavra baixa contém o valor de preenchimento horizontal anterior, e cuja DWORD palavra alta contém o valor de preenchimento vertical anterior. Os valores de enchimento são medidos em píxeis.

Observações

Este método envia a TB_SETPADDING mensagem, que é descrita no SDK do Windows.

Example

O exemplo de código seguinte define o preenchimento horizontal e vertical do controlo atual da barra de ferramentas para 20 pixels.

{
   // Set the horizontal and vertical padding of the current
   // toolbar control.
   CToolBarCtrl &m_toolBarCtrl = m_wndToolBar.GetToolBarCtrl();
   m_toolBarCtrl.SetPadding(50, 50);
}

CToolBarCtrl::SetPressedImageList

Define a lista de imagens que o controlo atual da barra de ferramentas usa para representar botões no estado pressionado.

CImagelist* SetPressedImageList(
    int iImageID,
    CImageList* pImageList);

Parâmetros

iImageID
[dentro] O índice base zero da lista de imagens. Defina este parâmetro a zero se usar apenas uma lista de imagens.

pImageList
[dentro] Apontador para um CImageList que contém a nova lista de imagens.

Valor de retorno

Apontador para um CImageList que contém a lista de imagens anterior para o controlo atual, ou NULL se nenhuma lista de imagens desse tipo foi definida.

Observações

Este método envia a TB_SETPRESSEDIMAGELIST mensagem, que é descrita no SDK do Windows.

Example

O exemplo de código seguinte define a lista de imagens pressionadas para ser igual à lista de imagens padrão.

{
   // SetPressedImageList
   // Set the pressed image list to be the same as the
   // normal image list.
   CToolBarCtrl &m_toolBarCtrl = m_wndToolBar.GetToolBarCtrl();
   CImageList *pNormalCil = m_toolBarCtrl.GetImageList();
   CImageList *pPressedCil = m_toolBarCtrl.GetPressedImageList();
   m_toolBarCtrl.SetPressedImageList(0, pNormalCil);
}

CToolBarCtrl::SetRows

Pede ao controlo da barra de ferramentas que se redimensione para o número de linhas solicitado.

void SetRows(
    int nRows,
    BOOL bLarger,
    LPRECT lpRect);

Parâmetros

nRows
Pedido número de linhas.

bLarger
Indica se deve usar mais ou menos linhas se a barra de ferramentas não puder ser redimensionada para o número pedido de linhas.

lpRect
Aponta para o CRect objeto ou RECT estrutura que receberá o novo retângulo delimitador da barra de ferramentas.

Observações

Se a barra de ferramentas não conseguir redimensionar-se para o número ou linhas solicitados, irá redimensionar-se para o próximo tamanho maior ou menor válido, dependendo do valor de bLarger. Se bLarger for TRUE, o novo número de linhas será maior do que o número solicitado. Se bLarger for FALSE, o novo número de linhas será menor do que o número solicitado.

Um dado número de linhas é válido para a barra de ferramentas se os botões puderem ser organizados de modo a que todas as linhas tenham o mesmo número de botões (exceto talvez a última linha). Por exemplo, uma barra de ferramentas com quatro botões não poderia ser dimensionada para três linhas porque as duas últimas teriam de ser mais curtas. Se tentasses dimensionar para três carreiras, obterás quatro carreiras se bLarger fosse TRUE e duas filas se bLarger fosse FALSE.

Se houver separadores na barra de ferramentas, as regras para quando um determinado número de linhas é válido são mais complicadas. A disposição é calculada de modo que os grupos de botões (botões com separador antes do primeiro e último botão do grupo) nunca sejam divididos em várias filas, a menos que o grupo não cabe numa fila.

Se um grupo não caber numa fila, o grupo seguinte começa na fila seguinte, mesmo que caiba na fila onde o grupo grande terminou. O objetivo desta regra é tornar a separação entre grandes grupos mais notória. Os separadores verticais resultantes são contados como filas.

Note também que a SetRows função membro escolherá sempre o layout que resulte no menor tamanho da barra de ferramentas. Criar uma barra de ferramentas com o TBSTYLE_WRAPABLE estilo e depois redimensionar o controlo aplicará simplesmente o método descrito acima dada a largura do controlo.

Esta função só pode ser chamada para barras de ferramentas criadas com esse TBSTYLE_WRAPABLE estilo.

CToolBarCtrl::SetState

Define o estado do botão especificado num controlo da barra de ferramentas.

BOOL SetState(
    int nID,
    UINT nState);

Parâmetros

nID
Identificador de comando do botão.

nState
Bandeiras estaduais. Pode ser uma combinação dos valores listados para os estados dos botões em CToolBarCtrl::AddButtons.

Valor de retorno

Não nulo se for bem-sucedido; caso contrário, zero.

Observações

Esta função é especialmente útil se quiseres definir mais do que um dos estados dos botões. Para definir apenas um estado, use uma das seguintes funções membros: EnableButton, CheckButton, HideButton, Indeterminate, ou PressButton.

CToolBarCtrl::SetStyle

Define os estilos para um controlo na barra de ferramentas.

void SetStyle(DWORD dwStyle);

Parâmetros

dwStyle
A DWORD contendo uma combinação de estilos de controlo da barra de ferramentas, conforme descrito no SDK do Windows.

CToolBarCtrl::SetToolTips

Associa um controlo de dica de ferramenta a um controlo de barra de ferramentas.

void SetToolTips(CToolTipCtrl* pTip);

Parâmetros

pTip
Aponta para o CToolTipCtrl objeto.

CToolBarCtrl::SetWindowTheme

Define o estilo visual do CToolBarCtrl objeto.

HRESULT SetWindowTheme(LPCWSTR pszSubAppName);

Parâmetros

pszSubAppName
Um apontador para uma string Unicode que contém o estilo visual da barra de ferramentas a definir.

Valor de retorno

O valor de devolução não é utilizado.

Observações

Esta função membro emula a funcionalidade da TB_SETWINDOWTHEME mensagem, conforme descrito no SDK do Windows.

Consulte também

Exemplo MFC CMNCTRL1
Exemplo MFC MFCIE
CWnd Classe
Gráfico de Hierarquia
CToolBar Classe