Nickvision::Taskbar::TaskbarItem Class Reference

An item on the taskbar. More...

#include <taskbaritem.h>

Public Member Functions
	TaskbarItem ()
	Constructs a TaskbarItem.
	~TaskbarItem ()
	Destructs a TaskbarItem.
ProgressState	getProgressState () const
	Gets the state of the progress.
void	setProgressState (ProgressState state)
	Sets the state of the progress.
double	getProgress () const
	Gets the value of the progress.
void	setProgress (double progress)
	Sets the value of the progress. Setting the progress value will set the progress state to Normal if progress > 0, else will set progress state to NoProgress.
bool	getUrgent () const
	Gets whether or not the taskbar item is shown in an urgent state.
void	setUrgent (bool urgent)
	Sets whether or not the taskbar item is shown in an urgent state.
bool	getCountVisible () const
	Gets whether or not the count is visible on the taskbar item.
void	setCountVisible (bool countVisible)
	Sets whether or not the count is visible on the taskbar item.
long	getCount () const
	Gets the count shown on the taskbar item.
void	setCount (long count)
	Sets the count shown on the taskbar item.

Detailed Description

An item on the taskbar.

Constructor & Destructor Documentation

TaskbarItem()

Nickvision::Taskbar::TaskbarItem::TaskbarItem

(

)

Constructs a TaskbarItem.

~TaskbarItem()

Nickvision::Taskbar::TaskbarItem::~TaskbarItem

(

)

Destructs a TaskbarItem.

Member Function Documentation

getCount()

long Nickvision::Taskbar::TaskbarItem::getCount

(

)

const

Gets the count shown on the taskbar item.

Returns

The count value

getCountVisible()

bool Nickvision::Taskbar::TaskbarItem::getCountVisible

(

)

const

Gets whether or not the count is visible on the taskbar item.

Returns

True if count visible, else false

getProgress()

double Nickvision::Taskbar::TaskbarItem::getProgress

(

)

const

Gets the value of the progress.

Returns

The progress value

getProgressState()

ProgressState Nickvision::Taskbar::TaskbarItem::getProgressState

(

)

const

Gets the state of the progress.

Returns

ProgressState

getUrgent()

bool Nickvision::Taskbar::TaskbarItem::getUrgent

(

)

const

Gets whether or not the taskbar item is shown in an urgent state.

Returns

True if in urgent state, else false

setCount()

void Nickvision::Taskbar::TaskbarItem::setCount

(

long

count

)

Sets the count shown on the taskbar item.

Parameters

count

The new count value

setCountVisible()

void Nickvision::Taskbar::TaskbarItem::setCountVisible

(

bool

countVisible

)

Sets whether or not the count is visible on the taskbar item.

Parameters

countVisible

True for visible count, else false

setProgress()

void Nickvision::Taskbar::TaskbarItem::setProgress

(

double

progress

)

Sets the value of the progress. Setting the progress value will set the progress state to Normal if progress > 0, else will set progress state to NoProgress.

Should be a value between 0 and 1.

Parameters

progress

The new progress value

setProgressState()

void Nickvision::Taskbar::TaskbarItem::setProgressState

(

ProgressState

state

)

Sets the state of the progress.

Parameters

state

The new ProgressState

setUrgent()

void Nickvision::Taskbar::TaskbarItem::setUrgent

(

bool

urgent

)

Sets whether or not the taskbar item is shown in an urgent state.

Parameters

urgent

True for urgent state, else false

---

The documentation for this class was generated from the following file:

• include/taskbar/taskbaritem.h