CMFCTasksPane Classe

Para obter mais detalhes, consulte o código-fonte localizado na pasta VC\atlmfc\src\mfc da instalação do Visual Studio.

A CMFCTasksPane classe implementa uma lista de itens clicáveis (tarefas).

Sintaxe

class CMFCTasksPane : public CDockablePane

Membros

Construtores Públicos

Métodos Públicos

Métodos Protegidos

Observações

A CMFCTasksPane classe implementa a seguinte funcionalidade:

• Os itens podem ser agrupados e cada agrupamento de itens pode ter uma legenda associada.

• Os agrupamentos de itens podem ser recolhidos ou expandidos.

• Um ícone pode ser atribuído a cada item no painel de tarefas.

• Itens individuais podem ser associados a um ID de comando que é executado quando um usuário clica no item. Quando o clique ocorre, a mensagem de WM_COMMAND é enviada para o proprietário do controle do painel de tarefas.

Para usar o CMFCTasksPane controle em seu aplicativo, execute estas etapas:

1. Incorpore um CMFCTasksPane objeto na classe da janela do quadro principal.

2. Ao processar a mensagem WM_CREATE, chame o Create método. Você pode usar os estilos regulares do CControlBar . Para obter mais informações, consulte CControlBar::Create.

3. Chame o método CMFCTasksPane::AddGroup para adicionar vários grupos.

4. Chame as funções de membro CMFCTasksPane::AddTask, CMFCTasksPane::AddLabel ou CMFCTasksPane::AddMRUFilesList para adicionar novos itens (tarefas) a cada grupo.

5. Chame CMFCTasksPane::EnableGroupCollapse para especificar se os grupos de itens podem ser recolhidos.

A ilustração a seguir mostra um controle típico do painel de tarefas. O primeiro grupo é um grupo especial e sua legenda é uma cor mais escura. O terceiro grupo está colapsado. O último grupo está alinhado à parte inferior do painel de tarefas e não tem legenda, e a última tarefa no grupo é um rótulo simples:

Você pode personalizar a aparência do painel de tarefas ajustando várias margens e deslocamentos. A ilustração a seguir esclarece o significado dessas variáveis:

Exemplo

O exemplo a seguir demonstra como construir um CMFCTasksPane objeto e usar vários métodos na CMFCTasksPane classe. O exemplo mostra como habilitar o recolhimento de grupos de tarefas, habilitar os menus suspensos nos botões de navegação Avançar e Anterior , habilitar os botões de rolagem em vez de uma barra de rolagem, habilitar a quebra automática de texto para o texto em rótulos, definir o nome da legenda do painel de tarefas, definir a cor do texto para uma legenda de grupo, e definir as margens horizontais e verticais.

CMFCTasksPane *tPane = new CMFCTasksPane();
tPane->EnableGroupCollapse(true);
tPane->EnableHistoryMenuButtons(true);
tPane->EnableScrollButtons(true);
tPane->EnableWrapLabels(true);
tPane->SetCaption(_T("Task Pane"));
tPane->SetGroupTextColor(0, RGB(0, 0, 128));
tPane->SetHorzMargin(15);
tPane->SetVertMargin(15);
tPane->Update();

Hierarquia de herança

CObject
└ CCmdTarget
 └ CWnd
  └ CBasePane
   └ CPane
    └ CDockablePane
     └ CMFCTasksPane

Requerimentos

Cabeçalho: afxTasksPane.h

CMFCTasksPane::AddGroup

Adiciona um novo grupo de tarefas ao controle do painel de tarefas.

int AddGroup(
    int nPageIdx,
    LPCTSTR lpszGroupName,
    BOOL bBottomLocation = FALSE,
    BOOL bSpecial = FALSE,
    HICON hIcon = NULL);

int AddGroup(
    LPCTSTR lpszGroupName,
    BOOL bBottomLocation = FALSE,
    BOOL bSpecial = FALSE,
    HICON hIcon = NULL);

Parâmetros

nPageIdx
[em] Especifica o índice de página baseado em zero.

lpszGroupName
[em] Especifica o nome do grupo.

bBottomLocalização
[em] TRUE para criar o grupo na parte inferior do controle do painel de tarefas; caso contrário, FALSE.

bEspecial
[em] VERDADEIRO para marcar este grupo como um grupo especial ; caso contrário, FALSE. Para obter mais informações sobre grupos especiais, consulte a seção Comentários do CMFCTasksPane.

hIcon
[em] Especifica o ícone a ser exibido na legenda do grupo.

Valor de retorno

O índice baseado em zero do grupo na lista interna de grupos que a classe mantém.

Observações

Chame esse método para criar um grupo de tarefas e adicionar esse grupo ao controle do painel de tarefas.

A estrutura exibe grupos de tarefas na parte superior do controle do painel de tarefas ou na parte inferior. A estrutura pode exibir apenas um grupo na parte inferior; este grupo deve ser adicionado em último lugar.

CMFCTasksPane::AddLabel

Adiciona um rótulo ao grupo de tarefas especificado.

int AddLabel(
    int nGroup,
    LPCTSTR lpszLabelName,
    int nTaskIcon = -1,
    BOOL bIsBold = FALSE);

Parâmetros

nGrupo
[em] Especifica o índice do grupo onde o rótulo é adicionado.

