Classe CJumpList

Um CJumpList é a lista de atalhos revelados quando você clica com o botão direito do mouse em um ícone na barra de tarefas.

Sintaxe

class CJumpList;

Membros

Construtores públicos

Name Descrição
CJumpList::CJumpList Constrói um objeto CJumpList.
CJumpList::~CJumpList Destrói um objeto CJumpList.
Name Descrição
CJumpList::AbortList Anula uma transação de criação de lista sem se comprometer.
CJumpList::AddDestination Sobrecarregado. Adiciona o destino à lista.
CJumpList::AddKnownCategory Anexa uma Categoria Conhecida à lista.
CJumpList::AddTask Sobrecarregado. Adiciona itens à categoria Tarefas canônicas.
CJumpList::AddTasks Adiciona itens à categoria Tarefas canônicas.
CJumpList::AddTaskSeparator Adiciona um separador entre tarefas.
CJumpList::ClearAll Remove todas as tarefas e destinos que foram adicionados à instância atual do CJumpList até o momento.
CJumpList::ClearAllDestinations Remove todos os destinos que foram adicionados à instância atual do CJumpList até o momento.
CJumpList::CommitList Encerra uma transação de criação de lista e confirma a lista relatada para o armazenamento associado (o Registro, nesse caso.)
CJumpList::GetDestinationList Recupera um ponteiro de interface para a lista de destino.
CJumpList::GetMaxSlots Recupera o número máximo de itens, incluindo os headers de categoria que podem ser exibidos no menu de destino do aplicativo de chamada.
CJumpList::GetRemovedItems Retorna a matriz de itens que representam destinos removidos.
CJumpList::InitializeList Inicia uma transação de criação de lista.
CJumpList::SetAppID Define a ID do Modelo de Usuário do Aplicativo para a lista que será criada.

Hierarquia de herança

CJumpList

Requisitos

Header: afxadv.h

CJumpList::~CJumpList

Destrói um objeto CJumpList.

~CJumpList();

CJumpList::AbortList

Anula uma transação de criação de lista sem se comprometer.

void AbortList();

Comentários

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

CJumpList::AddDestination

Adiciona o destino à lista.

BOOL AddDestination(
    LPCTSTR lpcszCategoryName,
    LPCTSTR strDestinationPath);

BOOL AddDestination(
    LPCTSTR strCategoryName,
    IShellItem* pShellItem);

BOOL AddDestination(
    LPCTSTR strCategoryName,
    IShellLink* pShellLink);

Parâmetros

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

strDestinationPath
Especifica um caminho para o arquivo de destino.

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

pShellItem
Especifica um Item de Shell que representa o destino que está sendo adicionado.

pShellLink
Especifica um Link do Shell que representa o destino que está sendo adicionado.

Valor Retornado

Comentários

A instância do CJumpList acumula internamente destinos adicionados e, em seguida, confirma-os em CommitList.

CJumpList::AddKnownCategory

Anexa uma Categoria Conhecida à lista.

BOOL AddKnownCategory(KNOWNDESTCATEGORY category);

Parâmetros

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

Valor Retornado

Comentários

Categorias conhecidas são as categorias SHAddToRecentDocs Frequente e Recente que calcularemos automaticamente para cada aplicativo que utiliza (ou o usará indiretamente, pois o shell o chamará em nome do aplicativo em alguns cenários).

CJumpList::AddTask

Adiciona itens à categoria Tarefas canônicas.

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

BOOL AddTask(IShellLink* pShellLink);

Parâmetros

strTargetExecutablePath
Especifica o caminho da tarefa de destino.

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

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

strIconLocation
Local do ícone que será exibido na Lista de Destino junto com o título.

iIconIndex
Índice de ícone.

pShellLink
Shell Link que representa uma tarefa a ser adicionada.

Valor Retornado

Comentários

A instância do CJumpList acumula tarefas especificadas e as adiciona à Lista de Destino durante CommitList. Os itens de tarefa aparecerão em uma categoria na parte inferior do menu de destino do aplicativo. Essa categoria tem precedência sobre todas as outras categorias quando ela é preenchida na interface do usuário.

