Main Page | Modules | Alphabetical List | Data Structures | Directories | File List | Data Fields | Globals | Related Pages

Not included


Functions

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_exit_cb )(gboolean die_now, gpointer data)

Detailed Description

Note:
This API is obsolete and should not be used by new code.

Function Documentation

osso_context_t* osso_application_initialize (  const gchar *  application,
const gchar *  version,
osso_application_top_cb_f *  cb,
gpointer  callback_data
) 
 

Osso initialisation routine for applications to call. This ensures that the environment variables are transferred correctly before the gtk_init();

Parameters:
application The name that this application is known as. This is not the name that a user sees, but rather the name that other applications use as an address to communicate with this program.
version The version string of the application. It mus be simply comparable with strcmp().
cb The callback function to used when application is topped.
callback_data An arbitrary pointer to some application specific data to pass to the top callback

osso_return_t osso_application_set_exit_cb (  osso_context_t *  osso,
osso_application_exit_cb *  cb,
gpointer  data
) 
 

This function is obsolete and does nothing. Do not use it.

void osso_state_close (  osso_context_t *  osso,
gint  fd
) 
 

This function closes the state file.

Deprecated:
Use the more robust osso_state_read() and osso_state_write() functions instead. No new code should use this function.
Parameters:
osso The library context as returned by osso_initialize.
fd The file descriptor to close.

int osso_state_open_read (  osso_context_t *  osso  ) 
 

This function opens a state file for reading.

Deprecated:
Use the more robust osso_state_read() function instead. No new code should use this function.
Parameters:
osso The library context as returned by osso_initialize.
Returns:
The file descriptor of the opened file. On an error -1 is returned.

int osso_state_open_write (  osso_context_t *  osso  ) 
 

This function opens a state file for writing. If the state file already exists, it will be silently truncated.

Deprecated:
Use the more robust osso_state_write() function instead. No new code should use this function.
Parameters:
osso The library context as returned by osso_initialize.
Returns:
the file descriptor of the opened file. On an error -1 is returned.

osso_return_t osso_tasknav_mail_add (  osso_context_t *  osso,
guint  id,
const gchar *  subject,
const gchar *  sender,
gboolean  attachment,
const gchar *  date
) 
 

This function adds a mail to be displayed in the mail popup of the tasknavigator.

Parameters:
osso The osso library context returned by osso_initialize
id unique identifier for the mail
subject the subject string of the email
sender the email address of the sender of the mail
attachment true iff the mail has an attatchment
date the date the mail was received.
Returns:
OSSO_OK on success, OSSO_ERROR in case of an error, OSSO_INVALID if a parameter is invalid.

osso_return_t osso_tasknav_mail_del (  osso_context_t *  osso,
guint  id
) 
 

This function removes an email message from the navigator.

Parameters:
osso The osso library context returned by osso_initialize
id unique identifier of the mail to be destroyed
Returns:
OSSO_OK on success, OSSO_ERROR in case of an error, OSSO_INVALID if a paramter is invalid.

osso_return_t osso_tasknav_mail_set_outbox_count (  osso_context_t *  osso,
guint  count
) 
 

This function updates the outbox message count in the task navigator mail window.

Parameters:
osso The osso library context returned by osso_initialize
count New number of messages in outbox
Returns:
OSSO_OK on success, OSSO_ERROR in case of an error, OSSO_INVALID if a paramter is invalid.


Variable Documentation

* typedef void( osso_application_exit_cb)(gboolean die_now, gpointer data)
 

Obsolete type -- do not use.


Generated on Mon Dec 18 16:43:36 2006 for Libosso by  doxygen 1.4.2