lpszLabelName
[em] Especifica o nome do rótulo.

nTaskIcon
[em] Especifica o ícone a ser exibido ao lado do rótulo. A estrutura armazena ícones em uma lista de imagens. Este parâmetro é um índice nessa lista.

bIsBold
[em] TRUE para exibir o rótulo em negrito; caso contrário, FALSE.

Valor de retorno

O índice baseado em zero do grupo onde o rótulo foi adicionado, ou -1 se o grupo especificado por nGroup não existir.

Observações

A estrutura lida com tarefas e rótulos de forma diferente. Quando um usuário clica em uma tarefa, a estrutura executa um comando. Quando um usuário clica em um rótulo, nenhum comando é executado. Para obter mais informações, consulte CMFCTasksPane::AddTask.

CMFCTasksPane::AddMRUFilesList

Adiciona uma tarefa para cada arquivo armazenado em uma lista de arquivos usados mais recentemente (MRU) em um grupo.

int AddMRUFilesList(
    int nGroup,
    int nMaxFiles = 4);

Parâmetros

nGrupo
[em] Especifica o índice de um grupo. Esse método adiciona a lista de arquivos MRU ao grupo especificado por esse parâmetro.

nMaxArquivos
[em] Especifica o número de arquivos a serem exibidos na lista de arquivos MRU.

Valor de retorno

O índice baseado em zero do grupo onde a lista de arquivos MRU foi adicionada, ou -1 se o grupo especificado por nGroup não existir.

CMFCTasksPane::AddPage

Adiciona uma página ao painel de tarefas.

int AddPage(LPCTSTR lpszPageLabel);

Parâmetros

lpszPageLabel
[em] Especifica o rótulo da página.

Valor de retorno

O índice baseado em zero da nova página.

CMFCTasksPane::AddSeparator

int AddSeparator(int nGroup);

Parâmetros

[em] nGrupo

Valor de retorno

Observações

CMFCTasksPane::AddTask

Adiciona uma tarefa ao grupo de tarefas especificado.

int AddTask(
    int nGroup,
    LPCTSTR lpszTaskName,
    int nTaskIcon = -1,
    UINT uiCommandID = 0,
    DWORD dwUserData = 0);

Parâmetros

nGrupo
[em] Especifica o índice de grupo onde a tarefa é adicionada.

lpszTaskName
[em] Especifica o nome da tarefa.

nTaskIcon
[em] Especifica o ícone a ser exibido ao lado da tarefa. A estrutura armazena ícones em uma lista de imagens. Este parâmetro é um índice nessa lista.

uiCommandID
[em] Especifica a ID do comando a ser executado quando o usuário clica na tarefa. A tarefa será tratada como um rótulo se uiCommandID for 0.

dwUserData
[em] Especifica os dados definidos pelo usuário a serem associados à tarefa.

Valor de retorno

O índice baseado em zero do grupo onde a tarefa foi adicionada, ou -1 se o grupo especificado por nGroup não existir.

CMFCTasksPane::AddWindow

Adiciona uma janela filho ao painel de tarefas.

int AddWindow(
    int nGroup,
    HWND hwndTask,
    int nWndHeight,
    BOOL bAutoDestroyWindow = FALSE,
    DWORD dwUserData = 0);

Parâmetros

nGrupo
[em] Especifica o índice de grupo onde a janela é adicionada.

hwndTarefa
[em] Especifica o identificador da janela a ser adicionada.

nWndAltura
[em] Especifica a altura da janela.

bAutoDestroyWindow
[em] TRUE para destruir a janela quando a tarefa é removida; caso contrário, FALSE.

dwUserData
[em] Especifica os dados definidos pelo usuário associados à tarefa.

Valor de retorno

O índice baseado em zero do grupo onde a janela foi adicionada, ou -1 se o grupo especificado por nGroup não existir.

Observações

Chame esse método para adicionar um controle a um painel de tarefas. Por exemplo, você pode adicionar um controle de edição que funciona como uma barra de pesquisa.

CMFCTasksPane::CMFCTasksPane

Constrói um objeto CMFCTasksPane .

CMFCTasksPane();

CMFCTasksPane::CollapseAllGroups

void CollapseAllGroups(BOOL bCollapse = TRUE);

void CollapseAllGroups(
    int nPageIdx,
    BOOL bCollapse);

Parâmetros

[em] bFechar
[em] nPageIdx

Observações

CMFCTasksPane::CollapseGroup

Recolhe ou expande um grupo.

BOOL CollapseGroup(
    CMFCTasksPaneTaskGroup* pGroup,
    BOOL bCollapse = TRUE);

BOOL CollapseGroup(
    int nGroup,
    BOOL bCollapse = TRUE);

Parâmetros

pGrupo
[em] Especifica o grupo a ser recolhido.

bFechar
[em] VERDADEIRO para colapsar o grupo; FALSO para expandir o grupo.

nGrupo
[em] Especifica o índice baseado em zero do grupo a ser recolhido na lista interna de grupos.

Valor de retorno

TRUE se o grupo colapsar ou se expandir com êxito; caso contrário, FALSE.

Observações

Um grupo recolhido mostra apenas a legenda do grupo; A lista de tarefas está oculta.

CMFCTasksPane::CreateDefaultMiniframe

virtual CPaneFrameWnd* CreateDefaultMiniframe(CRect rectInitial);

