Version: 3.1.3
wxTaskBarJumpListItem Class Reference

#include <wx/taskbarbutton.h>

Detailed Description

A wxTaskBarJumpListItem represents an item in a jump list category.

Library:  wxCore
Category:  Miscellaneous
Availability:  only available for the wxMSW port.
Since
3.1.0

Public Member Functions

 wxTaskBarJumpListItem (wxTaskBarJumpListCategory *parentCategory=NULL, wxTaskBarJumpListItemType type=wxTASKBAR_JUMP_LIST_SEPARATOR, const wxString &title=wxEmptyString, const wxString &filePath=wxEmptyString, const wxString &arguments=wxEmptyString, const wxString &tooltip=wxEmptyString, const wxString &iconPath=wxEmptyString, int iconIndex=0)
 Constructs a jump list item. More...
 
wxTaskBarJumpListItemType GetType () const
 Returns the type of this item. More...
 
void SetType (wxTaskBarJumpListItemType type)
 Sets the type of this item. More...
 
const wxStringGetTitle () const
 Returns the title of this item. More...
 
void SetTitle (const wxString &title)
 Sets the title of this item. More...
 
const wxStringGetFilePath () const
 Returns the file path of this item. More...
 
void SetFilePath (const wxString &filePath)
 Sets the file path of this item. More...
 
const wxStringGetArguments () const
 Returns the command-line arguments of this item. More...
 
void SetArguments (const wxString &arguments)
 Sets the command-line arguments of this item. More...
 
const wxStringGetTooltip () const
 Returns the description tooltip of this item. More...
 
void SetTooltip (const wxString &tooltip)
 Sets the description tooltip of this item. More...
 
const wxStringGetIconPath () const
 Returns the icon path of this item. More...
 
void SetIconPath (const wxString &iconPath)
 Sets the icon path of this item. More...
 
int GetIconIndex () const
 Returns the icon index of icon in this item. More...
 
void SetIconIndex (int iconIndex)
 Sets the icon index of icon in this item. More...
 
wxTaskBarJumpListCategoryGetCategory () const
 Returns the category this jump list item is in, or NULL if this jump list item is not attached. More...
 
void SetCategory (wxTaskBarJumpListCategory *category)
 Sets the parent category which will contain this jump list item. More...
 

Constructor & Destructor Documentation

wxTaskBarJumpListItem::wxTaskBarJumpListItem ( wxTaskBarJumpListCategory parentCategory = NULL,
wxTaskBarJumpListItemType  type = wxTASKBAR_JUMP_LIST_SEPARATOR,
const wxString title = wxEmptyString,
const wxString filePath = wxEmptyString,
const wxString arguments = wxEmptyString,
const wxString tooltip = wxEmptyString,
const wxString iconPath = wxEmptyString,
int  iconIndex = 0 
)

Constructs a jump list item.

Parameters
parentCategoryCategory that the jump list item belongs to. Can be NULL if the item is going to be added to the category later.
typeThe type for this item.
titleThe title of this item.
filePathThe filePath of this item, the meaning of which depends on the type of this item: If the item type is wxTASKBAR_JUMP_LIST_DESTINATION, filePath is the path to a file that can be opened by an application. If the item type is wxTASKBAR_JUMP_LIST_TASK, filePath is the path to an executable that is executed when this item is clicked by the user.
argumentsThe command-line arguments of this item.
tooltipThe description tooltip of this item.
iconPathThe path to the file containing the icon.
iconIndexThe index of the icon, which is specified by iconPath.

Member Function Documentation

const wxString& wxTaskBarJumpListItem::GetArguments ( ) const

Returns the command-line arguments of this item.

wxTaskBarJumpListCategory* wxTaskBarJumpListItem::GetCategory ( ) const

Returns the category this jump list item is in, or NULL if this jump list item is not attached.

const wxString& wxTaskBarJumpListItem::GetFilePath ( ) const

Returns the file path of this item.

int wxTaskBarJumpListItem::GetIconIndex ( ) const

Returns the icon index of icon in this item.

const wxString& wxTaskBarJumpListItem::GetIconPath ( ) const

Returns the icon path of this item.

const wxString& wxTaskBarJumpListItem::GetTitle ( ) const

Returns the title of this item.

const wxString& wxTaskBarJumpListItem::GetTooltip ( ) const

Returns the description tooltip of this item.

wxTaskBarJumpListItemType wxTaskBarJumpListItem::GetType ( ) const

Returns the type of this item.

void wxTaskBarJumpListItem::SetArguments ( const wxString arguments)

Sets the command-line arguments of this item.

void wxTaskBarJumpListItem::SetCategory ( wxTaskBarJumpListCategory category)

Sets the parent category which will contain this jump list item.

void wxTaskBarJumpListItem::SetFilePath ( const wxString filePath)

Sets the file path of this item.

void wxTaskBarJumpListItem::SetIconIndex ( int  iconIndex)

Sets the icon index of icon in this item.

void wxTaskBarJumpListItem::SetIconPath ( const wxString iconPath)

Sets the icon path of this item.

void wxTaskBarJumpListItem::SetTitle ( const wxString title)

Sets the title of this item.

void wxTaskBarJumpListItem::SetTooltip ( const wxString tooltip)

Sets the description tooltip of this item.

void wxTaskBarJumpListItem::SetType ( wxTaskBarJumpListItemType  type)

Sets the type of this item.