popupmenu/include/ipc.h

Go to the documentation of this file.

#ifndef __IPC_H__
#define __IPC_H__

/**
 * File Name  : ipc.h
 *
 * Description: The dbus-based eripc functions 
 */

/*
 * This file is part of popupmenu.
 *
 * popupmenu is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * popupmenu is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

/**
 * Copyright (C) 2008 iRex Technologies B.V.
 * All rights reserved.
 */


//----------------------------------------------------------------------------
// Include Files
//----------------------------------------------------------------------------

#include <liberipc/eripc.h>


G_BEGIN_DECLS


//----------------------------------------------------------------------------
// Definitions
//---------------------------------------------------------------------------- 

#define DBUS_APPL_NAME                  PACKAGE_NAME
#define DBUS_SERVICE                    "com.irexnet."  DBUS_APPL_NAME
#define DBUS_PATH                       "/com/irexnet/" DBUS_APPL_NAME
#define DBUS_INTERFACE                  "com.irexnet."  DBUS_APPL_NAME

#define DBUS_SERVICE_SYSTEM_CONTROL     "com.irexnet.sysd"
#define DBUS_SERVICE_CTB                "com.irexnet.ctb"


//----------------------------------------------------------------------------
// Forward Declarations
//----------------------------------------------------------------------------

//----------------------------------------------------------------------------
// Type Declarations
//----------------------------------------------------------------------------

//----------------------------------------------------------------------------
// Global Constants
//----------------------------------------------------------------------------


//============================================================================
// Public Functions
//============================================================================

/**---------------------------------------------------------------------------
 *
 * Name :  ipc_set_services
 *
 * @brief  Setup IPC connection and register API functions
 *
 * @param  --
 *
 * @return --
 *
 *--------------------------------------------------------------------------*/
void ipc_set_services(void);

/**---------------------------------------------------------------------------
 *
 * Name :  ipc_unset_services
 *
 * @brief  Unregister API functions
 *
 * @param  --
 *
 * @return --
 *
 *--------------------------------------------------------------------------*/
void ipc_unset_services(void);

void ipc_send_task_activated(int xid);

/**---------------------------------------------------------------------------
 *
 * Name :  ipc_send_item_activated
 *
 * @brief  Send menuItemActivated to service
 *
 * @param  iname   Item name
 * @param  pname   Parent group name
 * @param  mname   Current menu name
 * @param  state   Current state of the menu item
 * @param  service IPC service name
 *
 * @return --
 *
 *--------------------------------------------------------------------------*/
void ipc_send_item_activated(const char *iname, const char *pname, const char *mname, const char *state, const char *service);

/**---------------------------------------------------------------------------
 *
 * Name :  ipc_send_status_item_activated
 *
 * @brief  Send statusItemActivated to service
 *
 * @param  iname   Status item name
 * @param  state   Current state of the menu item
 * @param  service IPC service name
 *
 * @return --
 *
 *--------------------------------------------------------------------------*/
void ipc_send_status_item_activated(const char *iname, const char *state, const char *service);

/**---------------------------------------------------------------------------
 *
 * Name :  ipc_send_startup_complete
 *
 * @brief  Send startupComplete
 *
 * @param  --
 *
 * @return --
 *
 *--------------------------------------------------------------------------*/
void ipc_send_startup_complete(void);

/**---------------------------------------------------------------------------
 *
 * Name :  ipc_sys_start_task
 *
 * @brief  Send message startTask to system control,
 *         usually to open a document in the relevant viewer application
 *
 * @param  [in] cmd_line - command-line to launch the task (executable + options)
 * @param  [in] work_dir - working directory in which to start this task
 * @param  [in] label - text to show in popup menu
 * @param  [in] thumbnail_path - the file containing the thumbnail to show in popup menu
 *
 * @return TRUE on success, FALSE otherwise
 *
 *--------------------------------------------------------------------------*/
gboolean ipc_sys_start_task ( const gchar  *cmd_line,
                              const gchar  *work_dir,
                              const gchar  *label,
                              const gchar  *thumbnail_path );

/**---------------------------------------------------------------------------
 *
 * Name :  ipc_get_battery_state
 *
 * @brief  Get current battery state and level and update statusbar icon 
 *
 * @param  [out] level    Current battery level
 * @param  [out] state    Current charging state, string must be freed
 * @param  [out] timeleft Minutes to empty (discharing) of -1 (charging)
 *
 * @return TRUE on success, FALSE otherwise
 *
 *--------------------------------------------------------------------------*/
gboolean ipc_get_battery_state(gint *level, gchar **state, gint *timeleft);

void ipc_send_page_change(const gchar* dir);

void ipc_send_reply(eripc_context_t *context, const char *message_id, gboolean result);
gboolean ipc_get_device_capabilities(gboolean *has_stylus, gboolean *has_wifi, gboolean *has_bluetooth, gboolean *has_3g);
void ipc_send_request_popup(const char *state);

void ipc_set_enabled(gboolean enabled);
gboolean ipc_is_enabled(void);
gchar *ipc_get_orientation(void);
void ipc_set_orientation(const gchar *orientation);
void ipc_sys_standby(void);


G_END_DECLS

#endif /* __IPC_H__ */