Riferimenti per il file brain_applet_manager.h

#include <glib.h>
#include <sys/types.h>
#include <unistd.h>
#include <brain_applets_generic.h>

Strutture dati
struct	BAMExchanger
struct	BAMAppletDescriptor
struct	BrainAppletManager
Definizioni
#define	BRAIN_APPLET_SHMEM_ID   1234567890
#define	BRAIN_APPLET_PACKAGE_EXTENSION   "bap"
#define	BRAIN_APPLET_CONFIG_FILENAME   "applet.config"
#define	MAX_BAM_OPTIONS_LENGHT   50
Tipi enumerati (enum)
enum	BAMRequestType {   BAM_EXISTS_APPLET, BAM_TYPE_APPLET, BAM_LAUNCH_APPLET, BAM_EXEC_APPLET,   BAM_TERMINATE }
enum	BAMResponseType {   BAM_OK, BAM_KO, BAM_APPLET_DONT_EXISTS, BAM_APPLET_EXISTS,   BAM_APPLET_NOTHING, BAM_APPLET_INTEGRATE, BAM_APPLET_SUBSTITUTE }
Funzioni
BAMExchanger *	brain_applet_manager_connect ()
	Per permettere ad una applicazione di poter dialogare con l'AppletsManager.
BAMResponseType	brain_applet_manager_send (BAMExchanger *, BAMRequestType, BrainAppletRequest, BrainAppletRequestOptions, char *)
	Funzione per avanzare una richiesta all'AppletsManager.
GList *	brain_applet_get_applets_list ()
	Restituisce la lista delle applets attualmente caricate.
gboolean	brain_applet_manager_ask (BAMExchanger *, BrainAppletRequest, BrainAppletRequestOptions, char *)
	Versione ridotta di brain_applet_manager_connect() che verifica direttamente se l'applicazione chiamante e' stata sostituita da una applet o meno.
void	start_applet_manager ()
	Permette di avviare il BrainAppletsManager.

Documentazione delle definizioni

#define BRAIN_APPLET_SHMEM_ID   1234567890

Key di riferimento per l'area di memoria condivisa presso cui scambiare informazioni con l'AppletsManager

#define BRAIN_APPLET_PACKAGE_EXTENSION   "bap"

Estensione standard per i pacchetti identificati come applets per BrainTop

#define BRAIN_APPLET_CONFIG_FILENAME   "applet.config"

Nome del file che dovrebbe trovarsi all'interno di ogni pacchetto delle applets: contiene informazioni utili durante l'installazione

#define MAX_BAM_OPTIONS_LENGHT   50

Documentazione dei tipi enumerati

enum BAMRequestType

Tipi di richieste che il window manager puo' avanzare all'AppletsManager Valori dei tipi enumerati: BAM_EXISTS_APPLET  Il window manager chiede se esiste una applet con date caratteristiche. this_type e this_options sono significativi BAM_TYPE_APPLET  Il window manager chiede, se trova una applet valida, qual'e' il suo comportamento (integra le funzioni o le sostituisce) BAM_LAUNCH_APPLET  Viene richiesto di lanciare una nuova applet, il cui path dell'eseguibile si trova in options e la descrizione in now_active BAM_EXEC_APPLET  Viene richiesto di eseguire una applet secondo le modalita' previste da quest'ultima. Ci si riferisce all'ultima applet di cui si sono chieste notizie BAM_TERMINATE  Richiesta la chiusura del manager

enum BAMResponseType

Tipi di risposte che l'AppletsManager puo' rendere al window manager Valori dei tipi enumerati: BAM_OK  Notifica il corretto svolgimento dell'attivita' richiesta BAM_KO  Notifica il mancato svolgimento dell'attivita' richiesta BAM_APPLET_DONT_EXISTS  Il tipo di applet richiesto non esiste BAM_APPLET_EXISTS  Il tipo di applet richiesto esiste BAM_APPLET_NOTHING  L'applet richiesta esiste ma non reagisce al tipo di evento BAM_APPLET_INTEGRATE  L'applet richiesta esiste e integra il comportamento del window manager BAM_APPLET_SUBSTITUTE  L'applet richiesta esiste e sostituisce il comportamento del window manager

Documentazione delle funzioni

BAMExchanger* brain_applet_manager_connect (   )

Per permettere ad una applicazione di poter dialogare con l'AppletsManager. Per "connettere" l'applicazione chiamante all'AppletsManager: viene settato il puntatore al segmento di memoria condivisa usato per dialogare col manager < Key di riferimento per l'area di memoria condivisa presso cui scambiare informazioni con l'AppletsManager

BAMResponseType brain_applet_manager_send (  BAMExchanger *  exchange, BAMRequestType  request, BrainAppletRequest  type, BrainAppletRequestOptions  opts, char *  options )

Funzione per avanzare una richiesta all'AppletsManager. Invia una richiesta all'AppletsManager

GList* brain_applet_get_applets_list (   )

Restituisce la lista delle applets attualmente caricate. Preleva dal DB la lista completa di tutte le applets registrate. Nel valore di ritorno, ogni applet e' rappresentata da un elemento nella GList, il cui campo data e' settato con una stringa in cui, divisi da \n, si trovano il nome, la descrizione, il tipo di applet (secondo la enum BrainAppletType) e l'eventuale tabella di riferimento

gboolean brain_applet_manager_ask (  BAMExchanger *  manager, BrainAppletRequest  type, BrainAppletRequestOptions  subtype, char *  options )

Versione ridotta di brain_applet_manager_connect() che verifica direttamente se l'applicazione chiamante e' stata sostituita da una applet o meno. Effettua direttamente il controllo sull'esistenza di una applet e sul suo comportamento nei confronti dell'applicazione chiamante. Questa funzione e' stata creata per essere chiamata direttamente dalle applicazioni componenti del window manager ed evitare di ripetere questo segmento di codice piu' e piu' volte

void start_applet_manager (   )

Permette di avviare il BrainAppletsManager. < La path di installazione

Generato il Sun Apr 16 01:36:44 2006 per BrainTop da  1.4.6