src

libosso.h File Reference

#include <glib.h>
#include <time.h>
#include <syslog.h>
#include <dbus/dbus.h>
#include <dbus/dbus-protocol.h>

Detailed Description

This file is the public API for the Libosso library.

This file is part of libosso

Contact: Kimmo Hämäläinen <kimmo.hamalainen@nokia.com>

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License version 2.1 as published by the Free Software Foundation.

This library 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 Lesser General Public License for more details.

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

Define Documentation

#define DBUS_API_SUBJECT_TO_CHANGE

Enumeration Type Documentation

enum osso_devmode_t

Enumeration values:

OSSO_DEVMODE_NORMAL

OSSO_DEVMODE_FLIGHT

OSSO_DEVMODE_OFFLINE

OSSO_DEVMODE_INVALID

enum osso_return_t

This enum represents the return values that most Libosso functions use.
Enumeration values:

OSSO_OK The function executed normally.

OSSO_ERROR Some kind of an error occured.

OSSO_INVALID At least one parameter is invalid.

OSSO_RPC_ERROR Osso RPC method returned an error.

OSSO_ERROR_NAME

OSSO_ERROR_NO_STATE No state file found to read.

OSSO_ERROR_STATE_SIZE The size of the given structure is different from the saved size

Function Documentation

gpointer osso_get_dbus_connection ( osso_context_t * osso )

Returns the D-BUS session bus connection used by the Libosso context. The return value should be casted to DBusConnection pointer.
Parameters:

osso Libosso context as returned by osso_initialize.

Returns:
Pointer to DBusConnection on a gpointer.

gpointer osso_get_sys_dbus_connection ( osso_context_t * osso )

Returns the D-BUS system bus connection used by the Libosso context. The return value should be casted to DBusConnection pointer.
Parameters:

osso Libosso context as returned by osso_initialize.

Returns:
Pointer to DBusConnection on a gpointer.

Generated on Mon Dec 18 16:43:35 2006 for Libosso by

1.4.2


