Version: 3.1.3
wxTaskBarJumpListCategory Class Reference

#include <wx/taskbarbutton.h>

Detailed Description

This class represents a category of jump list in the taskbar button.

There are four kinds of categories in Windows: Recent, Frequent, Tasks and custom.

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

Public Member Functions

 wxTaskBarJumpListCategory (wxTaskBarJumpList *parent=NULL, const wxString &title=wxEmptyString)
 Constructs the jump list category. More...
 
virtual ~wxTaskBarJumpListCategory ()
 
wxTaskBarJumpListItemAppend (wxTaskBarJumpListItem *item)
 Appends a jump list item. More...
 
void Delete (wxTaskBarJumpListItem *item)
 Deletes the jump list item from the category. More...
 
wxTaskBarJumpListItemRemove (wxTaskBarJumpListItem *item)
 Removes the jump list item from the category but doesn't delete the associated C++ object. More...
 
wxTaskBarJumpListItemFindItemByPosition (size_t pos) const
 Returns the wxTaskBarJumpListItem given a position in the category. More...
 
wxTaskBarJumpListItemInsert (size_t pos, wxTaskBarJumpListItem *item)
 Inserts the given item before the position pos. More...
 
wxTaskBarJumpListItemPrepend (wxTaskBarJumpListItem *item)
 Inserts the given item at position 0, i.e. More...
 
void SetTitle (const wxString &title)
 Sets the title of the category. More...
 
const wxStringGetTitle () const
 Gets the title of the category. More...
 
const wxTaskBarJumpListItemsGetItems () const
 Gets the jump list items of the category. More...
 

Constructor & Destructor Documentation

wxTaskBarJumpListCategory::wxTaskBarJumpListCategory ( wxTaskBarJumpList parent = NULL,
const wxString title = wxEmptyString 
)

Constructs the jump list category.

Parameters
parentJump list that the jump list category belongs to. Can be NULL if the category is going to be added to the jump list later.
titleThe title of the category.
virtual wxTaskBarJumpListCategory::~wxTaskBarJumpListCategory ( )
virtual

Member Function Documentation

wxTaskBarJumpListItem* wxTaskBarJumpListCategory::Append ( wxTaskBarJumpListItem item)

Appends a jump list item.

Parameters
itemThe jump list item to be appended. It will be owned by the wxTaskBarJumpListCategory object after this function is called, so do not delete it yourself.
See also
Insert(), Prepend()
void wxTaskBarJumpListCategory::Delete ( wxTaskBarJumpListItem item)

Deletes the jump list item from the category.

Parameters
itemThe jump list item to be deleted.
See also
Remove()
wxTaskBarJumpListItem* wxTaskBarJumpListCategory::FindItemByPosition ( size_t  pos) const

Returns the wxTaskBarJumpListItem given a position in the category.

const wxTaskBarJumpListItems& wxTaskBarJumpListCategory::GetItems ( ) const

Gets the jump list items of the category.

const wxString& wxTaskBarJumpListCategory::GetTitle ( ) const

Gets the title of the category.

wxTaskBarJumpListItem* wxTaskBarJumpListCategory::Insert ( size_t  pos,
wxTaskBarJumpListItem item 
)

Inserts the given item before the position pos.

See also
Append(), Prepend()
wxTaskBarJumpListItem* wxTaskBarJumpListCategory::Prepend ( wxTaskBarJumpListItem item)

Inserts the given item at position 0, i.e.

before all the other existing items.

See also
Append(), Insert();
wxTaskBarJumpListItem* wxTaskBarJumpListCategory::Remove ( wxTaskBarJumpListItem item)

Removes the jump list item from the category but doesn't delete the associated C++ object.

Parameters
itemThe jump list item to be removed.
void wxTaskBarJumpListCategory::SetTitle ( const wxString title)

Sets the title of the category.