~cairo-dock-team/ubuntu/oneiric/cairo-dock/2.3.0-3

« back to all changes in this revision

Viewing changes to src/gldit/cairo-dock-launcher-manager.h

  • Committer: Bazaar Package Importer
  • Author(s): Matthieu Baerts (matttbe)
  • Date: 2010-08-09 23:26:12 UTC
  • mto: This revision was merged to the branch mainline in revision 13.
  • Revision ID: james.westby@ubuntu.com-20100809232612-pocdxliaxjdetm37
Tags: upstream-2.2.0~0beta4
ImportĀ upstreamĀ versionĀ 2.2.0~0beta4

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/*
 
2
* This file is a part of the Cairo-Dock project
 
3
*
 
4
* Copyright : (C) see the 'copyright' file.
 
5
* E-mail    : see the 'copyright' file.
 
6
*
 
7
* This program is free software; you can redistribute it and/or
 
8
* modify it under the terms of the GNU General Public License
 
9
* as published by the Free Software Foundation; either version 3
 
10
* of the License, or (at your option) any later version.
 
11
*
 
12
* This program is distributed in the hope that it will be useful,
 
13
* but WITHOUT ANY WARRANTY; without even the implied warranty of
 
14
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
15
* GNU General Public License for more details.
 
16
* You should have received a copy of the GNU General Public License
 
17
* along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
18
*/
 
19
 
 
20
 
 
21
#ifndef __CAIRO_DOCK_LAUNCHER_MANAGER__
 
22
#define  __CAIRO_DOCK_LAUNCHER_MANAGER__
 
23
 
 
24
#include <glib.h>
 
25
 
 
26
#include "cairo-dock-struct.h"
 
27
G_BEGIN_DECLS
 
28
 
 
29
/** *@file cairo-dock-launcher-manager.h This class handles the creation, load and reload of launcher icons, from the desktop files contained inside the 'launchers' folder. The files holding the information are common desktop files, with additionnal keys added by the dock on the launcher creation.
 
30
*/
 
31
 
 
32
/** Create an Icon from a given desktop file, and fill its buffers. The resulting icon can directly be used inside a container. Class inhibating is handled.
 
33
* @param cDesktopFileName name of the desktop file, present in the "launchers" folder of the current theme.
 
34
* @return the newly created icon.
 
35
*/
 
36
Icon * cairo_dock_create_icon_from_desktop_file (const gchar *cDesktopFileName);
 
37
 
 
38
/** Create an Icon that will behave like a launcher. It's especially useful for applets that want to fill a sub-dock or a desklet (the icon is not loaded by the function). Be careful that the strings are not duplicated. Therefore, you must use g_strdup() if you want to set a constant string; and must not free the strings after calling this function.
 
39
* @param cName label of the icon
 
40
* @param cFileName name of an image
 
41
* @param cCommand a command, or NULL
 
42
* @param cQuickInfo a quick-info, or NULL
 
43
* @param fOrder order of the icon in its container.
 
44
* @return the newly created icon.
 
45
*/
 
46
Icon * cairo_dock_create_dummy_launcher (gchar *cName, gchar *cFileName, gchar *cCommand, gchar *cQuickInfo, double fOrder);
 
47
 
 
48
 
 
49
/** Load a set of .desktop files that define icons, and build the corresponding tree of docks.
 
50
* All the icons are created and placed inside their dock, which is created if necessary.
 
51
* @param cDirectory a folder containing some .desktop files.
 
52
*/
 
53
void cairo_dock_build_docks_tree_with_desktop_files (const gchar *cDirectory);
 
54
 
 
55
 
 
56
/** Reload completely a launcher. It handles all the side-effects like modifying the class, the sub-dock's view, the container, etc.
 
57
* @param icon the launcher Icon to reload.
 
58
*/
 
59
void cairo_dock_reload_launcher (Icon *icon);
 
60
 
 
61
 
 
62
gchar *cairo_dock_launch_command_sync (const gchar *cCommand);
 
63
 
 
64
gboolean cairo_dock_launch_command_printf (const gchar *cCommandFormat, gchar *cWorkingDirectory, ...) G_GNUC_PRINTF (1, 3);
 
65
gboolean cairo_dock_launch_command_full (const gchar *cCommand, gchar *cWorkingDirectory);
 
66
#define cairo_dock_launch_command(cCommand) cairo_dock_launch_command_full (cCommand, NULL)
 
67
 
 
68
G_END_DECLS
 
69
#endif