Version: 3.1.3
wxTaskBarJumpList Class Reference

#include <wx/taskbarbutton.h>

Detailed Description

This class is an transparent wrapper around Windows Jump Lists.

Jump Lists, as an new feature since Windows 7, are lists of recently opened items, such as files, folders, or websites, which are organized by the program that the user use to open them. Jump Lists don't just show shortcuts to files. Sometimes they can also provide quick access to tasks. With this class, you can access the recent and frequent category in the jump lists. You can also set the tasks category of the Jump Lists of your application. What's more, you can add custom category to them.

Library:  wxCore
Category:  Miscellaneous
Availability:  only available for the wxMSW port.
See also
wxTaskBarJumpListCategory, wxTaskBarJumpListItem
Since
3.1.0

Public Member Functions

 wxTaskBarJumpList (const wxString &appID=wxEmptyString)
 Constructs the jump list. More...
 
virtual ~wxTaskBarJumpList ()
 
void ShowRecentCategory (bool shown=true)
 Shows or hides the recent category. More...
 
void HideRecentCategory ()
 Hides the recent category. More...
 
void ShowFrequentCategory (bool shown=true)
 Shows or hides the frequent category. More...
 
void HideFrequentCategory ()
 Hides the frequent category. More...
 
wxTaskBarJumpListCategoryGetTasks () const
 Accesses the built in tasks category. More...
 
const wxTaskBarJumpListCategoryGetFrequentCategory () const
 Gets the built in frequent category. More...
 
const wxTaskBarJumpListCategoryGetRecentCategory () const
 Gets the built in recent category. More...
 
const wxTaskBarJumpListCategoriesGetCustomCategories () const
 Gets the custom categories. More...
 
void AddCustomCategory (wxTaskBarJumpListCategory *category)
 Add an new custom category. More...
 
wxTaskBarJumpListCategoryRemoveCustomCategory (const wxString &title)
 Removes the custom category from the jump lists but doesn't delete the associated C++ object. More...
 
void DeleteCustomCategory (const wxString &title)
 Deletes the custom category from the jump lists. More...
 

Constructor & Destructor Documentation

wxTaskBarJumpList::wxTaskBarJumpList ( const wxString appID = wxEmptyString)

Constructs the jump list.

Parameters
appIDSpecifies a unique identifier for the application jump list, can be empty by default.

See Application User Model IDs on MSDN for further details.

virtual wxTaskBarJumpList::~wxTaskBarJumpList ( )
virtual

Member Function Documentation

void wxTaskBarJumpList::AddCustomCategory ( wxTaskBarJumpListCategory category)

Add an new custom category.

Parameters
categoryA wxTaskBarJumpListCategory object. It will be owned by the wxTaskBarJumpList object after this function is called, so do not delete it yourself.
void wxTaskBarJumpList::DeleteCustomCategory ( const wxString title)

Deletes the custom category from the jump lists.

Parameters
titleThe title of the custom category.
const wxTaskBarJumpListCategories& wxTaskBarJumpList::GetCustomCategories ( ) const

Gets the custom categories.

const wxTaskBarJumpListCategory& wxTaskBarJumpList::GetFrequentCategory ( ) const

Gets the built in frequent category.

Note that the returned category is read-only.

const wxTaskBarJumpListCategory& wxTaskBarJumpList::GetRecentCategory ( ) const

Gets the built in recent category.

Note that the returned category is read-only.

wxTaskBarJumpListCategory& wxTaskBarJumpList::GetTasks ( ) const

Accesses the built in tasks category.

With the returned tasks category, you can append an new task, remove an existing task, modify the task item etc.

void wxTaskBarJumpList::HideFrequentCategory ( )

Hides the frequent category.

Equivalent to calling wxTaskBarJumpList::ShowFrequentCategory(false).

void wxTaskBarJumpList::HideRecentCategory ( )

Hides the recent category.

Equivalent to calling wxTaskBarJumpList::ShowFrequentCategory(false).

wxTaskBarJumpListCategory* wxTaskBarJumpList::RemoveCustomCategory ( const wxString title)

Removes the custom category from the jump lists but doesn't delete the associated C++ object.

Parameters
titleThe title of the custom category.
void wxTaskBarJumpList::ShowFrequentCategory ( bool  shown = true)

Shows or hides the frequent category.

void wxTaskBarJumpList::ShowRecentCategory ( bool  shown = true)

Shows or hides the recent category.