include/mce/dbus-names.h File Reference

D-Bus Interface to the Mode Control Entity. More...

Go to the source code of this file.

Defines

D-Bus Daemon
#define MCE_SERVICE   "com.nokia.mce"
 MCE D-Bus service.
#define MCE_REQUEST_IF   "com.nokia.mce.request"
 MCE D-Bus Request interface.
#define MCE_SIGNAL_IF   "com.nokia.mce.signal"
 MCE D-Bus Signal interface.
#define MCE_REQUEST_PATH   "/com/nokia/mce/request"
 MCE D-Bus Request path.
#define MCE_SIGNAL_PATH   "/com/nokia/mce/signal"
 MCE D-Bus Signal path.
#define MCE_ERROR_FATAL   "com.nokia.mce.error.fatal"
 The MCE D-Bus error interface; currently not used.
#define MCE_ERROR_INVALID_ARGS   "org.freedesktop.DBus.Error.InvalidArgs"
 The D-Bus interface for invalid arguments; currently not used.
Generic D-Bus methods
#define MCE_DEVICE_MODE_GET   "get_device_mode"
 Query the device mode.
#define MCE_CALL_STATE_GET   "get_call_state"
 Query the call state.
#define MCE_DEVLOCK_MODE_GET   "get_devicelock_mode"
 Query the device lock mode.
#define MCE_TKLOCK_MODE_GET   "get_tklock_mode"
 Query the touchscreen/keypad lock mode.
#define MCE_DISPLAY_STATUS_GET   "get_display_status"
 Query the display status.
#define MCE_CABC_MODE_GET   "get_cabc_mode"
 Query CABC mode.
#define MCE_INACTIVITY_STATUS_GET   "get_inactivity_status"
 Query the inactivity status.
#define MCE_DEVICE_ORIENTATION_GET   "get_device_orientation"
 Query the device orientation information.
#define MCE_VERSION_GET   "get_version"
 Query the MCE version.
#define MCE_DISPLAY_ON_REQ   "req_display_state_on"
 Unblank display.
#define MCE_DISPLAY_DIM_REQ   "req_display_state_dim"
 Dim display.
#define MCE_DISPLAY_OFF_REQ   "req_display_state_off"
 Blank display.
#define MCE_PREVENT_BLANK_REQ   "req_display_blanking_pause"
 Prevent display from blanking.
#define MCE_PREVENT_KEYPAD_OFF_REQ   "req_keypad_off_pause"
 Prevent keypad off.
#define MCE_CABC_MODE_REQ   "req_cabc_mode"
 Request CABC mode change.
#define MCE_DEVICE_MODE_CHANGE_REQ   "req_device_mode_change"
 Request device mode change.
#define MCE_CALL_STATE_CHANGE_REQ   "req_call_state_change"
 Request call state change Changes can only be made to/from the "none" state; all other transitions will be vetoed.
#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_ACCELEROMETER_ENABLE_REQ   "req_accelerometer_enable"
 Request to enable accelerometer.
#define MCE_ACCELEROMETER_DISABLE_REQ   "req_accelerometer_disable"
 Request to disable accelerometer.
Generic D-Bus signals
#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_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_CALL_STATE_SIG   "sig_call_state_ind"
 Notify everyone that the call state 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_DEVICE_ORIENTATION_SIG   "sig_device_orientation_ind"
 Notify everyone that the device orientation has changed Note that this message is sent only if there is at least one active listener.
LED interface D-Bus methods
#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.
Vibrator interface D-Bus methods
#define MCE_ACTIVATE_VIBRATOR_PATTERN   "req_vibrator_pattern_activate"
 Activates a pre-defined vibrator pattern Non-existing patterns are ignored.
#define MCE_DEACTIVATE_VIBRATOR_PATTERN   "req_vibrator_pattern_deactivate"
 Deactivates a pre-defined vibrator pattern Non-existing patterns are ignored.
#define MCE_ENABLE_VIBRATOR   "req_vibrator_enable"
 Enable vibrator; this does not affect the vibrator pattern stack Note: The profile settings for vibrator overrides this value If the pattern stack does not contain any active patterns, the vibrator logic will still remain in enabled mode, but will not display any patterns until a pattern is activated.
