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_RADIO_STATES_GET   "get_radio_states"
 Query radio states.
#define MCE_CALL_STATE_GET   "get_call_state"
 Query the call state.
#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_PSM_STATE_GET   "get_psm_state"
 Query the automatic power saving mode.
#define MCE_KEY_BACKLIGHT_STATE_GET   "get_key_backlight_state"
 Query key backlight state.
#define MCE_ADD_ACTIVITY_CALLBACK_REQ   "add_activity_callback"
 Add an activity notification callback; the next user activity will trigger this callback callbacks are one-shot -- once the callback has been invoked, it will be unregistered.
#define MCE_REMOVE_ACTIVITY_CALLBACK_REQ   "remove_activity_callback"
 Remove any activity notification callback belonging to the calling process.
#define MCE_INACTIVITY_STATUS_GET   "get_inactivity_status"
 Query the inactivity status.
#define MCE_VERSION_GET   "get_version"
 Query the MCE version.
#define MCE_RADIO_STATES_CHANGE_REQ   "req_radio_states_change"
 Request radio states 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_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_CANCEL_PREVENT_BLANK_REQ   "req_display_cancel_blanking_pause"
 Cancel display blanking prevention.
#define MCE_CABC_MODE_REQ   "req_cabc_mode"
 Request CABC 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.
Generic D-Bus signals

#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_PSM_STATE_SIG   "psm_state_ind"
 Notify everyone that the state of the automatic power saving mode changed.
#define MCE_INACTIVITY_SIG   "system_inactivity_ind"
 Notify everyone that the system is active/inactive.
#define MCE_RADIO_STATES_SIG   "radio_states_ind"
 Notify everyone that the radio states have changed.
#define MCE_CALL_STATE_SIG   "sig_call_state_ind"
 Notify everyone that the call state has changed.
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 Note: Do NOT use this as a "master switch" for the LED framework, since some patterns should *always* be visible this interface is meant for testing and development only.

Detailed Description

D-Bus Interface to the Mode Control Entity.

This file is part of mce-dev

Copyright © 2004-2011 Nokia Corporation and/or its subsidiary(-ies).

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 these headers. If not, see <http://www.gnu.org/licenses/>.


Define Documentation

#define MCE_ACTIVATE_LED_PATTERN   "req_led_pattern_activate"

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

mce::LEDControl

Since:
v1.5.0
Parameters:
pattern gchar * with the pattern name (see /etc/mce/mce.ini for valid pattern names)
#define MCE_ADD_ACTIVITY_CALLBACK_REQ   "add_activity_callback"

Add an activity notification callback; the next user activity will trigger this callback callbacks are one-shot -- once the callback has been invoked, it will be unregistered.

Since:
1.10.106
Parameters:
service gchar * The method call service
path gchar * The method call path
interface gchar * The method call interface
name gchar * The name of the method to call
Returns:
dbus_bool_t TRUE if registration was successful, FALSE if registration was a failure (too many registered clients)
#define MCE_CABC_MODE_GET   "get_cabc_mode"

Query CABC mode.

Since:
v1.10.0
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.10.0
Parameters:
mode gchar * with the new CABC mode (see mce/mode-names.h for valid CABC modes)
Returns:
gchar * with the updated 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 mce::CallStateControl
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_CANCEL_PREVENT_BLANK_REQ   "req_display_cancel_blanking_pause"

Cancel display blanking prevention.

Since:
v1.10.35
#define MCE_DEACTIVATE_LED_PATTERN   "req_led_pattern_deactivate"

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

mce::LEDControl

Since:
v1.5.0
Parameters:
pattern gchar * with the pattern name (see /etc/mce/mce.ini for valid pattern names)
#define MCE_DISABLE_LED   "req_led_disable"

Disable LED; this does not affect the LED pattern stack Note: Do NOT use this as a "master switch" for the LED framework, since some patterns should *always* be visible this interface is meant for testing and development only.

mce::LEDControl

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

Do NOT use this as a "master switch" for the LED framework, since some patterns should *always* be visible this interface is meant for testing and development only

mce::LEDControl

Since:
v1.5.0
#define MCE_ERROR_FATAL   "com.nokia.mce.error.fatal"

The MCE D-Bus error interface; currently not used.

Since:
v0.3
#define MCE_ERROR_INVALID_ARGS   "org.freedesktop.DBus.Error.InvalidArgs"

The D-Bus interface for invalid arguments; currently not used.

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_KEY_BACKLIGHT_STATE_GET   "get_key_backlight_state"

Query key backlight state.

Since:
v1.10.30
Returns:
dbus_bool_t TRUE if the key backlight is on, FALSE if the key backlight is off
#define MCE_PREVENT_BLANK_REQ   "req_display_blanking_pause"

Prevent display from blanking.

Since:
v0.5
#define MCE_PSM_STATE_GET   "get_psm_state"

Query the automatic power saving mode.

Since:
v1.10.44
Returns:
dbus_bool_t TRUE if automatic power saving mode is active, FALSE if automatic power saving mode is inactive
#define MCE_PSM_STATE_SIG   "psm_state_ind"

Notify everyone that the state of the automatic power saving mode changed.

Since:
v1.10.44
Returns:
dbus_bool_t TRUE if automatic power saving mode is active, FALSE if automatic power saving mode is inactive
#define MCE_RADIO_STATES_CHANGE_REQ   "req_radio_states_change"

Request radio states change.

Since:
v1.10.60 mce::DeviceModeControl
Parameters:
@c dbus_uint32_t New radio states or:ed together (see mce/mode-names.h for defines for the radio states)
@c dbus_uint32_t Mask for radio states or:ed together (see mce/mode-names.h for defines for the radio states)
#define MCE_RADIO_STATES_GET   "get_radio_states"

Query radio states.

Since:
v1.10.60
Returns:
dbus_uint32_t Radio states or:ed together (see mce/mode-names.h for defines for the radio states)
#define MCE_RADIO_STATES_SIG   "radio_states_ind"

Notify everyone that the radio states have changed.

Since:
v1.10.60
Returns:
dbus_uint32_t Radio states or:ed together (see mce/mode-names.h for defines for the radio states)
#define MCE_REMOVE_ACTIVITY_CALLBACK_REQ   "remove_activity_callback"

Remove any activity notification callback belonging to the calling process.

Since:
1.10.106
#define MCE_REQUEST_IF   "com.nokia.mce.request"

MCE D-Bus Request interface.

Since:
v0.3
#define MCE_REQUEST_PATH   "/com/nokia/mce/request"

MCE D-Bus Request path.

Since:
v0.3
#define MCE_SERVICE   "com.nokia.mce"

MCE D-Bus service.

Since:
v0.3
#define MCE_SIGNAL_IF   "com.nokia.mce.signal"

MCE D-Bus Signal interface.

Since:
v0.3
#define MCE_SIGNAL_PATH   "/com/nokia/mce/signal"

MCE D-Bus Signal path.

Since:
v0.3
#define MCE_TKLOCK_MODE_CHANGE_REQ   "req_tklock_mode_change"

Request tklock mode change.

Since:
v1.4.0 mce::TKLockControl
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.

mce::DeviceModeControl

Since:
v1.5.3
Parameters:
type dbus_bool_t with the type of powerkey event to trigger; FALSE == short powerkey press, TRUE == long powerkey press
Since:
v1.10.54
Parameters:
type dbus_uint32_t with the type of powerkey event to trigger; 0 == short powerkey press, 1 == long powerkey press, 2 == double powerkey press
#define MCE_VERSION_GET   "get_version"

Query the MCE version.

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