Classe CJumpList

Uma 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

Nome	Descrição
CJumpList::CJumpList	Constrói um objeto CJumpList.
CJumpList::~CJumpList	Destrói um objeto CJumpList.

Nome	Descrição
CJumpList::AbortList	Anula uma transação de criação de lista sem confirmar.
CJumpList::AddDestination	Sobrecarregado. Adiciona o destino à lista.
CJumpList::AddKnownCategory	Acrescenta 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 adicionados à instância atual de CJumpList até agora.
CJumpList::ClearAllDestinations	Remove todos os destinos adicionados à instância atual de CJumpList até agora.
CJumpList::CommitList	Encerra uma transação de criação de lista e confirma a lista relatada para o repositório associado (o Registro neste caso).
CJumpList::GetDestinationList	Recupera um ponteiro de interface para a lista de destino.
CJumpList::GetMaxSlots	Recupera o número máximo de itens, incluindo cabeçalhos 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

Cabeçalho: afxadv.h

CJumpList::~CJumpList

Destrói um objeto CJumpList.

~CJumpList();

CJumpList::AbortList

Anula uma transação de criação de lista sem confirmar.

void AbortList();

Comentários

Chamar esse método tem o mesmo efeito que destruir CJumpList sem 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 de retorno

Comentários

A instância de CJumpList acumula internamente destinos adicionados e os confirma em CommitList.

CJumpList::AddKnownCategory

Acrescenta 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 de retorno

Comentários

Categorias conhecidas são as categorias Frequente e Recente que calcularemos de modo automático para cada aplicativo que utiliza SHAddToRecentDocs (ou o usa 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 do ícone.

pShellLink
Link do Shell que representa uma tarefa a ser adicionada.

Valor de retorno

Comentários

A instância de CJumpList acumula tarefas especificadas e as adiciona à Lista de Destino durante CommitList. Os itens da tarefa serão exibidos em uma categoria na parte inferior do menu de destino do aplicativo. Essa categoria tem precedência sobre todas as outras categorias quando é 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 de retorno

Comentários

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

CJumpList::AddTaskSeparator

Adiciona um separador entre tarefas.

BOOL AddTaskSeparator();

Valor de retorno

Não 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á confirmada automaticamente no destruidor.

CJumpList::ClearAll

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

void ClearAll();

Comentários

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

CJumpList::ClearAllDestinations

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

void ClearAllDestinations();

Comentários

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

CJumpList::CommitList

Encerra uma transação de criação de lista e confirma a lista relatada para o repositório associado (o Registro nesse caso).

BOOL CommitList();

Valor de retorno

Comentários

A confirmação é atômica. Um erro será retornado se a confirmação falhar. Quando CommitList for chamada, 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 de retorno

Comentários

Se a lista de saltos não tiver sido inicializada, ou tiver sido confirmada ou anulada, o valor retornado 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 do aplicativo de chamada.

UINT GetMaxSlots() const;

Valor de retorno

Comentários

Os aplicativos só podem relatar vários itens e cabeçalhos de categoria combinados até esse valor. Se as chamadas a AppendCategory, AppendKnownCategory ou AddUserTasks excederem esse número, elas retornarão a falha.

CJumpList::GetRemovedItems

Retorna a matriz de itens que representam destinos removidos.

IObjectArray* GetRemovedItems();

Valor de retorno

Comentários

Os destinos removidos são recuperados durante a inicialização da lista de saltos. Ao gerar uma nova lista de destino, espera-se que os aplicativos primeiro processem 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 que acabou de ser removido na transação para a qual a chamada atual a BeginList foi iniciada, a chamada de método que reinseriu esse item falhará, para garantir que os aplicativos estejam respeitando a lista removida.

CJumpList::InitializeList

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

BOOL InitializeList();

Valor de retorno

Comentários

Você não precisa chamar esse método explicitamente, a menos que deseje recuperar um ponteiro para ICustomDestinationList usando GetDestinationList, o número de slots disponíveis usando GetMaxSlots ou a lista de itens removidos usando 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