#define MCE_DISABLE_VIBRATOR   "req_vibrator_disable"
 Disable vibrator; this does not affect the vibrator pattern stack.
#define MCE_START_MANUAL_VIBRATION   "req_start_manual_vibration"
 Activate user defined vibrator pattern.
#define MCE_STOP_MANUAL_VIBRATION   "req_stop_manual_vibration"
 Stop manual vibration pattern before duration is expired.
#define MCE_KEYBOARD_STATUS_GET   "get_keyboard_status"
 Query the keyboard backlight status.


Detailed Description

D-Bus Interface to the Mode Control Entity.

This file is part of mce-dev

Copyright © 2004-2009 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_ACCELEROMETER_DISABLE_REQ   "req_accelerometer_disable"

Request to disable accelerometer.

If we have at least one active listener, device orientation change messages are broadcasted with MCE_DEVICE_ORIENTATION_SIG. If no listeners exist, then accelerometer is disabled and no messages are sent.

Since:
v1.8.14

#define MCE_ACCELEROMETER_ENABLE_REQ   "req_accelerometer_enable"

Request to enable accelerometer.

If we have at least one active listener, device orientation change messages are broadcasted with MCE_DEVICE_ORIENTATION_SIG. If no listeners exist, then accelerometer is disabled and no messages are sent. If this request message indicates reply requested (dbus_no_reply is set FALSE), then reply message is sent with current orientation. This eliminates the need for separate MCE_DEVICE_ORIENTATION_GET when starting listening orientation. When application no more needs the orientation information it should send MCE_ACCELEROMETER_DISABLE_REQ.

Returns:
gchar * portrait/landscape orientation (see mce/mode-names.h for valid portrait/landscape states)

gchar * on/off stand (see mce/mode-names.h for valid stand states)

gchar * face up/face down (see mce/mode-names.h for valid facing states)

dbus_int32_t x axis (unit mG)

dbus_int32_t y axis (unit mG)

dbus_int32_t z axis (unit mG)

Since:
v1.8.14

#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 gchar * with the pattern name (see /etc/mce/mce.ini for valid pattern names)

#define MCE_ACTIVATE_VIBRATOR_PATTERN   "req_vibrator_pattern_activate"

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

Since:
v1.8.0
Parameters:
pattern gchar * with the pattern name (see /etc/mce/mce.ini for valid pattern names)

#define MCE_CABC_MODE_GET   "get_cabc_mode"

Query CABC mode.

Since:
v1.8.13
Returns:
gchar * with the CABC mode (see mce/mode-names.h for valid CABC modes)

#define MCE_CABC_MODE_REQ   "req_cabc_mode"

Request CABC mode change.

Since:
v1.8.13
Parameters:
mode gchar * with the new CABC mode (see mce/mode-names.h for valid CABC modes)

#define MCE_CALL_STATE_CHANGE_REQ   "req_call_state_change"

Request call state change Changes can only be made to/from the "none" state; all other transitions will be vetoed.

This is to avoid race conditions between different services.

An exception is made when the tuple is active:emergency; such requests are always accepted

If the service that requests the transition emits a NameOwnerChanged, then the call state will revert back to "none", to ensure that crashing applications doesn't cause a forever busy call state

Since:
v1.8.1
Parameters:
call_state gchar * with the new call state (see mce/mode-names.h for valid call states)
call_type gchar * with the new call type (see mce/mode-names.h for valid call types)
Returns:
dbus_bool_t TRUE if the new call state was accepted, FALSE if the new call state was vetoed

#define MCE_CALL_STATE_GET   "get_call_state"

Query the call state.

Since:
v1.8.1
Returns:
gchar * with the new call state (see mce/mode-names.h for valid call states)

gchar * with the new emergency state type (see mce/mode-names.h for valid emergency state types)

#define MCE_CALL_STATE_SIG   "sig_call_state_ind"

Notify everyone that the call state has changed.

Since:
v1.8.1
Returns:
gchar * with the new call state (see mce/mode-names.h for valid call states)

gchar * with the new emergency state type (see mce/mode-names.h for valid emergency state types)

#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 gchar * with the pattern name (see /etc/mce/mce.ini for valid pattern names)

