Classe CJumpList

A CJumpList é a lista de atalhos revelada quando clica com o botão direito num ícone na barra de tarefas.

Sintaxe

class CJumpList;

Membros

Construtores Públicos

Hierarquia de herança

CJumpList

Requerimentos

Cabeçalho: afxadv.h

CJumpList::~CJumpList

Destrói um CJumpList objeto.

~CJumpList();

CJumpList::AbortList

Aborta uma transação de construção de listas sem comprometer.

void AbortList();

Observações

Chamar este método tem o mesmo efeito que destruir CJumpList sem chamar CommitList.

CJumpList::AddDestination

Adiciona destino à lista.

BOOL AddDestination(
    LPCTSTR lpcszCategoryName,
    LPCTSTR strDestinationPath);

BOOL AddDestination(
    LPCTSTR strCategoryName,
    IShellItem* pShellItem);

BOOL AddDestination(
    LPCTSTR strCategoryName,
    IShellLink* pShellLink);

Parâmetros

lpcszNomeCategoria
Especifica um nome de categoria. Se a categoria especificada não existir, será criada.

strDestinationPath
Especifica um ficheiro de caminho para destino.

strCategoryName
Especifica um nome de categoria. Se a categoria especificada não existir, será criada.

pShellItem
Especifica um item de Shell que representa o destino a ser adicionado.

pShellLink
Especifica um Shell Link que representa o destino a ser adicionado.

Valor de retorno

Observações

A instância de CJumpList internamente acumula destinos adicionados e depois faz commit em CommitList.

CJumpList::AddKnownCategory

Acrescenta uma Categoria Conhecida à lista.

BOOL AddKnownCategory(KNOWNDESTCATEGORY category);

Parâmetros

categoria
Especifica um tipo de categoria conhecido. Pode ser KDC_RECENT ou KDC_KNOWN.

Valor de retorno

Observações

As Categorias Conhecidas são as categorias Frequentes e Recentes que calcularemos automaticamente para cada aplicação que a utilize SHAddToRecentDocs (ou use indiretamente, como o shell a chamará em nome da aplicação em alguns cenários).

CJumpList::AddTask

Adiciona itens à categoria canónica de Tarefas.

BOOL AddTask(
    LPCTSTR strTargetExecutablePath,
    LPCTSTR strCommandLineArgs,
    LPCTSTR strTitle,
    LPCTSTR strIconLocation,
    int iIconIndex);

BOOL AddTask(IShellLink* pShellLink);

Parâmetros

strTargetExecutablePath
Especifica o caminho da tarefa alvo.

strCommandLineArgs
Especifica argumentos de linha de comandos do executável especificado por strTargetExecutablePath.

strTitle
Nome da tarefa que será exibido na Lista de Destinos.

strIconLocalização
Localização do ícone que será exibido na Lista de Destinos juntamente com o título.

iIconIndex
Índice de ícones.

pShellLink
Shell Link que representa uma tarefa a ser adicionada.

Valor de retorno

Observações

A instância de CJumpList acumula tarefas especificadas e adiciona-as à Lista de Destino durante CommitList. Os itens da tarefa aparecerão numa categoria na parte inferior do menu de destino da aplicação. Esta categoria tem prioridade sobre todas as outras categorias quando é preenchida na interface.

CJumpList::AddTasks

Adiciona itens à categoria canónica de Tarefas.

BOOL AddTasks(IObjectArray* pObjectCollection);

Parâmetros

pObjectCollection
Uma coleção de tarefas a acrescentar.

Valor de retorno

Observações

A instância de CJumpList acumula tarefas especificadas e adiciona-as à Lista de Destino durante CommitList. Os itens da tarefa aparecerão numa categoria na parte inferior do menu de destino da aplicação. Esta categoria tem prioridade sobre todas as outras categorias quando é preenchida na interface.

CJumpList::AddTaskSeparator

Adiciona um separador entre tarefas.

BOOL AddTaskSeparator();

Valor de retorno

Diferente de zero se for bem-sucedido, 0 se não for.

CJumpList::CJumpList

Constrói um CJumpList objeto.

CJumpList(BOOL bAutoCommit = TRUE);

Parâmetros

bAutoCommit
Se este parâmetro for FALSO, a lista não é automaticamente comprometida no destruidor.

CJumpList::ClearAll

Remove todas as tarefas e destinos que foram adicionados à instância atual de CJumpList até agora.

void ClearAll();

Observações

Este método limpa e liberta todos os dados e interfaces internas.

CJumpList::ClearAllDestinations

Remove todos os destinos que foram adicionados à instância atual do CJumpList até agora.

void ClearAllDestinations();

Observações

Chame esta função se precisar de remover todos os destinos que foram adicionados até agora na sessão atual de construção da lista de destinos e adicionar outros destinos novamente. Se o interno ICustomDestinationList foi inicializado, fica vivo.

CJumpList::CommitList

Termina uma transação de construção de listas e compromete a lista reportada para a loja associada (neste caso, o registo).

BOOL CommitList();

Valor de retorno

Observações

O commit é atómico. Um erro será devolvido se o commit falhar. Quando CommitList for chamado, a lista atual de itens removidos será limpa. Chamar este método reinicia o objeto para que não tenha uma transação ativa de construção de listas. Para atualizar a lista, BeginList é preciso ser chamado novamente.

CJumpList::GetDestinationList

Recupera um ponteiro de interface para a lista de destinos.

ICustomDestinationList* GetDestinationList();

Valor de retorno

Observações

Se a lista de salto não tiver sido inicializada, ou tiver sido comprometida ou abortada, o valor devolvido será NULL.

CJumpList::GetMaxSlots

Recupera o número máximo de itens, incluindo cabeçalhos de categoria que podem ser exibidos no menu de destino da aplicação que chama.

UINT GetMaxSlots() const;

Valor de retorno

Observações

As aplicações podem reportar apenas um número de itens e cabeçalhos de categoria combinados até este valor. Se chamadas para AppendCategory, AppendKnownCategory, ou AddUserTasks excederem este número, devolverão falhar.

CJumpList::GetRemovedItems

Devolve um array de itens que representam destinos removidos.

IObjectArray* GetRemovedItems();

Valor de retorno

Observações

Os destinos removidos são recuperados durante a inicialização da lista de saltos. Ao gerar uma nova lista de destinos, espera-se que as aplicações processem primeiro a lista de destinos removidos, limpando os seus dados de rastreio para qualquer item devolvido pelo enumerador da lista removida. Se uma aplicação tentar fornecer um item que acabou de ser removido na transação a que a chamada BeginList atual iniciou, a chamada de método que voltou a adicionar esse item falhará, para garantir que as aplicações respeitam a lista removida.

CJumpList::InitializeList

Inicia uma transação de construção de lista.

BOOL InitializeList();

Valor de retorno

Observações

Não precisa de chamar este método explicitamente, a menos que queira recuperar um ponteiro para ICustomDestinationList usar GetDestinationList, o número de espaços disponíveis usando GetMaxSlots, ou uma lista de itens removidos usando GetRemovedItems.

CJumpList::SetAppID

Define o ID do Modelo de Utilizador da Aplicação para a lista que será construída.

void SetAppID(LPCTSTR strAppID);

Parâmetros

strAppID
Uma cadeia que especifica o ID do Modelo de Utilizador da Aplicação.

Consulte também

Classes