desktopitem.h File Reference

Functions for managing .desktop files. More...

#include <glib.h>
#include <glib-object.h>

Go to the source code of this file.

Macros
#define	PURPLE_TYPE_DESKTOP_ITEM   (purple_desktop_item_get_type ())
#define	PURPLE_DESKTOP_ITEM_ENCODING   "Encoding" /* string */
#define	PURPLE_DESKTOP_ITEM_VERSION   "Version" /* numeric */
#define	PURPLE_DESKTOP_ITEM_NAME   "Name" /* localestring */
#define	PURPLE_DESKTOP_ITEM_GENERIC_NAME   "GenericName" /* localestring */
#define	PURPLE_DESKTOP_ITEM_TYPE   "Type" /* string */
#define	PURPLE_DESKTOP_ITEM_FILE_PATTERN   "FilePattern" /* regexp(s) */
#define	PURPLE_DESKTOP_ITEM_TRY_EXEC   "TryExec" /* string */
#define	PURPLE_DESKTOP_ITEM_NO_DISPLAY   "NoDisplay" /* boolean */
#define	PURPLE_DESKTOP_ITEM_COMMENT   "Comment" /* localestring */
#define	PURPLE_DESKTOP_ITEM_EXEC   "Exec" /* string */
#define	PURPLE_DESKTOP_ITEM_ACTIONS   "Actions" /* strings */
#define	PURPLE_DESKTOP_ITEM_ICON   "Icon" /* string */
#define	PURPLE_DESKTOP_ITEM_MINI_ICON   "MiniIcon" /* string */
#define	PURPLE_DESKTOP_ITEM_HIDDEN   "Hidden" /* boolean */
#define	PURPLE_DESKTOP_ITEM_PATH   "Path" /* string */
#define	PURPLE_DESKTOP_ITEM_TERMINAL   "Terminal" /* boolean */
#define	PURPLE_DESKTOP_ITEM_TERMINAL_OPTIONS   "TerminalOptions" /* string */
#define	PURPLE_DESKTOP_ITEM_SWALLOW_TITLE   "SwallowTitle" /* string */
#define	PURPLE_DESKTOP_ITEM_SWALLOW_EXEC   "SwallowExec" /* string */
#define	PURPLE_DESKTOP_ITEM_MIME_TYPE   "MimeType" /* regexp(s) */
#define	PURPLE_DESKTOP_ITEM_PATTERNS   "Patterns" /* regexp(s) */
#define	PURPLE_DESKTOP_ITEM_DEFAULT_APP   "DefaultApp" /* string */
#define	PURPLE_DESKTOP_ITEM_DEV   "Dev" /* string */
#define	PURPLE_DESKTOP_ITEM_FS_TYPE   "FSType" /* string */
#define	PURPLE_DESKTOP_ITEM_MOUNT_POINT   "MountPoint" /* string */
#define	PURPLE_DESKTOP_ITEM_READ_ONLY   "ReadOnly" /* boolean */
#define	PURPLE_DESKTOP_ITEM_UNMOUNT_ICON   "UnmountIcon" /* string */
#define	PURPLE_DESKTOP_ITEM_SORT_ORDER   "SortOrder" /* strings */
#define	PURPLE_DESKTOP_ITEM_URL   "URL" /* string */
#define	PURPLE_DESKTOP_ITEM_DOC_PATH   "X-GNOME-DocPath" /* string */

Typedefs
typedef struct _PurpleDesktopItem	PurpleDesktopItem

Enumerations
enum	PurpleDesktopItemType {   PURPLE_DESKTOP_ITEM_TYPE_NULL = 0 , PURPLE_DESKTOP_ITEM_TYPE_OTHER , PURPLE_DESKTOP_ITEM_TYPE_APPLICATION , PURPLE_DESKTOP_ITEM_TYPE_LINK ,   PURPLE_DESKTOP_ITEM_TYPE_FSDEVICE , PURPLE_DESKTOP_ITEM_TYPE_MIME_TYPE , PURPLE_DESKTOP_ITEM_TYPE_DIRECTORY , PURPLE_DESKTOP_ITEM_TYPE_SERVICE ,   PURPLE_DESKTOP_ITEM_TYPE_SERVICE_TYPE }

Functions
GType	purple_desktop_item_get_type (void)
PurpleDesktopItem *	purple_desktop_item_new_from_file (const char *filename)
	This function loads 'filename' and turns it into a PurpleDesktopItem. More...
PurpleDesktopItemType	purple_desktop_item_get_entry_type (const PurpleDesktopItem *item)
	Gets the type attribute (the 'Type' field) of the item. More...
const char *	purple_desktop_item_get_string (const PurpleDesktopItem *item, const char *attr)
	Gets the value of an attribute of the item, as a string. More...
PurpleDesktopItem *	purple_desktop_item_copy (const PurpleDesktopItem *item)
	Creates a copy of a PurpleDesktopItem. More...
void	purple_desktop_item_unref (PurpleDesktopItem *item)
	Decreases the reference count of the specified item, and destroys the item if there are no more references left. More...

Detailed Description

Functions for managing .desktop files.

Definition in file desktopitem.h.

Function Documentation

purple_desktop_item_copy()

PurpleDesktopItem* purple_desktop_item_copy

(

const PurpleDesktopItem *

item

)

Creates a copy of a PurpleDesktopItem.

The new copy has a refcount of 1. Note: Section stack is NOT copied.

Parameters

item	The item to be copied

Returns

The new copy

purple_desktop_item_get_entry_type()

PurpleDesktopItemType purple_desktop_item_get_entry_type

(

const PurpleDesktopItem *

item

)

Gets the type attribute (the 'Type' field) of the item.

This should usually be 'Application' for an application, but it can be 'Directory' for a directory description. There are other types available as well. The type usually indicates how the desktop item should be handeled and how the 'Exec' field should be handeled.

Parameters

item	A desktop item

Returns

The type of the specified 'item'. The returned memory remains owned by the PurpleDesktopItem and should not be freed.

purple_desktop_item_get_string()

const char* purple_desktop_item_get_string	(	const PurpleDesktopItem *	item,
		const char *	attr
	)

Gets the value of an attribute of the item, as a string.

Parameters

item	A desktop item
attr	The attribute to look for

Returns

The value of the specified item attribute.

purple_desktop_item_new_from_file()

PurpleDesktopItem* purple_desktop_item_new_from_file

(

const char *

filename

)

This function loads 'filename' and turns it into a PurpleDesktopItem.

Parameters

filename

The filename or directory path to load the PurpleDesktopItem from

Returns

The newly loaded item, or NULL on error.

purple_desktop_item_unref()

void purple_desktop_item_unref

(

PurpleDesktopItem *

item

)

Decreases the reference count of the specified item, and destroys the item if there are no more references left.

Parameters

item	A desktop item