#define MCE_DEACTIVATE_VIBRATOR_PATTERN   "req_vibrator_pattern_deactivate"

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

Since:
v1.8.0
Parameters:
pattern gchar * 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 gchar * with the new device mode (see mce/mode-names.h for valid device modes)

#define MCE_DEVICE_MODE_GET   "get_device_mode"

Query the device mode.

Since:
v0.5.3
Returns:
gchar * 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:
gchar * with the new device mode (see mce/mode-names.h for valid device modes)

#define MCE_DEVICE_ORIENTATION_GET   "get_device_orientation"

Query the device orientation information.

Since:
v1.8.1
Returns:
gchar * portrait/landscape orientation (see mce/mode-names.h for valid portrait/landscape states)

gchar * on/off stand (see mce/mode-names.h for valid stand states)

gchar * face up/face down (see mce/mode-names.h for valid facing states)

dbus_int32_t x axis (unit mG)

dbus_int32_t y axis (unit mG)

dbus_int32_t z axis (unit mG)

#define MCE_DEVICE_ORIENTATION_SIG   "sig_device_orientation_ind"

Notify everyone that the device orientation has changed Note that this message is sent only if there is at least one active listener.

See MCE_ACCELEROMETER_ENABLE_REQ and MCE_ACCELEROMETER_DISABLE_REQ

Since:
v1.8.1
Returns:
gchar * portrait/landscape orientation (see mce/mode-names.h for valid portrait/landscape states)

gchar * on/off stand (see mce/mode-names.h for valid stand states)

gchar * face up/face down (see mce/mode-names.h for valid facing states)

dbus_int32_t x axis (unit mG)

dbus_int32_t y axis (unit mG)

dbus_int32_t z axis (unit mG)

#define MCE_DEVLOCK_MODE_GET   "get_devicelock_mode"

Query the device lock mode.

Since:
v0.8.0
Returns:
gchar * 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:
gchar * with the new device lock mode (see mce/mode-names.h for valid lock modes)

#define MCE_DISABLE_LED   "req_led_disable"

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

Since:
v1.5.0

#define MCE_DISABLE_VIBRATOR   "req_vibrator_disable"

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

Since:
v1.8.0

#define MCE_DISPLAY_DIM_REQ   "req_display_state_dim"

Dim display.

Since:
v1.6.20

#define MCE_DISPLAY_OFF_REQ   "req_display_state_off"

Blank display.

Since:
v1.6.20

#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:
gchar * with the display state (see mce/mode-names.h for valid display states)

#define MCE_DISPLAY_STATUS_GET   "get_display_status"

Query the display status.

Since:
v1.5.21
Returns:
gchar * 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_ENABLE_VIBRATOR   "req_vibrator_enable"

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

Since:
v1.8.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"

Query the inactivity status.

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

#define MCE_KEYBOARD_STATUS_GET   "get_keyboard_status"

Query the keyboard backlight status.

Since:
v1.8.19

#define MCE_PREVENT_BLANK_REQ   "req_display_blanking_pause"

Prevent display from blanking.

Since:
v0.5

#define MCE_PREVENT_KEYPAD_OFF_REQ   "req_keypad_off_pause"

Prevent keypad off.

On this request mce keeps keypad unblocked next 60 seconds

Since:
v1.8.17

#define MCE_START_MANUAL_VIBRATION   "req_start_manual_vibration"

Activate user defined vibrator pattern.

Since:
v1.8.18
Parameters:
speed int32 * vibration speed, value between -255 - 255
duration int32 * vibration duration in milliseconds (0 means forever)

#define MCE_STOP_MANUAL_VIBRATION   "req_stop_manual_vibration"

Stop manual vibration pattern before duration is expired.

Since:
v1.8.18

#define MCE_TKLOCK_MODE_CHANGE_REQ   "req_tklock_mode_change"

Request tklock mode change.

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

#define MCE_TKLOCK_MODE_GET   "get_tklock_mode"

Query the touchscreen/keypad lock mode.

Since:
v1.4.0
Returns:
gchar * 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:
gchar * 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"

Query the MCE version.

Since:
v1.1.6
Returns:
gchar * with the MCE version


Generated on Thu May 27 13:12:47 2010 for MCE D-Bus Interface by  doxygen 1.5.6