include/mce/dbus-names.h File Reference

DBus Interface to the Mode Control Entity. More...

Go to the source code of this file.

Defines

#define MCE_SERVICE   "com.nokia.mce"
 The MCE DBus service.
#define MCE_REQUEST_IF   "com.nokia.mce.request"
 The MCE DBus Request interface.
#define MCE_SIGNAL_IF   "com.nokia.mce.signal"
 The MCE DBus Signal interface.
#define MCE_REQUEST_PATH   "/com/nokia/mce/request"
 The MCE DBus Request path.
#define MCE_SIGNAL_PATH   "/com/nokia/mce/signal"
 The MCE DBus Signal path.
#define MCE_ERROR_FATAL   "com.nokia.mce.error.fatal"
 The MCE DBus error interface; currently not used.
#define MCE_ERROR_INVALID_ARGS   "org.freedesktop.DBus.Error.InvalidArgs"
 The DBus interface for invalid arguments; currently not used.
#define MCE_DEVICE_MODE_GET   "get_device_mode"
 Request device mode.
#define MCE_DEVLOCK_MODE_GET   "get_devicelock_mode"
 Request device lock mode.
#define MCE_TKLOCK_MODE_GET   "get_tklock_mode"
 Request touchscreen/keypad lock mode.
#define MCE_DISPLAY_STATUS_GET   "get_display_status"
 Request display status.
#define MCE_INACTIVITY_STATUS_GET   "get_inactivity_status"
 Request inactivity status.
#define MCE_VERSION_GET   "get_version"
 Request MCE version.
#define MCE_DISPLAY_ON_REQ   "req_display_state_on"
 Unblank display.
#define MCE_PREVENT_BLANK_REQ   "req_display_blanking_pause"
 Prevent display from blanking.
#define MCE_DEVICE_MODE_CHANGE_REQ   "req_device_mode_change"
 Request device mode change.
#define MCE_TKLOCK_MODE_CHANGE_REQ   "req_tklock_mode_change"
 Request tklock mode change.
#define MCE_TRIGGER_POWERKEY_EVENT_REQ   "req_trigger_powerkey_event"
 Request powerkey event triggering.
#define MCE_POWERUP_REQ   "req_powerup"
 Request powerup.
#define MCE_REBOOT_REQ   "req_reboot"
 Request reboot.
#define MCE_SHUTDOWN_REQ   "req_shutdown"
 Request shutdown.
#define MCE_DEVLOCK_VALIDATE_CODE_REQ   "validate_devicelock_code"
 Validate device lock code.
#define MCE_DEVLOCK_CHANGE_CODE_REQ   "change_devicelock_code"
 Change device lock code.
#define MCE_ALARM_MODE_CHANGE_REQ   "set_alarm_mode"
 Set alarm mode.
#define MCE_SHUTDOWN_SIG   "shutdown_ind"
 Notify everyone that the system is about to shut down.
#define MCE_THERMAL_SHUTDOWN_SIG   "thermal_shutdown_ind"
 Notify everyone that the system is about to shut down due to thermal constraints.
#define MCE_DEVLOCK_MODE_SIG   "devicelock_mode_ind"
 Signal that indicates that the device lock mode has changed.
#define MCE_TKLOCK_MODE_SIG   "tklock_mode_ind"
 Signal that indicates that the touchscreen/keypad lock mode has changed.
#define MCE_DATA_SAVE_SIG   "save_unsaved_data_ind"
 Notify everyone to save unsaved data.
#define MCE_DISPLAY_SIG   "display_status_ind"
 Notify everyone that the display is on/dimmed/off.
#define MCE_INACTIVITY_SIG   "system_inactivity_ind"
 Notify everyone that the system is active/inactive.
#define MCE_DEVICE_MODE_SIG   "sig_device_mode_ind"
 Notify everyone that the device mode has changed.
#define MCE_HOME_KEY_SIG   "sig_home_key_pressed_ind"
 Notify everyone that the home button was pressed (short press).
#define MCE_HOME_KEY_LONG_SIG   "sig_home_key_pressed_long_ind"
 Notify everyone that the home button was pressed (long press).