Parâmetros

[em] rectInitial

Valor de retorno

Observações

CMFCTasksPane::CreateMenu

Cria um menu que aparece quando um usuário clica no botão de menu Outros Painéis de Tarefas .

HMENU CreateMenu() const;

Valor de retorno

Uma alça para o novo menu.

Observações

Substitua esse método em uma classe derivada para personalizar o menu de um painel de tarefas.

O menu pop-up que esse método cria contém a lista de páginas no painel de tarefas. O menu exibe uma marca de seleção ao lado da página ativa.

CMFCTasksPane::EnableAnimation

Habilita ou desabilita a animação que ocorre quando um grupo de tarefas se expande ou recolhe.

void EnableAnimation(BOOL bEnable = TRUE);

Parâmetros

bAtivar
[em] TRUE para ativar a animação que ocorre quando um grupo de tarefas se expande ou recolhe; caso contrário, FALSE.

Observações

Por padrão, a animação que ocorre quando um grupo de tarefas se expande ou recolhe está habilitada.

CMFCTasksPane::EnableGroupCollapse

Especifica se um usuário pode recolher grupos de tarefas.

void EnableGroupCollapse(BOOL bEnable);

Parâmetros

bAtivar
[em] TRUE se os usuários podem recolher grupos de tarefas; caso contrário, FALSE.

Observações

Um grupo de tarefas recolhido exibe apenas a legenda do grupo; A lista de tarefas está oculta.

CMFCTasksPane::EnableHistoryMenuButtons

Permite menus suspensos nos botões de navegação Seguinte e Anterior .

void EnableHistoryMenuButtons(BOOL bEnable = TRUE);

Parâmetros

bAtivar
[em] TRUE para ativar os menus pendentes nos botões de navegação Seguinte e Anterior ; caso contrário, FALSE.

Observações

Por padrão, os menus suspensos nos botões Avançar e Anterior estão desativados.

Os menus contêm o histórico de páginas de tarefas que o usuário usou.

CMFCTasksPane::EnableNavigationToolbar

Ativa ou desativa a barra de ferramentas de navegação.

void EnableNavigationToolbar(
    BOOL bEnable = TRUE,
    UINT uiToolbarBmpRes = 0,
    CSize sizeToolbarImage = CSize(0,
    0),
    CSize sizeToolbarButton = CSize(0,
    0));

Parâmetros

bAtivar
[em] TRUE para ativar a barra de ferramentas de navegação; caso contrário, FALSE.

uiToolbarBmpRes
[em] Especifica a ID do recurso do bitmap que contém as imagens a serem exibidas na barra de ferramentas.

sizeToolbarImage
[em] Especifica o tamanho de uma imagem da barra de ferramentas.

sizeToolbarButton
[em] Especifica o tamanho de um botão da barra de ferramentas.

Observações

A barra de ferramentas de navegação é uma barra de ferramentas que a estrutura exibe na parte superior do painel de tarefas. A barra de ferramentas de navegação contém os botões de navegação Voltar, Avançar e Página Inicial e um botão de menu que contém a lista de páginas disponíveis.

Por padrão, a estrutura não exibe a barra de ferramentas de navegação. Se a barra de ferramentas de navegação não for exibida, os botões de navegação estarão localizados na legenda da barra de ancoragem.

CMFCTasksPane::EnableOffsetCustomControls

void EnableOffsetCustomControls(BOOL bEnable);

Parâmetros

[em] bAtivar

Observações

CMFCTasksPane::EnableScrollButtons

Permite botões de rolagem em vez de uma barra de rolagem.

void EnableScrollButtons(BOOL bEnable = TRUE);

Parâmetros

bAtivar
[em] TRUE para exibir botões de rolagem no painel de tarefas em vez de uma barra de rolagem; caso contrário, FALSE.

Observações

Por padrão, a estrutura exibe botões de rolagem no painel de tarefas.

CMFCTasksPane::EnableWrapLabels

Habilita ou desabilita a quebra automática de texto para o texto em rótulos.

void EnableWrapLabels(BOOL bEnable = TRUE);

Parâmetros

bAtivar
[em] TRUE para quebrar o texto em rótulos que aparecem no painel de tarefas; caso contrário, FALSE.

Observações

Por padrão, a estrutura não quebra o texto em rótulos. Quando a quebra automática de texto está ativada, o texto nos rótulos pode aparecer em várias linhas. O rótulo pode incluir marcadores de quebra de linha, como \n e o marcador de sublinhado &.

CMFCTasksPane::EnableWrapTasks

Habilita ou desabilita a quebra automática de texto para o texto em tarefas.

void EnableWrapTasks(BOOL bEnable = TRUE);

Parâmetros

bAtivar
[em] TRUE para encapsular tarefas no painel de tarefas; caso contrário, FALSE.

Observações

Por padrão, a quebra automática de texto para tarefas está desabilitada.

CMFCTasksPane::GetActivePage

Retorna o índice baseado em zero para a página ativa.

int GetActivePage() const;

Valor de retorno

O índice baseado em zero da página ativa.

CMFCTasksPane::GetGroupCaptionHeight

Devolve a altura da legenda do grupo.

int GetGroupCaptionHeight() const;

Valor de retorno

A altura da legenda do grupo, em pixels.

