Cloud::CloudIcon Class Reference

Public Types
enum	Type { kNone, kSyncing, kDisabled }

Public Member Functions
void	show (Type icon, int duration=0)
Type	getShownType () const
bool	needsUpdate () const
void	update ()

Member Enumeration Documentation

Type

enum Cloud::CloudIcon::Type

The type of cloud icon to show

Enumerator
kSyncing	Hide the currently shown icon if any
kDisabled	Cloud syncing icon Cloud syncing not available icon

Member Function Documentation

show()

void Cloud::CloudIcon::show	(	Type	icon,
		int	duration = 0
	)

Select the icon to show on the OSD

Parameters

icon	Icon type to show. Use kNone to hide the current icon if any.
duration	Duration in milliseconds the icon stays visible on screen. 0 means the icon stays indefinitely.

getShownType()

Type Cloud::CloudIcon::getShownType

(

)

const

The currently visible icon. kNone means no icon is shown.

needsUpdate()

bool Cloud::CloudIcon::needsUpdate

(

)

const

Returns true if the icon state needs to be checked for changes

update()

void Cloud::CloudIcon::update

(

)

Update the icon visible on the OSD

---

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

• backends/cloud/cloudicon.h