#define MCE_ACTIVATE_LED_PATTERN   "req_led_pattern_activate"
 Activates a pre-defined LED pattern Non-existing patterns are ignored.
#define MCE_DEACTIVATE_LED_PATTERN   "req_led_pattern_deactivate"
 Deactivates a pre-defined LED pattern Non-existing patterns are ignored.
#define MCE_ENABLE_LED   "req_led_enable"
 Enable LED; this does not affect the LED pattern stack Note: The GConf setting for LED flashing overrides this value If the pattern stack does not contain any active patterns, the LED logic will still remain in enabled mode, but will not display any patterns until a pattern is activated.
#define MCE_DISABLE_LED   "req_led_disable"
 Disable LED; this does not affect the LED pattern stack.


Detailed Description

DBus Interface to the Mode Control Entity.

This file is part of mce-dev

Copyright (C) 2004-2006 Nokia Corporation.

Author:
David Weinehall <david.weinehall@nokia.com>
These headers are free software; you can redistribute them and/or modify them under the terms of the GNU Lesser General Public License version 2.1 as published by the Free Software Foundation.

These headers are distributed in the hope that they will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this software; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA


Define Documentation

#define MCE_ACTIVATE_LED_PATTERN   "req_led_pattern_activate"

Activates a pre-defined LED pattern Non-existing patterns are ignored.

Since:
v1.5.0
Parameters:
pattern dbus_string_t with the pattern name (see /etc/mce/mce.ini for valid pattern names)

#define MCE_ALARM_MODE_CHANGE_REQ   "set_alarm_mode"

Set alarm mode.

Since:
v0.9.10
Parameters:
mode dbus_string_t with the new alarm mode (see mce/mode-names.h for valid alarm modes)

#define MCE_DATA_SAVE_SIG   "save_unsaved_data_ind"

Notify everyone to save unsaved data.

Since:
v0.3

#define MCE_DEACTIVATE_LED_PATTERN   "req_led_pattern_deactivate"

Deactivates a pre-defined LED pattern Non-existing patterns are ignored.

Since:
v1.5.0
Parameters:
pattern dbus_string_t with the pattern name (see /etc/mce/mce.ini for valid pattern names)

#define MCE_DEVICE_MODE_CHANGE_REQ   "req_device_mode_change"

Request device mode change.

Since:
v0.5
Parameters:
mode dbus_string_t with the new device mode (see mce/mode-names.h for valid device modes)

#define MCE_DEVICE_MODE_GET   "get_device_mode"

Request device mode.

Since:
v0.5.3
Returns:
dbus_string_t with the device mode (see mce/mode-names.h for valid device modes)

#define MCE_DEVICE_MODE_SIG   "sig_device_mode_ind"

Notify everyone that the device mode has changed.

Since:
v0.5
Returns:
dbus_string_t with the new device mode (see mce/mode-names.h for valid device modes)

#define MCE_DEVLOCK_CHANGE_CODE_REQ   "change_devicelock_code"

Change device lock code.

Since:
v1.5.0
Parameters:
code dbus_string_t with the old encrypted password from crypt(3)
salt dbus_string_t with the old salt used with crypt(3)
newcode dbus_string_t with the new password in plaintext
Returns:
dbus_bool_t TRUE if the lock code was modified, FALSE if the lock code was not modified

#define MCE_DEVLOCK_MODE_GET   "get_devicelock_mode"

Request device lock mode.

Since:
v0.8.0
Returns:
dbus_string_t with the device lock mode (see mce/mode-names.h for valid lock modes)

#define MCE_DEVLOCK_MODE_SIG   "devicelock_mode_ind"

Signal that indicates that the device lock mode has changed.

Since:
v0.8.0
Returns:
dbus_string_t with the new device lock mode (see mce/mode-names.h for valid lock modes)

#define MCE_DEVLOCK_VALIDATE_CODE_REQ   "validate_devicelock_code"

Validate device lock code.

Since:
v0.9.10
Parameters:
code dbus_string_t with the encrypted password from crypt(3)
salt dbus_string_t with the salt used with crypt(3)
Returns:
dbus_bool_t TRUE if the lock code is correct, FALSE if the lock code is incorrect

