1
/*********************************************************
2
* Copyright (C) 2009 VMware, Inc. All rights reserved.
4
* This program is free software; you can redistribute it and/or modify it
5
* under the terms of the GNU Lesser General Public License as published
6
* by the Free Software Foundation version 2.1 and no later version.
8
* This program is distributed in the hope that it will be useful, but
9
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
10
* or FITNESS FOR A PARTICULAR PURPOSE. See the Lesser GNU General Public
11
* License for more details.
13
* You should have received a copy of the GNU Lesser General Public License
14
* along with this program; if not, write to the Free Software Foundation, Inc.,
15
* 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
17
*********************************************************/
19
#ifndef _DESKTOPEVENTS_H_
20
#define _DESKTOPEVENTS_H_
23
* @file desktopevents.h
25
* Public interface for the "switchUser" plugin. This plugin exposes some
26
* user session-related events to other plugins.
28
* Aside from the functionality exposed in this file, the plugin also
29
* emits the TOOLS_CORE_SIG_SESSION_CHANGE signal (which is handled
30
* by vmtoolsd automatically when it's run from within the SCM;
33
* Currently the plugin is only available on Win32.
35
* @addtogroup vmtools_plugins
42
* Signal sent when a "desktop switch" event is detected.
44
* Defined in desktopevents.h.
46
* @param[in] src The source object.
47
* @param[in] ctx ToolsAppCtx *: the application context.
48
* @param[in] data Client data.
50
#define TOOLS_CORE_SIG_DESKTOP_SWITCH "tcs_desktop_switch"
54
* Name of the message that can be sent to the desktop events window to
55
* shut down the vmusr instance.
57
#define DESKTOP_EVENTS_SHUTDOWN "VMdesktopEventsShutdownMsg"
62
* Signal emitted upon SmcCallbacks::save_yourself.
64
* @param[in] src The source object.
65
* @param[in] ctx ToolsAppCtx *: the application context.
66
* @parma[in] saveType Refer to SMlib.xml.
67
* @param[in] shutdown 0 = checkpoint, 1 = shutdown.
68
* @param[in] interactStyle May interact with user?
69
* @param[in] fast Shutdown as quickly as possible.
70
* @param[in] data Client data.
72
#define TOOLS_CORE_SIG_XSM_SAVE_YOURSELF "tcs_de_xsm_save_yourself"
75
* Signal emitted upon SmcCallbacks::die.
77
* @param[in] src The source object.
78
* @param[in] ctx ToolsAppCtx *: the application context.
79
* @param[in] data Client data.
81
#define TOOLS_CORE_SIG_XSM_DIE "tcs_de_xsm_die"
84
* Signal emitted upon SmcCallbacks::save_complete.
86
* @param[in] src The source object.
87
* @param[in] ctx ToolsAppCtx *: the application context.
88
* @param[in] data Client data.
90
#define TOOLS_CORE_SIG_XSM_SAVE_COMPLETE "tcs_de_xsm_save_complete"
93
* Signal emitted upon SmcCallbacks::shutdown_cancelled.
95
* @param[in] src The source object.
96
* @param[in] ctx ToolsAppCtx *: the application context.
97
* @param[in] data Client data.
99
#define TOOLS_CORE_SIG_XSM_SHUTDOWN_CANCELLED "tcs_de_xsm_shutdown_cancelled"
101
#endif // if defined(_WIN32)
105
#endif /* _DESKTOPEVENTS_H_ */