CJumpList – třída
Seznam CJumpList klávesových zkratek se zobrazí po kliknutí pravým tlačítkem myši na ikonu na hlavním panelu.
Syntaxe
class CJumpList;
Členové
Veřejné konstruktory
| Název | Popis |
|---|---|
| CJumpList::CJumpList | CJumpList Vytvoří objekt. |
| CJumpList::~CJumpList | CJumpList Zničí objekt. |
| Název | Popis |
|---|---|
| CJumpList::AbortList | Přeruší transakci sestavení seznamu bez potvrzení. |
| CJumpList::AddDestination | Přetíženo. Přidá cíl do seznamu. |
| CJumpList::AddKnownCategory | Připojí k seznamu známou kategorii. |
| CJumpList::AddTask | Přetíženo. Přidá položky do kategorie Kanonické úkoly. |
| CJumpList::AddTasks | Přidá položky do kategorie Kanonické úkoly. |
| CJumpList::AddTaskSeparator | Přidá oddělovač mezi úkoly. |
| CJumpList::ClearAll | Odebere všechny úkoly a cíle, které byly přidány do aktuální instance CJumpList dosud. |
| CJumpList::ClearAllDestinations | Odebere všechny cíle, které byly do aktuální instance CJumpList dosud přidány. |
| CJumpList::CommitList | Ukončí transakci sestavení seznamu a potvrdí ohlášený seznam do přidruženého úložiště (v tomto případě registru.) |
| CJumpList::GetDestinationList | Načte ukazatel rozhraní na cílový seznam. |
| CJumpList::GetMaxSlots | Načte maximální počet položek včetně záhlaví kategorií, která se můžou zobrazit v cílové nabídce volající aplikace. |
| CJumpList::GetRemovedItems | Vrátí pole položek, které představují odebrané cíle. |
| CJumpList::InitializeList | Začíná transakce sestavení seznamu. |
| CJumpList::SetAppID | Nastaví ID modelu uživatele aplikace pro seznam, který se vytvoří. |
Hierarchie dědičnosti
Požadavky
Hlavička: afxadv.h
CJumpList::~CJumpList
CJumpList Zničí objekt.
~CJumpList();
CJumpList::AbortList
Přeruší transakci sestavení seznamu bez potvrzení.
void AbortList();
Poznámky
Volání této metody má stejný účinek jako zničení CJumpList bez volání CommitList.
CJumpList::AddDestination
Přidá cíl do seznamu.
BOOL AddDestination(
LPCTSTR lpcszCategoryName,
LPCTSTR strDestinationPath);
BOOL AddDestination(
LPCTSTR strCategoryName,
IShellItem* pShellItem);
BOOL AddDestination(
LPCTSTR strCategoryName,
IShellLink* pShellLink);
Parametry
lpcszCategoryName
Určuje název kategorie. Pokud zadaná kategorie neexistuje, vytvoří se.
strDestinationPath
Určuje cestu k cílovému souboru.
strCategoryName
Určuje název kategorie. Pokud zadaná kategorie neexistuje, vytvoří se.
pShellItem
Určuje položku prostředí představující cíl, který se přidává.
pShellLink
Určuje odkaz prostředí představující cíl, který se přidává.
Návratová hodnota
Poznámky
Instance CJumpList interně hromadí přidané cíle a pak je potvrdí do CommitList.
CJumpList::AddKnownCategory
Připojí k seznamu známou kategorii.
BOOL AddKnownCategory(KNOWNDESTCATEGORY category);
Parametry
kategorie
Určuje známý typ kategorie. Může to být KDC_RECENT nebo KDC_KNOWN.
Návratová hodnota
Poznámky
Známé kategorie jsou kategorie Časté a Poslední, které automaticky vypočítáme pro každou aplikaci, která ji využívá SHAddToRecentDocs (nebo nepřímo používá, protože prostředí ji v některých scénářích bude volat jménem aplikace).
CJumpList::AddTask
Přidá položky do kategorie Kanonické úkoly.
BOOL AddTask(
LPCTSTR strTargetExecutablePath,
LPCTSTR strCommandLineArgs,
LPCTSTR strTitle,
LPCTSTR strIconLocation,
int iIconIndex);
BOOL AddTask(IShellLink* pShellLink);
Parametry
strTargetExecutablePath
Určuje cílovou cestu úkolu.
strCommandLineArgs
Určuje argumenty příkazového řádku spustitelného souboru určeného strTargetExecutablePath.
strTitle
Název úkolu, který se zobrazí v cílovém seznamu
strIconLocation
Umístění ikony, která se zobrazí v cílovém seznamu spolu s názvem.
iIconIndex
Index ikony
pShellLink
Odkaz prostředí, který představuje úkol, který se má přidat.
Návratová hodnota
Poznámky
Instance kumulovaných zadaných úkolů a přidá je do cílového CJumpList seznamu během CommitList. Položky úkolů se zobrazí v kategorii v dolní části cílové nabídky aplikace. Tato kategorie má přednost před všemi ostatními kategoriemi, když je vyplněná v uživatelském rozhraní.
CJumpList::AddTasks
Přidá položky do kategorie Kanonické úkoly.
BOOL AddTasks(IObjectArray* pObjectCollection);
Parametry
pObjectCollection
Kolekce úkolů, které se mají přidat.
Návratová hodnota
Poznámky
Instance CJumpList shromažďuje zadané úkoly a přidá je do cílového seznamu během CommitList. Položky úkolů se zobrazí v kategorii v dolní části cílové nabídky aplikace. Tato kategorie má přednost před všemi ostatními kategoriemi, když je vyplněná v uživatelském rozhraní.
CJumpList::AddTaskSeparator
Přidá oddělovač mezi úkoly.
BOOL AddTaskSeparator();
Návratová hodnota
Nenulové, pokud je úspěšné, 0, pokud ne.
CJumpList::CJumpList
CJumpList Vytvoří objekt.
CJumpList(BOOL bAutoCommit = TRUE);
Parametry
bAutoCommit
Pokud je tento parametr FALSE, seznam není automaticky potvrzen v destruktoru.
CJumpList::ClearAll
Odebere všechny úkoly a cíle, které byly přidány do aktuální instance CJumpList dosud.
void ClearAll();
Poznámky
Tato metoda vymaže a uvolní všechna data a interní rozhraní.
CJumpList::ClearAllDestinations
Odebere všechny cíle, které byly dosud přidány do aktuální instance CJumpList.
void ClearAllDestinations();
Poznámky
Tuto funkci zavolejte, pokud potřebujete odebrat všechny cíle, které byly doposud přidány v aktuální relaci sestavení cílového seznamu, a znovu přidat další cíle. Pokud byla inicializována vnitřní ICustomDestinationList hodnota, zůstane naživu.
CJumpList::CommitList
Ukončí transakci sestavení seznamu a potvrdí ohlášený seznam do přidruženého úložiště (v tomto případě registru).
BOOL CommitList();
Návratová hodnota
Poznámky
Potvrzení je atomické. Pokud potvrzení selže, vrátí se chyba. Po CommitList zavolání se aktuální seznam odebraných položek vyčistí. Volání této metody resetuje objekt tak, aby neměl aktivní list-building transakce. Pokud chcete seznam aktualizovat, BeginList je potřeba volat znovu.
CJumpList::GetDestinationList
Načte ukazatel rozhraní na cílový seznam.
ICustomDestinationList* GetDestinationList();
Návratová hodnota
Poznámky
Pokud seznam odkazů nebyl inicializován nebo byl potvrzen nebo přerušen, vrácená hodnota bude NULL.
CJumpList::GetMaxSlots
Načte maximální počet položek včetně záhlaví kategorií, která se můžou zobrazit v cílové nabídce volající aplikace.
UINT GetMaxSlots() const;
Návratová hodnota
Poznámky
Aplikace můžou hlásit pouze počet položek a záhlaví kategorií zkombinovaných až do této hodnoty. Pokud volání , AppendCategoryAppendKnownCategorynebo AddUserTasks překročí toto číslo, vrátí selhání.
CJumpList::GetRemovedItems
Vrátí pole položek, které představují odebrané cíle.
IObjectArray* GetRemovedItems();
Návratová hodnota
Poznámky
Odebrané cíle se načtou během inicializace seznamu odkazů. Při generování nového cílového seznamu se očekává, že aplikace nejprve zpracují odebraný seznam cílů a vymažou data o sledování všech položek vrácených enumerátorem odebraných seznamů. Pokud se aplikace pokusí poskytnout položku, která byla právě odebrána v transakci, kterou aktuální volání BeginList spustilo, volání metody, která znovu přidala tuto položku, se nezdaří, aby se zajistilo, že aplikace respektují odebraný seznam.
CJumpList::InitializeList
Začíná transakce sestavení seznamu.
BOOL InitializeList();
Návratová hodnota
Poznámky
Tuto metodu nemusíte volat explicitně, pokud nechcete načíst ukazatel na ICustomDestinationList použití GetDestinationList, počet dostupných slotů pomocí GetMaxSlotsnebo seznam odebraných položek pomocí GetRemovedItems.
CJumpList::SetAppID
Nastaví ID modelu uživatele aplikace pro seznam, který se vytvoří.
void SetAppID(LPCTSTR strAppID);
Parametry
strAppID
Řetězec, který určuje ID modelu uživatele aplikace.