CJumpList::AddTasks

Adiciona itens à categoria Tarefas canônicas.

BOOL AddTasks(IObjectArray* pObjectCollection);

Parâmetros

pObjectCollection
Uma coleção de tarefas a serem adicionadas.

Valor Retornado

Comentários

A instância de CJumpList acumula tarefas especificadas e as adiciona à Lista de Destino durante .CommitList Os itens de tarefa aparecerão em uma categoria na parte inferior do menu de destino do aplicativo. Essa categoria tem precedência sobre todas as outras categorias quando ela é preenchida na interface do usuário.

CJumpList::AddTaskSeparator

Adiciona um separador entre tarefas.

BOOL AddTaskSeparator();

Valor Retornado

Além de zero se for bem-sucedido, 0 se não for.

CJumpList::CJumpList

Constrói um objeto CJumpList.

CJumpList(BOOL bAutoCommit = TRUE);

Parâmetros

bAutoCommit
Se esse parâmetro for FALSE, a lista não será automaticamente comprometida no destruidor.

CJumpList::ClearAll

Remove todas as tarefas e destinos que foram adicionados à instância atual do CJumpList até o momento.

void ClearAll();

Comentários

Esse método limpa e libera todos os dados e interfaces internas.

CJumpList::ClearAllDestinations

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

void ClearAllDestinations();

Comentários

Chame essa função se você precisar remover todos os destinos que foram adicionados até o momento na sessão atual da criação da lista de destino e adicionar outros destinos novamente. Se o interno ICustomDestinationList tiver sido inicializado, ele será deixado a vivo.

CJumpList::CommitList

Termina uma transação de criação de lista e confirma a lista relatada para o armazenamento associado (o registro nesse caso).

BOOL CommitList();

Valor Retornado

Comentários

A confirmação é atômica. Um erro será retornado se a confirmação falhar. Quando CommitList for chamado, a lista atual de itens removidos será limpa. Chamar esse método redefine o objeto para que ele não tenha uma transação de criação de lista ativa. Para atualizar a lista, BeginList precisa ser chamado novamente.

CJumpList::GetDestinationList

Recupera um ponteiro de interface para a lista de destino.

ICustomDestinationList* GetDestinationList();

Valor Retornado

Comentários

Se a lista de saltos não tiver sido inicializada ou tiver sido confirmado ou anulado, o valor retornado será NULL.

CJumpList::GetMaxSlots

Recupera o número máximo de itens, incluindo os headers de categoria que podem ser exibidos no menu de destino do aplicativo de chamada.

UINT GetMaxSlots() const;

Valor Retornado

Comentários

Os aplicativos só podem relatar um número de itens e de categorias combinados até esse valor. Se chamar AppendCategory, AppendKnownCategoryou exceder esse AddUserTasks número, eles retornarão a falha.

CJumpList::GetRemovedItems

Retorna a matriz de itens que representam destinos removidos.

IObjectArray* GetRemovedItems();

Valor Retornado

Comentários

Os destinos removidos são recuperados durante a inicialização da lista de saltos. Ao gerar uma nova lista de destino, os aplicativos devem primeiro processar a lista de destinos removidos, limpando seus dados de acompanhamento para qualquer item retornado pelo enumerador de lista removido. Se um aplicativo tentar fornecer um item BeginList que acabou de ser removido na transação para a que a chamada atual foi iniciada, a chamada de método que adicionou esse item falhará, para garantir que os aplicativos estão respeitando a lista removida.

CJumpList::InitializeList

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

BOOL InitializeList();

Valor Retornado

Comentários

Você não precisa chamar esse método explicitamente, a menos que deseje recuperar um ponteiro para usando , o número de slots disponíveis usando ou a ICustomDestinationListGetDestinationListlista de itens removidos GetMaxSlotsusando GetRemovedItems.

CJumpList::SetAppID

Define a ID do Modelo de Usuário do Aplicativo para a lista que será criada.

void SetAppID(LPCTSTR strAppID);

Parâmetros

strAppID
Uma cadeia de caracteres que especifica a ID do Modelo de Usuário do Aplicativo.

Confira também

Classes