LC::Util::XDG Namespace Reference

Classes
class	DesktopParser
	A parser for XDG .desktop files. More...
class	Item
	Describes a single XDG .desktop entry. More...
class	ItemsDatabase
	An ItemsFinder automatically watching for changes in .desktop files. More...
class	ItemsFinder
	Finds and parses XDG .desktop files. More...

Typedefs
using	Item_ptr = std::shared_ptr< Item >
using	Cat2Items_t = QHash< QString, QList< Item_ptr > >

Enumerations
enum	Type {   Type::Other,   Type::Application,   Type::URL,   Type::Dir }
	Describes the various types of XDG .desktop files. More...

Functions
bool	operator== (const Item &left, const Item &right)
bool	operator!= (const Item &left, const Item &right)
QDebug	operator<< (QDebug stream, const Item &item)
	Serializes item contents to the debugging stream. More...
QStringList	ToPaths (const QList< Type > &types)
	Returns a set of typical directories with desktop files of the given types. More...
QIcon	GetAppIcon (const QString &name)
QPixmap	GetAppPixmap (const QString &name)

Variables
class UTIL_XDG_API	Item
class UTIL_XDG_API	ItemsFinder

Typedef Documentation

Cat2Items_t

using LC::Util::XDG::Cat2Items_t = typedef QHash<QString, QList<Item_ptr> >

Definition at line 47 of file itemsfinder.h.

Item_ptr

typedef std::shared_ptr< Item > LC::Util::XDG::Item_ptr

Definition at line 49 of file item.h.

Enumeration Type Documentation

Type

enum LC::Util::XDG::Type

strong

Describes the various types of XDG .desktop files.

Enumerator
Other	Unknown type.
Application	A shortcut to an application.
URL	A shortcut to an URL.
Dir	A shortcut to a directory.

Definition at line 48 of file itemtypes.h.

Function Documentation

GetAppIcon()

UTIL_XDG_API QIcon LC::Util::XDG::GetAppIcon

(

const QString &

name

)

Definition at line 40 of file xdg.cpp.

References GetAppPixmap().

Here is the call graph for this function:

GetAppPixmap()

UTIL_XDG_API QPixmap LC::Util::XDG::GetAppPixmap

(

const QString &

name

)

Definition at line 45 of file xdg.cpp.

Referenced by GetAppIcon().

Here is the caller graph for this function:

operator!=()

bool LC::Util::XDG::operator!=	(	const Item &	left,
		const Item &	right
	)

The icon field obtained via GetIcon() is not checked for equality.

Parameters

[in]	left	First XDG item to check for inequality.
[in]	right	Second XDG item to check for inequality.

Returns

Whether left and right are not equal.

Definition at line 60 of file item.cpp.

operator<<()

QDebug LC::Util::XDG::operator<<	(	QDebug	stream,
		const Item &	item
	)

Serializes item contents to the debugging stream.

This function is provided for convenience to pretty-print contents of item to a debugging stream.

Parameters

[in]	stream	The debug stream to print to.
[in]	item	The XDG item to print.

Returns

The debugging stream with the contents of the item.

Definition at line 263 of file item.cpp.

References LC::Util::XDG::Item::DebugPrint().

Here is the call graph for this function:

operator==()

bool LC::Util::XDG::operator==	(	const Item &	left,
		const Item &	right
	)

The icon field obtained via GetIcon() is not checked for equality.

Parameters

[in]	left	First XDG item to check for equality.
[in]	right	Second XDG item to check for equality.

Returns

Whether left and right are equal.

Definition at line 47 of file item.cpp.

ToPaths()

UTIL_XDG_API QStringList LC::Util::XDG::ToPaths

(

const QList< Type > &

types

)

Returns a set of typical directories with desktop files of the given types.

Parameters

[in]

types

The types of the interesting .desktop files.

Returns

The list of the directories where the said files typically reside.

Definition at line 85 of file itemtypes.cpp.

References LC::Util::ConcatMap().

Here is the call graph for this function:

Variable Documentation

Item

class UTIL_XDG_API LC::Util::XDG::Item

Definition at line 44 of file itemsfinder.h.

ItemsFinder

class UTIL_XDG_API LC::Util::XDG::ItemsFinder

Definition at line 44 of file xdgfwd.h.