summaryrefslogtreecommitdiffstats
path: root/kinit/README.DCOP
blob: 43f951226ad4a07432ddf67aa704564dfaaaa0ac (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
"KLauncher" supports the following DCOP functions:

/**
 * Starts a program.
 * 'envs' are environment variables that will be added
 *   to this program's environment before starting it
 * 'startup_id' is for application startup notification,
 * "" is the default, "0" for none
 */
void exec_blind(QCString name, QValueList<QCString> argList,
    QValueList<QCString> envs, QCString startup_id );
void exec_blind(QCString name, QValueList<QCString> argList);

/**
 * Start a service by name.
 *
 * 'serviceName' refers to the service name as given by 
 * the Name field in the desktop file describing the service.
 *
 * 'url', if not empty, will be passed to the service as
 * argument.
 *
 * 'envs' are environment variables that will be added
 *   to this program's environment before starting it
 *
 * 'startup_id' is for application startup notification,
 * "" is the default, "0" for none
 */
serviceResult start_service_by_name(QString serviceName, QStringList url,
    QValueList<QCString> envs, QCString startup_id );
serviceResult start_service_by_name(QString serviceName, QStringList url)

/**
 * Start a service by desktop path.
 *
 * 'serviceName' refers to a desktop file describing the service.
 * This may be an absolute path or a path relative to $KDEDIRS/applnk
 * and/or $KDEDIRS/services
 * E.g. it should have the form "Applications/korganizer.desktop" or
 * "/opt/kde/share/applnk/Applications/korganizer.desktop".
 *
 * 'url', if not empty, will be passed to the service as
 * argument.
 *
 * 'envs' are environment variables that will be added
 *   to this program's environment before starting it
 *
 * 'startup_id' is for application startup notification,
 * "" is the default, "0" for none
 */
serviceResult start_service_by_desktop_path(QString serviceName, QStringList url,
    QValueList<QCString> envs, QCString startup_id );
serviceResult start_service_by_desktop_path(QString serviceName, QStringList url)


/**
 * Start a service by desktop name.
 *
 * 'serviceName' refers to a desktop file describing the service.
 * The service is looked up anywhere in $KDEDIR/applnk and/or
 * $KDEDIR/services.
 * E.g. it should have the form "korganizer".
 *
 * 'url', if not empty, will be passed to the service as
 * argument.
 *
 * 'envs' are environment variables that will be added
 *   to this program's environment before starting it
 *
 * 'startup_id' is for application startup notification,
 * "" is the default, "0" for none
 */
serviceResult start_service_by_desktop_name(QString serviceName, QStringList url,
    QValueList<QCString> envs, QCString startup_id );
serviceResult start_service_by_desktop_name(QString serviceName, QStringList url)

struct serviceResult
{
  int result;         // 0 means success. > 0 means error
  QCString dcopName; // Contains DCOP name on success
  QString error;     // Contains error description on failure.
}