2 * @file desktopitem.h Functions for managing .desktop files
6 /* Purple is the legal property of its developers, whose names are too numerous
7 * to list here. Please refer to the COPYRIGHT file distributed with this
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
27 * The following code has been adapted from gnome-desktop-item.[ch],
28 * as found on gnome-desktop-2.8.1.
30 * Copyright (C) 2004 by Alceste Scalas <alceste.scalas@gmx.net>.
32 * Original copyright notice:
34 * Copyright (C) 1999, 2000 Red Hat Inc.
35 * Copyright (C) 2001 Sid Vicious
36 * All rights reserved.
38 * This file is part of the Gnome Library.
40 * The Gnome Library is free software; you can redistribute it and/or
41 * modify it under the terms of the GNU Library General Public License as
42 * published by the Free Software Foundation; either version 2 of the
43 * License, or (at your option) any later version.
45 * The Gnome Library is distributed in the hope that it will be useful,
46 * but WITHOUT ANY WARRANTY; without even the implied warranty of
47 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
48 * Library General Public License for more details.
50 * You should have received a copy of the GNU Library General Public
51 * License along with the Gnome Library; see the file COPYING.LIB. If not,
52 * write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
53 * Boston, MA 02111-1301, USA.
56 #ifndef _PURPLE_DESKTOP_ITEM_H_
57 #define _PURPLE_DESKTOP_ITEM_H_
60 #include <glib-object.h>
65 PURPLE_DESKTOP_ITEM_TYPE_NULL = 0 /* This means its NULL, that is, not
67 PURPLE_DESKTOP_ITEM_TYPE_OTHER /* This means it's not one of the below
68 strings types, and you must get the
71 /* These are the standard compliant types: */
72 PURPLE_DESKTOP_ITEM_TYPE_APPLICATION,
73 PURPLE_DESKTOP_ITEM_TYPE_LINK,
74 PURPLE_DESKTOP_ITEM_TYPE_FSDEVICE,
75 PURPLE_DESKTOP_ITEM_TYPE_MIME_TYPE,
76 PURPLE_DESKTOP_ITEM_TYPE_DIRECTORY,
77 PURPLE_DESKTOP_ITEM_TYPE_SERVICE,
78 PURPLE_DESKTOP_ITEM_TYPE_SERVICE_TYPE
79 } PurpleDesktopItemType;
81 typedef struct _PurpleDesktopItem PurpleDesktopItem;
83 #define PURPLE_TYPE_DESKTOP_ITEM (purple_desktop_item_get_type ())
84 GType purple_desktop_item_get_type (void);
87 #define PURPLE_DESKTOP_ITEM_ENCODING "Encoding" /* string */
88 #define PURPLE_DESKTOP_ITEM_VERSION "Version" /* numeric */
89 #define PURPLE_DESKTOP_ITEM_NAME "Name" /* localestring */
90 #define PURPLE_DESKTOP_ITEM_GENERIC_NAME "GenericName" /* localestring */
91 #define PURPLE_DESKTOP_ITEM_TYPE "Type" /* string */
92 #define PURPLE_DESKTOP_ITEM_FILE_PATTERN "FilePattern" /* regexp(s) */
93 #define PURPLE_DESKTOP_ITEM_TRY_EXEC "TryExec" /* string */
94 #define PURPLE_DESKTOP_ITEM_NO_DISPLAY "NoDisplay" /* boolean */
95 #define PURPLE_DESKTOP_ITEM_COMMENT "Comment" /* localestring */
96 #define PURPLE_DESKTOP_ITEM_EXEC "Exec" /* string */
97 #define PURPLE_DESKTOP_ITEM_ACTIONS "Actions" /* strings */
98 #define PURPLE_DESKTOP_ITEM_ICON "Icon" /* string */
99 #define PURPLE_DESKTOP_ITEM_MINI_ICON "MiniIcon" /* string */
100 #define PURPLE_DESKTOP_ITEM_HIDDEN "Hidden" /* boolean */
101 #define PURPLE_DESKTOP_ITEM_PATH "Path" /* string */
102 #define PURPLE_DESKTOP_ITEM_TERMINAL "Terminal" /* boolean */
103 #define PURPLE_DESKTOP_ITEM_TERMINAL_OPTIONS "TerminalOptions" /* string */
104 #define PURPLE_DESKTOP_ITEM_SWALLOW_TITLE "SwallowTitle" /* string */
105 #define PURPLE_DESKTOP_ITEM_SWALLOW_EXEC "SwallowExec" /* string */
106 #define PURPLE_DESKTOP_ITEM_MIME_TYPE "MimeType" /* regexp(s) */
107 #define PURPLE_DESKTOP_ITEM_PATTERNS "Patterns" /* regexp(s) */
108 #define PURPLE_DESKTOP_ITEM_DEFAULT_APP "DefaultApp" /* string */
109 #define PURPLE_DESKTOP_ITEM_DEV "Dev" /* string */
110 #define PURPLE_DESKTOP_ITEM_FS_TYPE "FSType" /* string */
111 #define PURPLE_DESKTOP_ITEM_MOUNT_POINT "MountPoint" /* string */
112 #define PURPLE_DESKTOP_ITEM_READ_ONLY "ReadOnly" /* boolean */
113 #define PURPLE_DESKTOP_ITEM_UNMOUNT_ICON "UnmountIcon" /* string */
114 #define PURPLE_DESKTOP_ITEM_SORT_ORDER "SortOrder" /* strings */
115 #define PURPLE_DESKTOP_ITEM_URL "URL" /* string */
116 #define PURPLE_DESKTOP_ITEM_DOC_PATH "X-GNOME-DocPath" /* string */
119 * This function loads 'filename' and turns it into a PurpleDesktopItem.
121 * @param filename The filename or directory path to load the PurpleDesktopItem from
123 * @return The newly loaded item, or NULL on error.
125 PurpleDesktopItem *purple_desktop_item_new_from_file (const char *filename);
128 * Gets the type attribute (the 'Type' field) of the item. This should
129 * usually be 'Application' for an application, but it can be 'Directory'
130 * for a directory description. There are other types available as well.
131 * The type usually indicates how the desktop item should be handeled and
132 * how the 'Exec' field should be handeled.
134 * @param item A desktop item
136 * @return The type of the specified 'item'. The returned memory
137 * remains owned by the PurpleDesktopItem and should not be freed.
139 PurpleDesktopItemType purple_desktop_item_get_entry_type (const PurpleDesktopItem *item);
142 * Gets the value of an attribute of the item, as a string.
144 * @param item A desktop item
145 * @param attr The attribute to look for
147 * @return The value of the specified item attribute.
149 const char *purple_desktop_item_get_string (const PurpleDesktopItem *item,
153 * Creates a copy of a PurpleDesktopItem. The new copy has a refcount of 1.
154 * Note: Section stack is NOT copied.
156 * @param item The item to be copied
158 * @return The new copy
160 PurpleDesktopItem *purple_desktop_item_copy (const PurpleDesktopItem *item);
163 * Decreases the reference count of the specified item, and destroys
164 * the item if there are no more references left.
166 * @param item A desktop item
168 void purple_desktop_item_unref (PurpleDesktopItem *item);
172 #endif /* _PURPLE_DESKTOP_ITEM_H_ */