CMFCTasksPane::GetGroupCaptionHorzOffset

Retorna o deslocamento horizontal de uma legenda de grupo.

int GetGroupCaptionHorzOffset() const;

Valor de retorno

O deslocamento horizontal de uma legenda de grupo. O deslocamento horizontal é a distância em pixels da borda esquerda ou direita do painel de tarefas.

CMFCTasksPane::GetGroupCaptionVertOffset

Retorna o deslocamento vertical de uma legenda de grupo.

int GetGroupCaptionVertOffset() const;

Valor de retorno

O deslocamento vertical de uma legenda de grupo das bordas superior e inferior do painel de tarefas.

Observações

O valor padrão para o deslocamento vertical é 7 pixels.

CMFCTasksPane::GetGroupCount

Devolve o número total de grupos.

int GetGroupCount() const;

Valor de retorno

O número total de grupos no painel de tarefas.

CMFCTasksPane::GetGroupLocation

Retorna o índice de grupo interno para o grupo especificado.

BOOL GetGroupLocation(
    CMFCTasksPaneTaskGroup* pGroup,
    int& nGroup) const;

Parâmetros

pGrupo
[em] Especifica o grupo de tarefas cujo local é recuperado.

nGrupo
[saídas] Contém o índice baseado em zero do grupo de tarefas.

Valor de retorno

TRUE se o grupo de tarefas foi encontrado; caso contrário, FALSE.

CMFCTasksPane::GetGroupVertOffset

Devolve o deslocamento vertical de um grupo.

int GetGroupVertOffset() const;

Valor de retorno

O deslocamento vertical de um grupo, em pixels.

CMFCTasksPane::GetHorzMargin

Retorna o espaçamento horizontal entre um painel de tarefas e a borda da área do cliente.

int GetHorzMargin() const;

Valor de retorno

O espaçamento horizontal entre um painel de tarefas e a borda da área do cliente.

Observações

O espaçamento padrão entre um painel de tarefas e a borda da área do cliente é de 12 pixels.

CMFCTasksPane::GetNextPages

void GetNextPages(CStringList& lstNextPages) const;

Parâmetros

[em] lstNextPages

Observações

CMFCTasksPane::GetPageByGroup

Recupera o índice de página de um grupo especificado.

BOOL GetPageByGroup(
    int nGroup,
    int& nPage) const;

Parâmetros

nGrupo
[em] Especifica o índice baseado em zero do grupo de tarefas.

nPágina
[saídas] Contém o índice de página para o grupo especificado. Se o grupo de tarefas contiver apenas uma página padrão, o valor retornado será 0.

Valor de retorno

TRUE se o grupo nGroup existir; caso contrário, FALSE.

CMFCTasksPane::GetPagesCount

Devolve o número de páginas.

int GetPagesCount() const;

Valor de retorno

O número de páginas no painel de tarefas.

CMFCTasksPane::GetPreviousPages

void GetPreviousPages(CStringList& lstPrevPages) const;

Parâmetros

[em] lstPrevPages

Observações

CMFCTasksPane::GetScrollBarCtrl

virtual CScrollBar* GetScrollBarCtrl(int nBar) const;

Parâmetros

[em] nBar

Valor de retorno

Observações

CMFCTasksPane::GetTask

Recupera uma tarefa.

CMFCTasksPaneTask* GetTask(
    int nGroup,
    int nTask) const;

Parâmetros

nGrupo
[em] Especifica o índice baseado em zero do grupo que contém a tarefa.

nTarefa
[em] Especifica o índice baseado em zero da tarefa na lista especificada por nGroup.

Valor de retorno

A tarefa no índice especificado.

CMFCTasksPane::GetTaskCount

Retorna o número de tarefas em um grupo especificado.

int GetTaskCount(int nGroup) const;

Parâmetros

nGrupo
[em] Especifica o índice do grupo de tarefas.

Valor de retorno

O número de tarefas no grupo especificado ou 0 se nGroup for inválido.

CMFCTasksPane::GetTaskGroup

Retorna um grupo de tarefas para um índice de grupo especificado.

CMFCTasksPaneTaskGroup* GetTaskGroup(int nGroup) const;

Parâmetros

nGrupo
[em] Especifica o índice baseado em zero do grupo a ser recuperado.

Valor de retorno

O grupo de tarefas no índice especificado.

CMFCTasksPane::GetTaskLocation

Retorna o grupo e o índice de uma tarefa especificada.

BOOL GetTaskLocation(
    UINT uiCommandID,
    int& nGroup,
    int& nTask) const;

BOOL GetTaskLocation(
    HWND hwndTask,
    int& nGroup,
    int& nTask) const;

BOOL GetTaskLocation(
    CMFCTasksPaneTask* pTask,
    int& nGroup,
    int& nTask) const;

Parâmetros

uiCommandID
[em] Especifica a ID do comando da tarefa a ser localizada.

nGrupo
[saídas] Contém o índice de grupo da tarefa.

nTarefa
[saídas] Contém o índice da tarefa no grupo de tarefas.

hwndTarefa
[em] Especifica a janela associada à tarefa.

pTarefa
[em] Especifica a tarefa a ser localizada.

Valor de retorno

TRUE se o local da tarefa foi encontrado; FALSO se a tarefa especificada não existir.

Observações

