http://docs.kde.org/
IndietroInterfaccia D-BusAvanti

Nome

scheduleMessage — pianifica un nuovo messaggio di avviso.

Sinossi

bool scheduleMessage(const QString& messaggio,
                     const QString& data_ora_avvio,
                     int ritardo_annullamento,
                     unsigned flag, 
                     const QString& colore_sfondo, 
                     const QString& colore_primo_piano, 
                     const QString& carattere, 
                     const QString& URL_audio, 
                     int minuti_promemoria, 
                     const QString& ricorrenza,
                     int intervallo_sottoripetizione, 
                     int conteggio_sottoripetizione)

bool scheduleMessage(const QString& messaggio, 
                     const QString& data_ora_avvio, 
                     int ritardo_annullamento, 
                     unsigned flag, 
                     const QString& colore_sfondo, 
                     const QString& colore_primo_piano, 
                     const QString& carattere, 
                     const QString& URL_audio, 
                     int minuti_promemoria, 
                     int tipo_ricorrenza, 
                     int intervallo_ricorrenza, 
                     int conteggio_ricorrenza)

bool scheduleMessage(const QString& messaggio, 
                     const QString& data_ora_avvio, 
                     int ritardo_annullamento, 
                     unsigned flag, 
                     const QString& colore_sfondo, 
                     const QString& colore_primo_piano, 
                     const QString& carattere, 
                     const QString& URL_audio, 
                     int minuti_promemoria, 
                     int tipo_ricorrenza, 
                     int intervallo_ricorrenza, 
                     const QString& data_ora_fine)

Parametri

messaggio

Specifica il testo del messaggio da pianificare, o, se flag ha impostato il bit DISPLAY_COMMAND, specifica la riga di comando da eseguire per generare il testo del messaggio.

data_ora_avvio

Specifica la data ed eventualmente l'ora di pianificazione alla quale visualizzare il messaggio. Per un avviso con sola data, la stringa dovrebbe essere nel formato AAAA-MM-GG [FO] (come restituito da QDate::toString(Qt::ISODate)). Per un avviso con una data e un'ora, la stringa dovrebbe essere nel formato AAAA-MM-GGTHH:MM[:SS] [FO] (come restituito da QDateTime::toString(Qt::ISODate)) o HH:MM[:SS] [Clock] (come restituito da QTime::toString(Qt::ISODate)). Se non è specificata una data, verrà usata quella odierna. Nota che un eventuale valore dei secondi verrà ignorato.

Se non viene specificato un fuso orario, verrà usato quello locale. Se è presente uno specificatore di fuso FO, potrà essere il nome di sistema di un fuso (per esempio Europe/Rome), CET per rappresentare il fuso dell'Europa centrale, o Clock per usare l'orologio interno del computer e ignorare i fusi orari.

ritardo_annullamento

Fa annullare l'avviso se non può essere attivato entro il numero specificato di minuti dopo l'ora di attivazione pianificata dell'avviso. Se il valore è 0, l'avviso non sarà mai annullato indipendentemente dal ritardo.

flag

Specifica la combinazione OR logica dei flag desiderati per l'avviso. I bit dei flag sono quelli definiti nella classe KAlarmIface in kalarmiface.h. Nota che non tutti i bit dei flag sono rilevanti per gli avvisi con messaggio.

colore_sfondo

Specifica il colore di sfondo con cui visualizzare il messaggio. La stringa può essere nel formato «#RRVVBB» (come restituito da QColor::name()), dove RR, VV e BB sono valori esadecimali di due cifre di rosso, verde e blu. In alternativa, la stringa può essere in uno qualsiasi dei formati accettati da QColor::setNamedColor(), come un nome dei colori di X (per esempio «red» o «steelblue»). Imposta una stringa nulla per specificare l'attuale colore di sfondo predefinito.

colore_primo_piano

Specifica il colore di primo piano con cui visualizzare il messaggio. Il formato della stringa è lo stesso di colore_sfondo, oppure imposta una stringa nulla per specificare l'attuale colore di primo piano predefinito.

carattere

Specifica il carattere con cui visualizzare il messaggio. Il formato della stringa è quello prodotto da QFont::toString(). Imposta una stringa nulla per usare il carattere predefinito dei messaggi al momento della visualizzazione del messaggio.

URL_audio

Specifica il file audio da riprodurre quando viene visualizzato il messaggio. Imposta un valore nullo se non si deve riprodurre nessun file.

minuti_promemoria

Specifica quanti minuti in anticipo sull'avviso principale e su ogni sua ricorrenza (se ce ne sono) va visualizzato un promemoria per l'avviso. Specifica un valore negativo per un promemoria che va visualizzato dopo l'avviso principale. Specifica 0 se non se ne richiede nessuno.

ricorrenza

Specifica una ricorrenza regolare per l'avviso, usando la sintassi di iCalendar come definita nella RFC2445. Per esempio, «FREQ=MONTHLY;COUNT=4;INTERVAL=3;BYDAY=-1MO» specifica quattro ripetizioni mensili a intervalli trimestrali. Per un avviso senza ricorrenza, specifica una stringa vuota.

tipo_ricorrenza

Specifica il tipo di ricorrenza dell'avviso. I valori ammissibili sono «MINUTELY»,« DAILY», «WEEKLY», «MONTHLY» e «YEARLY». Questi sono definiti nella classe KAlarmIface in kalarmiface.h. Le ricorrenze mensili sono del tipo giorno del mese, quelle annuali sono del tipo data nell'anno, e la data è in entrambi i casi presa dal parametro data_ora_avvio.

intervallo_ricorrenza

Specifica quanti periodi (minuti, giorni, settimane, mesi, anni, come specificato da tipo_ricorrenza) ci devono essere tra le ripetizioni dell'avviso.

conteggio_ricorrenza

Specifica quante volte ripetere l'avviso. Specifica -1 per ripetere l'avviso indefinitamente.

data_ora_fine

Specifica la data finale (eventualmente con un'ora) delle ricorrenze dell'avviso. Se data_ora_avvio contiene un'ora, la deve avere anche questo parametro; se data_ora_avvio contiene solo una data, anche questo parametro deve avere solo quella. Non deve contenere uno specificatore di fuso: si usa lo stesso fuso di data_ora_avvio per interpretare il valore di questo campo.

intervallo_sottoripetizione

Specifica quanti minuti ci sono tra le sottoripetizioni dell'avviso. Specifica 0 per non avere nessuna ripetizione. Il parametro viene ignorato se non è specificata una ricorrenza.

conteggio_sottoripetizione

Specifica il numero di sottoripetizioni dell'avviso, inclusa la prima occorrenza.

Descrizione

scheduleMessage() è una chiamata D-Bus per pianificare la visualizzazione del messaggio di avviso specificato alla data e ora indicate. Ha tre forme: quella più generale permette di specificare una ricorrenza arbitraria, e si può usare anche per gli avvisi senza ripetizione. Le altre sono accessi di convenienza a un insieme limitato di tipi di ricorrenza degli avvisi, una per specificare un conteggio di ripetizione e un'altra per un'ora di conclusione.

Se l'ora pianificata (incluse eventuali ripetizioni) è già passata, KAlarm visualizzerà il messaggio immediatamente (a meno che il valore ritardo_annullamento indichi che è troppo tardi per visualizzare l'avviso, nel qual caso KAlarm ignorerà la richiesta). Se l'ora pianificata (o una ripetizione) è nel futuro, KAlarm aggiunge il messaggio di avviso al calendario predefinito degli avvisi attivi per visualizzarlo in seguito.