settings/include/ipc.h

Go to the documentation of this file.

#ifndef __IPC_H
#define __IPC_H

/**
 * File Name  : ipc.h
 *
 * Description: Internationalization and localization
 */

/*
 * This file is part of settings.
 *
 * settings 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.
 *
 * settings 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.
 */
 
 
//============================================================================
// Public Functions
//============================================================================

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

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

/**---------------------------------------------------------------------------
 *
 * Name :  ipc_sys_startup_complete
 *
 * @brief  Report "settings started" to sysd
 *
 * @param  [in] xid Xwindows id of main window
 *
 * @return --
 *
 *--------------------------------------------------------------------------*/
void ipc_sys_startup_complete ( int xid);

/**---------------------------------------------------------------------------
 *
 * Name :  ipc_menu_show_menu
 *
 * @brief  Set menu context
 *
 * @param  name  [Input] Menu name.
 *
 * @return --
 *
 *--------------------------------------------------------------------------*/
gboolean ipc_menu_show_menu( const char *name );

/**---------------------------------------------------------------------------
 *
 * Name :  ipc_remove_menu
 *
 * @brief  Remove menu from popup menu.
 *
 * @param  name  [Input] Menu name.
 *
 * @return --
 *
 *--------------------------------------------------------------------------*/
gboolean ipc_remove_menu( const char *name );
 
/**---------------------------------------------------------------------------
 *
 * Name :  menu_init
 *
 * @brief  Initialise popup menus for settings application.
 *
 * @param  --
 *
 * @return --
 *
 *--------------------------------------------------------------------------*/
void menu_init(void);

/**---------------------------------------------------------------------------
 *
 * Name :  ipc_menu_popup
 *
 * @brief  Request popup menu state
 *
 * @param  state   [Input] State ("show", "hide", "toggle", "block", "unblock")
 *
 * @return FALSE if failed to set menu
 *
 *--------------------------------------------------------------------------*/
gboolean ipc_menu_popup(const char* state);
 
/**---------------------------------------------------------------------------
 *
 * Name :  ipc_menu_enable
 *
 * @brief  Enable items in popup menu
 *
 * @param  --
 *
 * @return --
 *
 *--------------------------------------------------------------------------*/
void ipc_menu_enable();
 
/**---------------------------------------------------------------------------
 *
 * Name :  ipc_menu_disable
 *
 * @brief  Disable items in popup menu
 *
 * @param  --
 *
 * @return --
 *
 *--------------------------------------------------------------------------*/
void ipc_menu_disable();


/**---------------------------------------------------------------------------
 *
 * Name :  ipc_sys_busy
 *
 * @brief  Send message sysSetBusy to system daemon
 *
 * @param  [in] look_busy - TRUE to show, FALSE to remove the busy indication
 *
 * @return TRUE on success, FALSE otherwise
 *
 *--------------------------------------------------------------------------*/
gboolean ipc_sys_busy( gboolean look_busy );


/**---------------------------------------------------------------------------
 *
 * Name :  ipc_set_stylus
 *
 * @brief  Request popup menu state
 *
 * @param  state   [Input] State ("enable", "disable", "suspend", "resume", 
 *                                "high", "normal")
 *
 * @return FALSE if failed to set stylus state
 *
 *--------------------------------------------------------------------------*/
gboolean ipc_set_stylus(const char* state);


/**---------------------------------------------------------------------------
 *
 * Name :  get_device_capabilities
 *
 * @brief  Get device capabilities from sysd.
 *
 * @param  has_stylus    [Output] Store result of hasing stylus.
 *         has_wifi      [Output] Store result of hasing wifi.
 *         has_bluetooth [Output] Store result of hasing bluetooth.
 *         has_3g        [Output] Store result of hasing 3g.
 *
 * @return FALSE if failed to get device capabilities.
 *
 *--------------------------------------------------------------------------*/
gboolean get_device_capabilities(gboolean* has_stylus,
                                 gboolean* has_wifi,
                                 gboolean* has_bluetooth,
                                 gboolean* has_3g);

/**---------------------------------------------------------------------------
 *
 * Name :  mount_sd_card
 *
 * @brief  Mount sd card via sysd.
 *
 * @param  --
 *
 * @return --
 *
 *--------------------------------------------------------------------------*/
void mount_sd_card(void);

/**---------------------------------------------------------------------------
 *
 * Name :  unmount_sd_card
 *
 * @brief  Unmount sd card via sysd.
 *
 * @param  --
 *
 * @return --
 *
 *--------------------------------------------------------------------------*/
void unmount_sd_card(void);

/**---------------------------------------------------------------------------
 *
 * Name :  ipc_sys_open_url
 *
 * @brief  Send message openURL to system control,
 *         usually to open a web location in the browser application
 *
 * @param  [in]  url - url to open
 * @param  [in]  label - text to show in popup menu, or NULL
 * @param  [in]  back_text - text in Back bar, or NULL to omit this bar
 * @param  [out] err_message - error message text from application
 *
 * @return error code (0 for success, >0 for failure)
 *
 *--------------------------------------------------------------------------*/
gint ipc_sys_open_url ( const gchar  *url,
                        const gchar  *label,
                        const gchar  *back_text,
                        gchar        **err_message );


/**---------------------------------------------------------------------------
 *
 * 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
 * @param  [out] err_message - error message text from application
 *
 * @return error code (0 for success, >0 for failure)
 *
 *--------------------------------------------------------------------------*/
gint ipc_sys_start_task ( const gchar  *cmd_line,
        const gchar  *work_dir,
        const gchar  *label,
        const gchar  *thumbnail_path,
        gchar        **err_message );

/**---------------------------------------------------------------------------
*
* Name :  ipc_sys_stop_task
*
* @brief  Send message stopTask to system control,
*         usually to close a documen that has previously been open using ipc_sys_start_task()
*
* @param  [in] cmd_line - command-line passed to ipc_sys_start_task() when launching the task
*
* @return TRUE on success, FALSE otherwise
*
*--------------------------------------------------------------------------*/
gboolean ipc_sys_stop_task ( const gchar  *cmd_line );

gboolean ipc_menu_block( void );
gboolean ipc_menu_unblock( void );

gboolean ipc_sys_is_in_portrait_mode(void);
gboolean ipc_get_battery_state(gint *level, gchar **state, gint *timeleft);

#endif // __IPC_H