Esse método recupera o índice de grupo e o índice de tarefas para a tarefa especificada. Se o método retornar FALSE, nGroup e nTask serão definidos como -1.

CMFCTasksPane::GetTasksHorzOffset

Retorna o deslocamento horizontal das tarefas.

int GetTasksHorzOffset() const;

Valor de retorno

O deslocamento horizontal de tarefas das bordas esquerda e direita de seus grupos pai.

Observações

O deslocamento horizontal padrão das tarefas é de 12 pixels.

CMFCTasksPane::GetTasksIconHorzOffset

int GetTasksIconHorzOffset() const;

Valor de retorno

Observações

CMFCTasksPane::GetTasksIconVertOffset

int GetTasksIconVertOffset() const;

Valor de retorno

Observações

CMFCTasksPane::GetVertMargin

Retorna a margem vertical entre um painel de tarefas e as bordas da área do cliente.

int GetVertMargin() const;

Valor de retorno

A margem vertical entre um painel de tarefas e as bordas da área do cliente.

Observações

A margem vertical é o espaço entre um painel de tarefas e as bordas da área do cliente. O valor padrão da margem vertical é 12 pixels.

CMFCTasksPane::IsAccessibilityCompatible

virtual BOOL IsAccessibilityCompatible();

Valor de retorno

Observações

CMFCTasksPane::IsAnimationEnabled

Indica se a animação está habilitada.

BOOL IsAnimationEnabled() const;

Valor de retorno

TRUE se a animação que ocorre quando um usuário expande ou recolhe um grupo estiver habilitada; caso contrário, FALSE.

Observações

Chame CMFCTasksPane::EnableAnimation para habilitar ou desabilitar a animação.

CMFCTasksPane::IsBackButtonEnabled

Indica se o botão Voltar está ativado.

BOOL IsBackButtonEnabled() const;

Valor de retorno

TRUE se o botão Voltar estiver ativado; caso contrário, FALSE.

Observações

Quando um usuário clica no botão Voltar, a estrutura exibe a página de tarefa anterior.

CMFCTasksPane::IsForwardButtonEnabled

Indica se o botão de avançar está habilitado.

BOOL IsForwardButtonEnabled() const;

Valor de retorno

TRUE se o botão de avançar estiver ativado; caso contrário, FALSE.

Observações

O botão de avançar permite a navegação direta no histórico de páginas de tarefas.

CMFCTasksPane::IsGroupCollapseEnabled

BOOL IsGroupCollapseEnabled() const;

Valor de retorno

Observações

CMFCTasksPane::IsHistoryMenuButtonsEnabled

Indica se os botões de navegação Seguinte e Anterior têm menus pendentes.

BOOL IsHistoryMenuButtonsEnabled() const;

Valor de retorno

TRUE se os botões de navegação Seguinte e Anterior tiverem menus pendentes; caso contrário, FALSE.

CMFCTasksPane::IsNavigationToolbarEnabled

Indica se a barra de ferramentas de navegação está ativada.

BOOL IsNavigationToolbarEnabled() const;

Valor de retorno

TRUE se a barra de ferramentas de navegação estiver ativada; caso contrário, FALSE.

CMFCTasksPane::IsToolBox

virtual BOOL IsToolBox() const;

Valor de retorno

Observações

CMFCTasksPane::IsWrapLabelsEnabled

Indica se o painel de tarefas quebra palavras em rótulos.

BOOL IsWrapLabelsEnabled() const;

Valor de retorno

VERDADEIRO se as palavras nos rótulos estiverem embrulhadas; caso contrário, FALSE.

CMFCTasksPane::IsWrapTasksEnabled

Especifica se a estrutura encapsula a cadeia de caracteres da tarefa.

BOOL IsWrapTasksEnabled() const;

Valor de retorno

TRUE se a cadeia de caracteres da tarefa estiver encapsulada; caso contrário, FALSE.

CMFCTasksPane::LoadState

virtual BOOL LoadState(
    LPCTSTR lpszProfileName = NULL,
    int nIndex = -1,
    UINT uiID = (UINT) -1);

Parâmetros

[em] lpszProfileName
[em] nÍndice
[em] uiID

Valor de retorno

Observações

CMFCTasksPane::OnActivateTasksPanePage

Chamado pela estrutura quando torna ativa uma página do painel de tarefas.

virtual void OnActivateTasksPanePage();

Observações

Substitua esse método em uma classe derivada para personalizar a aparência da página do painel de tarefas.

CMFCTasksPane::OnCancel

virtual void OnCancel();

Observações

CMFCTasksPane::OnClickTask

Chamado pela estrutura quando o usuário clica em um item no painel de tarefas.

virtual void OnClickTask(
    int nGroupNumber,
    int nTaskNumber,
    UINT uiCommandID,
    DWORD dwUserData);

Parâmetros

nGroupNumber
[em] Especifica o índice baseado em zero do grupo que contém a tarefa clicada.

nNúmero da tarefa
[em] Especifica o índice baseado em zero da tarefa clicada.

uiCommandID
[em] Especifica o ID do comando associado à tarefa.

dwUserData
[em] Contém dados definidos pelo usuário associados à tarefa clicada.

Observações

A estrutura chama esse método quando um usuário clica em uma tarefa. Por padrão, a estrutura verifica o ID de comando associado à tarefa clicada e, se não for zero, envia a mensagem WM_COMMAND para o proprietário do controle do painel de tarefas.

