desktopitem.h File Reference

Functions for managing .desktop files. More...

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

Include dependency graph for desktopitem.h:

Go to the source code of this file.

Defines
#define	PURPLE_TYPE_DESKTOP_ITEM   (purple_desktop_item_get_type ())
#define	PURPLE_DESKTOP_ITEM_ENCODING   "Encoding"
#define	PURPLE_DESKTOP_ITEM_VERSION   "Version"
#define	PURPLE_DESKTOP_ITEM_NAME   "Name"
#define	PURPLE_DESKTOP_ITEM_GENERIC_NAME   "GenericName"
#define	PURPLE_DESKTOP_ITEM_TYPE   "Type"
#define	PURPLE_DESKTOP_ITEM_FILE_PATTERN   "FilePattern"
#define	PURPLE_DESKTOP_ITEM_TRY_EXEC   "TryExec"
#define	PURPLE_DESKTOP_ITEM_NO_DISPLAY   "NoDisplay"
#define	PURPLE_DESKTOP_ITEM_COMMENT   "Comment"
#define	PURPLE_DESKTOP_ITEM_EXEC   "Exec"
#define	PURPLE_DESKTOP_ITEM_ACTIONS   "Actions"
#define	PURPLE_DESKTOP_ITEM_ICON   "Icon"
#define	PURPLE_DESKTOP_ITEM_MINI_ICON   "MiniIcon"
#define	PURPLE_DESKTOP_ITEM_HIDDEN   "Hidden"
#define	PURPLE_DESKTOP_ITEM_PATH   "Path"
#define	PURPLE_DESKTOP_ITEM_TERMINAL   "Terminal"
#define	PURPLE_DESKTOP_ITEM_TERMINAL_OPTIONS   "TerminalOptions"
#define	PURPLE_DESKTOP_ITEM_SWALLOW_TITLE   "SwallowTitle"
#define	PURPLE_DESKTOP_ITEM_SWALLOW_EXEC   "SwallowExec"
#define	PURPLE_DESKTOP_ITEM_MIME_TYPE   "MimeType"
#define	PURPLE_DESKTOP_ITEM_PATTERNS   "Patterns"
#define	PURPLE_DESKTOP_ITEM_DEFAULT_APP   "DefaultApp"
#define	PURPLE_DESKTOP_ITEM_DEV   "Dev"
#define	PURPLE_DESKTOP_ITEM_FS_TYPE   "FSType"
#define	PURPLE_DESKTOP_ITEM_MOUNT_POINT   "MountPoint"
#define	PURPLE_DESKTOP_ITEM_READ_ONLY   "ReadOnly"
#define	PURPLE_DESKTOP_ITEM_UNMOUNT_ICON   "UnmountIcon"
#define	PURPLE_DESKTOP_ITEM_SORT_ORDER   "SortOrder"
#define	PURPLE_DESKTOP_ITEM_URL   "URL"
#define	PURPLE_DESKTOP_ITEM_DOC_PATH   "X-GNOME-DocPath"
Typedefs
typedef _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, 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.
PurpleDesktopItemType	purple_desktop_item_get_entry_type (const PurpleDesktopItem *item)
	Gets the type attribute (the 'Type' field) of the item.
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.
PurpleDesktopItem *	purple_desktop_item_copy (const PurpleDesktopItem *item)
	Creates a copy of a PurpleDesktopItem.
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.

---

Detailed Description

Functions for managing .desktop files.

Definition in file desktopitem.h.

---

Enumeration Type Documentation

enum PurpleDesktopItemType

Enumerator:

PURPLE_DESKTOP_ITEM_TYPE_NULL
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

Definition at line 64 of file desktopitem.h.

---

Function Documentation

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

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.

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.

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.

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