BrainManager » src

Riferimenti per il file brain_client.c

Descrizione Dettagliata

Il BrainClient e' il componente grazie al quale le applicazioni possono dialogare con il BrainManager (che gira indipendentemente sul sistema ed e' a sua volta un componente del sistema stesso) ed essere notificate del cambiamento dei settaggi che le riguardano.
Qui vengono definite le funzioni con le quali prelevare i settaggi dal database centrale di BrainTop (che, almeno per il momento, non fanno riferimento al BrainManager ma si appoggiano direttamente a SQLite) e per l'allocazione e la registrazione di un nuovo BrainClient da parte dell'applicazione che si linka alla libreria

Da fare:
Fare completamente riferimento al BrainManager per la ricerca, l'aggiunta e la rimozione dei settaggi, anziche' fare riferimento direttamente al file del database

#include "brain_client.h"
#include "brain_db_settings.h"
#include "brain_manager.h"

Funzioni

char * convert_setting_value_in_string (BrainMcsSetting *setting)
 Converte un BrainMcsSetting in una stringa.
BrainMcsResult brain_mcs_get_setting (BrainClient *client, char *activity, char *field, char *option, BrainMcsSetting **result)
 Preleva un dato settaggio dal DB.
BrainMcsResult brain_mcs_get_all_settings (BrainClient *client, char *activity, char *field, BrainMcsSetting ***result)
 Preleva tutti i settaggi di un certo tipo dal DB.
BrainMcsResult brain_mcs_get_more_settings (BrainClient *client, char *activity, char *field, char *option, BrainMcsSetting ***result)
 Preleva tutti i valori assunti da un settaggio non-unico.
BrainMcsResult brain_mcs_set_setting (BrainClient *client, BrainMcsSetting *nuovi_settaggi)
 Setta il valore di un parametro nel DB.
BrainMcsResult brain_mcs_add_setting (BrainClient *client, BrainMcsSetting *new_setting)
 Aggiunge un nuovo parametro nel DB.
BrainMcsResult brain_mcs_delete_setting (BrainClient *client, BrainMcsSetting *old_setting)
 Elimina un settaggio dal DB.
BrainMcsChannel * brain_client_add_channel (BrainClient *client, const gchar *channel_name)
 Permette di registrare l'applicazione ad un nuovo canale per i settaggi.
static void notify_changes (BrainClient *client, guchar *sett_changed, const gchar *channel_name)
static int ignore_errors (Display *display, XErrorEvent *event)
static void read_settings (BrainClient *client, const gchar *channel_name)
static void check_manager_window (BrainClient *client)
Bool brain_client_process_event (BrainClient *client, XEvent *xev)
 Mette il BrainClient in ascolto degli eventi che giungono dal BrainManager.
static void add_events (Display *display, Window window, long mask)
BrainClient * brain_client_new (Display *display, int screen, BrainNotifyFunc notify, BrainMcsWatchFunc watch, void *cb_data)
 Alloca un nuovo BrainClient.
void brain_client_destroy (BrainClient *client)
 Distrugge un BrainClient.

Documentazione delle funzioni

char* convert_setting_value_in_string (  BrainMcsSetting *  setting  ) 
 

Converte un BrainMcsSetting in una stringa.

Converte il valore contenuto in un BrainMcsSetting in una stringa. E' utile nel momento in cui tutti i valori nel database sono memorizzati sottoforma di stringa, mentre le applicazioni fanno riferimento all'interfaccia del BrainManager con diversi tipi di variabili (numeriche, stringhe o colori RGBA)

Avvertimento:
Liberare dalla memoria il valore tornato con g_free()

BrainMcsResult brain_mcs_get_setting (  BrainClient *  client,
char *  activity,
char *  field,
char *  option,
BrainMcsSetting **  result
) 
 

Preleva un dato settaggio dal DB.

Per ricavare dal database un settaggio di cui gia' si conosce il nome, il componente di riferimento e l'attivita' per cui e' valido

BrainMcsResult brain_mcs_get_all_settings (  BrainClient *  client,
char *  activity,
char *  field,
BrainMcsSetting ***  result
) 
 