Substitua esse método em uma classe derivada para executar código personalizado quando uma tarefa é clicada.

CMFCTasksPane::OnOK

virtual void OnOK();

Observações

CMFCTasksPane::OnPressBackButton

Chamado pela estrutura quando o usuário clica no botão Voltar.

virtual void OnPressBackButton();

Observações

Por padrão, a estrutura exibe a página visualizada anteriormente.

Substitua esse método em uma classe derivada para executar código personalizado quando o usuário clica no botão Voltar.

CMFCTasksPane::OnPressForwardButton

Chamado pela estrutura quando o usuário clica no botão de navegação para frente.

virtual void OnPressForwardButton();

Observações

Por padrão, a estrutura exibe a página que o usuário visualizou antes de clicar no botão Voltar .

Substitua esse método em uma classe derivada para executar código personalizado quando o usuário clica no botão Avançar.

CMFCTasksPane::OnPressHomeButton

Chamado pela estrutura quando o usuário clica no botão de navegação inicial.

virtual void OnPressHomeButton();

Observações

Por padrão, a estrutura exibe a página padrão para o grupo de tarefas.

Substitua esse método em uma classe derivada para executar código personalizado quando o usuário clica no botão de navegação inicial.

CMFCTasksPane::OnPressOtherButton

virtual void OnPressOtherButton(
    CMFCCaptionMenuButton* pbtn,
    CWnd* pWndOwner);

Parâmetros

[em] PBTN
[em] pWndProprietário

Observações

CMFCTasksPane::OnSetAccData

virtual BOOL OnSetAccData(long lVal);

Parâmetros

[em] lVal

Valor de retorno

Observações

CMFCTasksPane::OnUpdateCmdUI

virtual void OnUpdateCmdUI(
    CFrameWnd* pTarget,
    BOOL bDisableIfNoHndler);

Parâmetros

[em] pAlvo
[em] bDisableIfNoHndler

Observações

CMFCTasksPane::P reTranslateMessage

virtual BOOL PreTranslateMessage(MSG* pMsg);

Parâmetros

[em] pMsg

Valor de retorno

Observações

CMFCTasksPane::RecalcLayout

void RecalcLayout(BOOL bRedraw = TRUE);

Parâmetros

[em] bRedesenhar

Observações

CMFCTasksPane::RemoveAllGroups

Remove todos os grupos na página especificada.

void RemoveAllGroups(int nPageIdx = 0);

Parâmetros

nPageIdx
[em] Especifica o índice baseado em zero da página.

Observações

Remove todos os grupos na página especificada por nPageIdx ou todos os grupos se houver apenas uma página padrão.

CMFCTasksPane::RemoveAllPages

Remove todas as páginas do painel de tarefas, exceto a página padrão (primeira).

void RemoveAllPages();

CMFCTasksPane::RemoveAllTasks

Remove todas as tarefas do grupo especificado.

void RemoveAllTasks(int nGroup);

Parâmetros

nGrupo
[em] Especifica o índice baseado em zero do grupo.

CMFCTasksPane::RemoveGroup

Remove um grupo.

void RemoveGroup(int nGroup);

Parâmetros

nGrupo
[em] Especifica o índice baseado em zero do grupo a ser removido.

Observações

Este método remove um único grupo. Para remover todos os grupos, chame CMFCTasksPane::RemoveAllGroups .

Quando a estrutura remove um grupo, todas as tarefas e janelas de usuário associadas a ela são destruídas.

CMFCTasksPane::RemovePage

Remove uma página especificada do painel de tarefas.

void RemovePage(int nPageIdx);

Parâmetros

nPageIdx
[em] Especifica o índice baseado em zero da página a ser removida.

CMFCTasksPane::RemoveTask

Remove uma tarefa de um grupo de tarefas.

BOOL RemoveTask(
    int nGroup,
    int nTask,
    BOOL bRedraw = TRUE);

Parâmetros

nGrupo
[em] Especifica o índice baseado em zero do grupo de tarefas que contém a tarefa a ser removida.

nTarefa
[em] Especifica o índice baseado em zero da tarefa a ser removida.

bRedesenhar
[em] TRUE para redesenhar o painel de tarefas; caso contrário, FALSE.

Valor de retorno

TRUE se a função for bem-sucedida; FALSE se nGroup ou nTask for inválido.

CMFCTasksPane::SaveState

virtual BOOL SaveState(
    LPCTSTR lpszProfileName = NULL,
    int nIndex = -1,
    UINT uiID = (UINT) -1);

Parâmetros

[em] lpszProfileName
[em] nÍndice
[em] uiID

Valor de retorno

Observações

CMFCTasksPane::Serialize

virtual void Serialize(CArchive& ar);

Parâmetros

[em] RA

Observações

CMFCTasksPane::SetActivePage

Torna ativa a página especificada no painel de tarefas.

void SetActivePage(int nPageIdx);

Parâmetros

nPageIdx
[em] Especifica o índice baseado em zero da página a ser exibida.

Observações

Este método afirma se o nPageIdx é inválido.

CMFCTasksPane::SetCaption

Define o nome da legenda de um painel de tarefas.

void SetCaption(LPCTSTR lpszName);

Parâmetros