Defines
#define	DBUS_API_SUBJECT_TO_CHANGE
Typedefs
typedef osso_af_context_t	osso_context_t
typedef gint(	osso_rpc_cb_f )(const gchar interface, const gchar method, GArray arguments, gpointer data, osso_rpc_t retval)
typedef void(	osso_rpc_async_f )(const gchar interface, const gchar method, osso_rpc_t *retval, gpointer data)
typedef void	osso_rpc_argfill (DBusMessage msg, void data)
typedef void	osso_rpc_retval_free_f (osso_rpc_t *retval)
typedef void(	osso_application_top_cb_f )(const gchar *arguments, gpointer data)
typedef void(	osso_hw_cb_f )(osso_hw_state_t *state, gpointer data)
Enumerations
enum	osso_return_t { OSSO_OK = 0, OSSO_ERROR = -1, OSSO_INVALID = -2, OSSO_RPC_ERROR = -4, OSSO_ERROR_NAME = -3, OSSO_ERROR_NO_STATE = -5, OSSO_ERROR_STATE_SIZE = -6 }
enum	osso_system_note_type_t { OSSO_GN_WARNING = 0, OSSO_GN_ERROR, OSSO_GN_NOTICE, OSSO_GN_WAIT }
enum	osso_devmode_t { OSSO_DEVMODE_NORMAL = 0, OSSO_DEVMODE_FLIGHT, OSSO_DEVMODE_OFFLINE, OSSO_DEVMODE_INVALID }
Functions
osso_context_t *	osso_initialize (const gchar application, const gchar version, gboolean activation, GMainContext *context)
void	osso_deinitialize (osso_context_t *osso)
void	osso_rpc_free_val (osso_rpc_t *rpc)
osso_return_t	osso_rpc_run (osso_context_t osso, const gchar service, const gchar object_path, const gchar interface, const gchar method, osso_rpc_t retval, int argument_type,...)
osso_return_t	osso_rpc_run_with_argfill (osso_context_t osso, const gchar service, const gchar object_path, const gchar interface, const gchar method, osso_rpc_t retval, osso_rpc_argfill *argfill, gpointer argfill_data)
osso_return_t	osso_rpc_run_system (osso_context_t osso, const gchar service, const gchar object_path, const gchar interface, const gchar method, osso_rpc_t retval, int argument_type,...)
osso_return_t	osso_rpc_run_system_with_argfill (osso_context_t osso, const gchar service, const gchar object_path, const gchar interface, const gchar method, osso_rpc_t retval, osso_rpc_argfill *argfill, gpointer argfill_data)
osso_return_t	osso_rpc_run_with_defaults (osso_context_t osso, const gchar application, const gchar method, osso_rpc_t retval, int argument_type,...)
osso_return_t	osso_rpc_async_run (osso_context_t osso, const gchar service, const gchar object_path, const gchar interface, const gchar method, osso_rpc_async_f async_cb, gpointer data, int argument_type,...)
osso_return_t	osso_rpc_async_run_with_argfill (osso_context_t osso, const gchar service, const gchar object_path, const gchar interface, const gchar method, osso_rpc_async_f async_cb, gpointer data, osso_rpc_argfill *argfill, gpointer argfill_data)
osso_return_t	osso_rpc_async_run_with_defaults (osso_context_t osso, const gchar application, const gchar method, osso_rpc_async_f async_cb, gpointer data, int argument_type,...)
osso_return_t	osso_rpc_set_cb_f_with_free (osso_context_t osso, const gchar service, const gchar object_path, const gchar interface, osso_rpc_cb_f cb, gpointer data, osso_rpc_retval_free_f retval_free)
osso_return_t	osso_rpc_set_cb_f (osso_context_t osso, const gchar service, const gchar object_path, const gchar interface, osso_rpc_cb_f *cb, gpointer data)
osso_return_t	osso_rpc_set_default_cb_f_with_free (osso_context_t osso, osso_rpc_cb_f cb, gpointer data, osso_rpc_retval_free_f *retval_free)
osso_return_t	osso_rpc_set_default_cb_f (osso_context_t osso, osso_rpc_cb_f cb, gpointer data)
osso_return_t	osso_rpc_unset_cb_f (osso_context_t osso, const gchar service, const gchar object_path, const gchar interface, osso_rpc_cb_f *cb, gpointer data)
osso_return_t	osso_rpc_unset_default_cb_f (osso_context_t osso, osso_rpc_cb_f cb, gpointer data)
osso_return_t	osso_rpc_get_timeout (osso_context_t osso, gint timeout)
osso_return_t	osso_rpc_set_timeout (osso_context_t *osso, gint timeout)
osso_return_t	osso_application_top (osso_context_t osso, const gchar application, const gchar *arguments)
osso_return_t	osso_application_set_top_cb (osso_context_t osso, osso_application_top_cb_f cb, gpointer data)
osso_return_t	osso_application_unset_top_cb (osso_context_t osso, osso_application_top_cb_f cb, gpointer data)
osso_return_t	osso_application_set_autosave_cb (osso_context_t osso, osso_application_autosave_cb_f cb, gpointer data)
osso_return_t	osso_application_unset_autosave_cb (osso_context_t osso, osso_application_autosave_cb_f cb, gpointer data)
osso_return_t	osso_application_userdata_changed (osso_context_t *osso)
osso_return_t	osso_application_autosave_force (osso_context_t *osso)
const gchar *	osso_application_name_get (osso_context_t *osso)
const gchar *	osso_application_version_get (osso_context_t *osso)
*osso_return_t	osso_statusbar_send_event (osso_context_t osso, const gchar name, gint argument1, gint argument2, const gchar argument3, osso_rpc_t retval)
osso_return_t	osso_time_set_notification_cb (osso_context_t osso, osso_time_cb_f cb, gpointer data)
osso_return_t	osso_time_set (osso_context_t *osso, time_t new_time)
osso_return_t	osso_system_note_dialog (osso_context_t osso, const gchar message, osso_system_note_type_t type, osso_rpc_t *retval)
osso_return_t	osso_system_note_infoprint (osso_context_t osso, const gchar text, osso_rpc_t *retval)
osso_return_t	osso_state_write (osso_context_t osso, osso_state_t state)
osso_return_t	osso_state_read (osso_context_t osso, osso_state_t state)
*osso_return_t	osso_cp_plugin_execute (osso_context_t osso, const gchar filename, gpointer data, gboolean user_activated)
osso_return_t	osso_cp_plugin_save_state (osso_context_t osso, const gchar filename, gpointer data)
osso_return_t	osso_display_state_on (osso_context_t *osso)
osso_return_t	osso_display_blanking_pause (osso_context_t *osso)
osso_return_t	osso_hw_set_event_cb (osso_context_t osso, osso_hw_state_t state, osso_hw_cb_f *cb, gpointer data)
osso_return_t	osso_hw_unset_event_cb (osso_context_t osso, osso_hw_state_t state)
osso_return_t	osso_mime_set_cb (osso_context_t osso, osso_mime_cb_f cb, gpointer data)
osso_return_t	osso_mime_unset_cb (osso_context_t *osso)
osso_return_t	osso_mime_unset_cb_full (osso_context_t osso, osso_mime_cb_f cb, gpointer data)
gpointer	osso_get_dbus_connection (osso_context_t *osso)
gpointer	osso_get_sys_dbus_connection (osso_context_t *osso)
osso_return_t	osso_application_set_exit_cb (osso_context_t osso, osso_application_exit_cb cb, gpointer data)
int	osso_state_open_write (osso_context_t *osso)
int	osso_state_open_read (osso_context_t *osso)
void	osso_state_close (osso_context_t *osso, gint fd)
osso_return_t	osso_tasknav_mail_add (osso_context_t osso, guint id, const gchar subject, const gchar sender, gboolean attachment, const gchar date)
osso_return_t	osso_tasknav_mail_del (osso_context_t *osso, guint id)
osso_return_t	osso_tasknav_mail_set_outbox_count (osso_context_t *osso, guint count)
osso_context_t *	osso_application_initialize (const gchar application, const gchar version, osso_application_top_cb_f *cb, gpointer callback_data)
Variables
*typedef void(	osso_application_autosave_cb_f )(gpointer data)
*typedef void(	osso_time_cb_f )(gpointer data)
*typedef void(	osso_mime_cb_f )(gpointer data, int argc, gchar **argv)
*typedef void(	osso_application_exit_cb )(gboolean die_now, gpointer data)

libosso.h File Reference

Defines

Typedefs

Enumerations

Functions

Variables

Detailed Description

Define Documentation

Enumeration Type Documentation

Function Documentation