Preleva tutti i settaggi di un certo tipo dal DB.

Preleva dal database dei settaggi tutti i parametri con un dato campo ACTIVITY e FIELD. Utile quando si vogliono estrapolare tutti i settaggi relativi ad un dato componente del sistema, come il desktop o il window manager

BrainMcsResult brain_mcs_get_more_settings (  BrainClient *  client,
char *  activity,
char *  field,
char *  option,
BrainMcsSetting ***  result
) 
 

Preleva tutti i valori assunti da un settaggio non-unico.

Preleva dal database dei settaggi tutti i parametri dello stesso tipo (dunque con ACTIVITY, FIELD e OPTION uguali). E' dedicata all'estrazione di tutti quei settaggi che non sono unici ma che appaiono piu' volte (con valori diversi) nel DB

BrainMcsResult brain_mcs_set_setting (  BrainClient *  client,
BrainMcsSetting *  nuovi_settaggi
) 
 

Setta il valore di un parametro nel DB.

Permette di settare il valore di un parametro all'interno del DB, i cui estremi (nome, attivita' di riferimento...) sono indicati nel campo "name" dell'BrainMcsSetting passato

BrainMcsResult brain_mcs_add_setting (  BrainClient *  client,
BrainMcsSetting *  new_setting
) 
 

Aggiunge un nuovo parametro nel DB.

Aggiunge una nuova entry nel database dei settaggi

Avvertimento:
All'interno del database dei settaggi esiste il campo "UNI", che attesta l'unicita' del settaggio stesso: ad esempio, il colore dello sfondo del desktop e' unico, mentre le voci che appaiono nel menu contestuale delle applicazioni sono molte. Qui non viene effettuato nessun controllo sulla validita' del valore assegnato al parametro "UNI" del nuovo settaggio, il quale, in questo caso specifico, dovrebbe sempre essere ==1 (in quanto, se si volesse modificare un parametro unico, si dovrebbe ricorrere alla funzione brain_mcs_set_setting() )

BrainMcsResult brain_mcs_delete_setting (  BrainClient *  client,
BrainMcsSetting *  old_setting
) 
 

Elimina un settaggio dal DB.

Elimina una entry dal database dei settaggi

BrainMcsChannel* brain_client_add_channel (  BrainClient *  client,
const gchar *  channel_name
) 
 

Permette di registrare l'applicazione ad un nuovo canale per i settaggi.

Aggiunge un canale al BrainClient dell'applicazione. Il "canale" e' il nome col quale vengono identificati quei settaggi che interessano l'applicazione stessa, la quale dovra' essere messa al corrente di eventuali cambiamenti

Avvertimento:
I pannelli per la regolazione dei settaggi devono essere registrati su canali omonimi a quelli cui fanno riferimento le relative applicazioni

static void notify_changes (  BrainClient *  client,
guchar *  sett_changed,
const gchar *  channel_name
)  [static]
 

static int ignore_errors (  Display *  display,
XErrorEvent *  event
)  [static]
 

static void read_settings (  BrainClient *  client,
const gchar *  channel_name
)  [static]
 

static void check_manager_window (  BrainClient *  client  )  [static]
 

Bool brain_client_process_event (  BrainClient *  client,
XEvent *  xev
) 
 

Mette il BrainClient in ascolto degli eventi che giungono dal BrainManager.

Mette in ascolto il BrainClient passato sugli eventi generati dal BrainManager: grazie a questa funzione il client puo' accorgersi di eventuali cambiamenti nei settaggi (effettuati a mezzo degli appositi pannelli di configurazione) e notificarli all'applicazione invocante

static void add_events (  Display *  display,
Window  window,
long  mask
)  [static]
 

BrainClient* brain_client_new (  Display *  display,
int  screen,
BrainNotifyFunc  notify,
BrainMcsWatchFunc  watch,
void *  cb_data
) 
 

Alloca un nuovo BrainClient.

Alloca e ritorna un nuovo BrainClient, che l'applicazione invocante usera' per interfacciarsi col BrainManager

void brain_client_destroy (  BrainClient *  client  ) 
 

Distrugge un BrainClient.

Disalloca ed elimina un BrainClient

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