lpszName
[em] Especifica o nome da legenda.

Observações

Se um painel de tarefas tiver várias páginas, a página padrão terá a legenda que foi definida usando essa função.

CMFCTasksPane::SetGroupCaptionHeight

Define a altura de uma legenda de grupo.

void SetGroupCaptionHeight(int n = -1);

Parâmetros

n
[em] Especifica a altura da legenda.

Observações

Chame esse método para personalizar as margens dos elementos do painel de tarefas.

Se n for -1, a estrutura determina o valor da margem usando o gerenciador visual (CMFCVisualManager::GetTasksPaneGroupCaptionHeight). A altura padrão da legenda é de 25 pixels.

CMFCTasksPane::SetGroupCaptionHorzOffset

Define o deslocamento horizontal de uma legenda de grupo.

void SetGroupCaptionHorzOffset(int n = -1);

Parâmetros

n
[em] Especifica o deslocamento horizontal da legenda do grupo.

CMFCTasksPane::SetGroupCaptionVertOffset

Define o deslocamento vertical de uma legenda de grupo.

void SetGroupCaptionVertOffset(int n = -1);

Parâmetros

n
[em] Especifica o deslocamento vertical, em pixels, da legenda do grupo.

CMFCTasksPane::SetGroupName

Define um nome de grupo.

BOOL SetGroupName(
    int nGroup,
    LPCTSTR lpszGroupName);

Parâmetros

nGrupo
[em] Especifica o índice baseado em zero do grupo.

lpszGroupName
[em] Especifica o nome do grupo.

Valor de retorno

TRUE se o nome do grupo foi definido com êxito; caso contrário, FALSE.

CMFCTasksPane::SetGroupTextColor

Define a cor do texto para uma legenda de grupo.

BOOL SetGroupTextColor(
    int nGroup,
    COLORREF color,
    COLORREF colorHot = (COLORREF)-1);

Parâmetros

nGrupo
[em] Especifica o índice baseado em zero do grupo.

cor
[em] Especifica a cor do texto.

corHot
[em] Especifica a cor do texto para o grupo realçado. Se -1, a cor de realce padrão é usada.

Valor de retorno

TRUE se a cor do texto do grupo foi alterada com êxito; caso contrário, FALSE.

CMFCTasksPane::SetGroupVertOffset

Define o deslocamento vertical para um grupo.

void SetGroupVertOffset(int n = -1);

Parâmetros

n
[em] Especifica o deslocamento vertical.

Observações

O deslocamento vertical é a distância entre um grupo de tarefas e a borda do painel de tarefas.

Chame esse método para personalizar as margens dos elementos do painel de tarefas. Se n for -1, a estrutura determina o valor da margem usando o gerenciador visual (CMFCVisualManager::GetTasksPaneGroupVertOffset). O deslocamento padrão é de 15 pixels.

CMFCTasksPane::SetHorzMargin

Define a margem horizontal.

void SetHorzMargin(int n = -1);

Parâmetros

n
[em] Especifica a margem, em pixels.

Observações

A margem horizontal é a distância entre um painel de tarefas e a borda superior ou inferior da área do cliente.

Se n for -1, e a estrutura determinar o valor da margem usando o gerenciador visual (CMFCVisualManager::GetTasksPaneHorzMargin). A margem horizontal padrão é de 12 pixels.

CMFCTasksPane::SetIconsList

Define a lista de imagens.

BOOL SetIconsList(
    UINT uiImageListResID,
    int cx,
    COLORREF clrTransparent = RGB(255, 0, 255));

void SetIconsList(HIMAGELIST hIcons);

Parâmetros

uiImageListResID
[em] Especifica o ID do recurso da lista de imagens.

CX
[em] Especifica o tamanho dos ícones na lista de imagens.

clrTransparente
[em] Especifica a cor transparente.

hÍcones
[em] Especifica a lista de imagens que contém os ícones para o painel de tarefas.

Observações

A estrutura armazena ícones em uma lista de imagens. As tarefas são associadas a ícones armazenados nessa lista.

Esse método associa uma lista de imagens ao controle do painel de tarefas. Para definir o ícone de uma tarefa quando você chama CMFCTasksPane::AddTask, defina nTaskIcon como o índice baseado em zero apropriado nesta lista de imagens.

CMFCTasksPane::SetPageCaption

Define o texto da legenda para uma página do painel de tarefas.

void SetPageCaption(
    int nPageIdx,
    LPCTSTR lpszName);

Parâmetros

nPageIdx
[em] Especifica o índice baseado em zero da página.

lpszName
[em] Especifica o texto da legenda a ser exibido na página.

Observações

Se um painel de tarefas tiver várias páginas, a página padrão terá a legenda que foi definida usando esse método.

CMFCTasksPane::SetTaskName

Define o nome de uma tarefa.

BOOL SetTaskName(
    int nGroup,
    int nTask,
    LPCTSTR lpszTaskName);

Parâmetros

nGrupo
[em] Especifica o índice baseado em zero do grupo de tarefas.

nTarefa
[em] Especifica o índice baseado em zero da tarefa.

lpszTaskName
[em] Especifica o nome da tarefa.

Valor de retorno

TRUE se o nome da tarefa foi definido com êxito; caso contrário, FALSE.

CMFCTasksPane::SetTasksHorzOffset

Define o deslocamento horizontal para tarefas.