#define MCE_DISABLE_LED   "req_led_disable"

Disable LED; this does not affect the LED pattern stack.

Since:
v1.5.0

#define MCE_DISPLAY_ON_REQ   "req_display_state_on"

Unblank display.

Since:
v0.5

#define MCE_DISPLAY_SIG   "display_status_ind"

Notify everyone that the display is on/dimmed/off.

Since:
v1.5.21
Returns:
dbus_string_t with the display state (see mce/mode-names.h for valid display states)

#define MCE_DISPLAY_STATUS_GET   "get_display_status"

Request display status.

Since:
v1.5.21
Returns:
dbus_string_t with the display state (see mce/mode-names.h for valid display states)

#define MCE_ENABLE_LED   "req_led_enable"

Enable LED; this does not affect the LED pattern stack Note: The GConf setting for LED flashing overrides this value If the pattern stack does not contain any active patterns, the LED logic will still remain in enabled mode, but will not display any patterns until a pattern is activated.

Since:
v1.5.0

#define MCE_HOME_KEY_LONG_SIG   "sig_home_key_pressed_long_ind"

Notify everyone that the home button was pressed (long press).

Since:
v0.3

#define MCE_HOME_KEY_SIG   "sig_home_key_pressed_ind"

Notify everyone that the home button was pressed (short press).

Since:
v0.3

#define MCE_INACTIVITY_SIG   "system_inactivity_ind"

Notify everyone that the system is active/inactive.

Since:
v0.9.3
Returns:
dbus_bool_t TRUE if the system is inactive, FALSE if the system is active

#define MCE_INACTIVITY_STATUS_GET   "get_inactivity_status"

Request inactivity status.

Since:
v1.5.2
Returns:
dbus_bool_t TRUE if the system is inactive, FALSE if the system is active

#define MCE_POWERUP_REQ   "req_powerup"

Request powerup.

Since:
v0.5

#define MCE_PREVENT_BLANK_REQ   "req_display_blanking_pause"

Prevent display from blanking.

Since:
v0.5

#define MCE_REBOOT_REQ   "req_reboot"

Request reboot.

Since:
v0.5.5

#define MCE_SHUTDOWN_REQ   "req_shutdown"

Request shutdown.

Since:
v0.5

#define MCE_SHUTDOWN_SIG   "shutdown_ind"

Notify everyone that the system is about to shut down.

Since:
v0.4.1

#define MCE_THERMAL_SHUTDOWN_SIG   "thermal_shutdown_ind"

Notify everyone that the system is about to shut down due to thermal constraints.

Since:
v1.5.4

#define MCE_TKLOCK_MODE_CHANGE_REQ   "req_tklock_mode_change"

Request tklock mode change.

Since:
v1.4.0
Parameters:
mode dbus_string_t with the new touchscreen/keypad lock mode (see mce/mode-names.h for valid lock modes)

#define MCE_TKLOCK_MODE_GET   "get_tklock_mode"

Request touchscreen/keypad lock mode.

Since:
v1.4.0
Returns:
dbus_string_t with the touchscreen/keypad lock mode (see mce/mode-names.h for valid lock modes)

#define MCE_TKLOCK_MODE_SIG   "tklock_mode_ind"

Signal that indicates that the touchscreen/keypad lock mode has changed.

Since:
v1.4.0
Returns:
dbus_string_t with the new touchscreen/keypad lock mode (see mce/mode-names.h for valid lock modes)

#define MCE_TRIGGER_POWERKEY_EVENT_REQ   "req_trigger_powerkey_event"

Request powerkey event triggering.

Since:
v1.5.3
Parameters:
longpress dbus_bool_t with the type of powerkey event to trigger; FALSE == short powerkey press, TRUE == long powerkey press

#define MCE_VERSION_GET   "get_version"

Request MCE version.

Since:
v1.1.6
Returns:
dbus_string_t with the MCE version


Generated on Sat May 3 09:37:00 2008 for MCE (DBus Interface) by  doxygen 1.5.5