void SetTasksHorzOffset(int n = -1);

Parâmetros

n
[em] Especifica o deslocamento horizontal.

Observações

O deslocamento horizontal é a distância em pixels das bordas esquerda e direita de um grupo.

Se n for -1, esse método define o deslocamento horizontal para o valor retornado pelo CMFCVisualManager::GetTasksPaneTaskHorzOffset método.

O deslocamento horizontal padrão é de 12 pixels.

CMFCTasksPane::SetTasksIconHorzOffset

void SetTasksIconHorzOffset(int n = -1);

Parâmetros

[em] n

Observações

CMFCTasksPane::SetTasksIconVertOffset

void SetTasksIconVertOffset(int n = -1);

Parâmetros

[em] n

Observações

CMFCTasksPane::SetTaskTextColor

Define a cor do texto para uma tarefa.

BOOL SetTaskTextColor(
    int nGroup,
    int nTask,
    COLORREF color,
    COLORREF colorHot = (COLORREF)-1);

Parâmetros

nGrupo
[em] Especifica o índice baseado em zero do grupo de tarefas que contém a tarefa.

nTarefa
[em] Especifica o índice baseado em zero da tarefa.

cor
[em] Especifica a cor do texto para a tarefa.

corHot
[em] Especifica a cor do texto para o grupo realçado. Se -1, esse método usa a cor de realce padrão.

Valor de retorno

TRUE se a cor do texto para a tarefa foi definida com êxito; caso contrário, FALSE.

CMFCTasksPane::SetVertMargin

Define a margem vertical.

void SetVertMargin(int n = -1);

Parâmetros

n
[em] Especifica a margem vertical a ser definida.

Observações

A margem vertical é a distância entre um painel de tarefas e as bordas verticais da área do cliente.

Se n for -1, a estrutura determina o valor da margem usando o gerenciador visual (CMFCVisualManager::GetTasksPaneVertMargin). A margem padrão é de 12 pixels.

CMFCTasksPane::SetWindowHeight

Define a altura de um controle de janela.

BOOL SetWindowHeight(
    int nGroup,
    HWND hwndTask,
    int nWndHeight);

BOOL SetWindowHeight(
    HWND hwndTask,
    int nWndHeight);

Parâmetros

nGrupo
[em] Especifica o índice baseado em zero do grupo que contém o controle de janela.

hwndTarefa
[em] Especifica o identificador para o controle de janela.

nWndAltura
[em] Especifica a altura a ser definida.

Valor de retorno

TRUE se a altura do controle da janela foi definida com sucesso; FALSE se nGroup for inválido ou se hwndTask não existir.

Observações

Chame CMFCTasksPane::AddWindow para adicionar tarefas com controles de janela.

CMFCTasksPane::ShowCommandMessageString

virtual void ShowCommandMessageString(UINT uiCmdId);

Parâmetros

[em] uiCmdId

Observações

CMFCTasksPane::ShowTask

Mostra ou oculta uma tarefa.

BOOL ShowTask(
    int nGroup,
    int nTask,
    BOOL bShow = TRUE,
    BOOL bRedraw = TRUE);

Parâmetros

nGrupo
[em] Especifica o índice baseado em zero do grupo.

nTarefa
[em] Especifica o índice baseado em zero da tarefa a ser exibida ou ocultada.

bMostrar
[em] VERDADEIRO para mostrar a tarefa; FALSO para ocultar a tarefa.

bRedesenhar
[em] TRUE para redesenhar o painel de tarefas; caso contrário, FALSE.

Valor de retorno

TRUE se a tarefa foi mostrada ou ocultada com êxito; FALSO se o grupo ou tarefa especificado não existir.

Observações

Use CMFCTasksPane::ShowTaskByCmdId para mostrar ou ocultar uma tarefa com base em sua ID de comando.

CMFCTasksPane::ShowTaskByCmdId

Mostra ou oculta uma tarefa com base em sua ID de comando.

BOOL ShowTaskByCmdId(
    UINT uiCommandID,
    BOOL bShow = TRUE,
    BOOL bRedraw = TRUE);

Parâmetros

uiCommandID
[em] Especifica o ID do comando da tarefa a ser exibida ou ocultada.

bMostrar
[em] VERDADEIRO para mostrar a tarefa; FALSO para ocultar a tarefa.

bRedesenhar
[em] TRUE para redesenhar o painel de tarefas; caso contrário, FALSE.

Valor de retorno

TRUE se a tarefa foi mostrada ou ocultada com êxito; FALSE se uma tarefa com o ID de comando especificado não existir.

Observações

Use CMFCTasksPane::ShowTask para mostrar ou ocultar uma tarefa com base em sua ID de comando.

CMFCTasksPane::Atualização

Atualiza todos os controles em um painel de tarefas.

virtual void Update();

Observações

Esse método atualiza a legenda do painel de tarefas, ajusta a barra de rolagem, reposiciona todas as tarefas e redesenha todos os controles do painel de tarefas.

Substitua esse método em uma classe derivada para executar código personalizado quando a estrutura atualiza o painel de tarefas.

Ver também

Gráfico de Hierarquia
Aulas
CMFCTasksPaneTaskGroup Classe
CMFCTasksPaneTask Classe
CMFCOutlookBar Classe
Classe CMFCVisualManager