Namn
scheduleMessage — schemalägg ett nytt alarm.
Synopsis
bool scheduleMessage(const QString&meddelande, const QString&startdatum_tid, intavbryt_försenat, intflaggor, const QString&bg, const QString&fg, const QString&teckensnitt, const KUrl&ljudadress, intpåminnelse, const QString&upprepning, intdelrepetition_intervall, intdelrepetition_antal)
bool scheduleMessage(const QString&meddelande, const QString&startdatum_tid, intavbryt_försenat, intflaggor, const QString&bg, const QString&fg, const QString&teckensnitt, const KUrl&ljudadress, intpåminnelse, intupprepningstyp, intupprepningsintervall, intupprepningsantal)
bool scheduleMessage(const QString&meddelande, const QString&startdatum_tid, intavbryt_försenat, intflaggor, const QString&bg, const QString&fg, const QString&teckensnitt, const KUrl&ljudadress, intpåminnelse, intupprepningstyp, intupprepningsintervall, const QString&slut_datum_tid)
Parametrar
meddelandeAnger texten i meddelandet att schemalägga, eller om
flaggorhar bitenDISPLAY_COMMAND, anger kommandoraden att köra för att skapa texten i meddelandet.startdatum_tidAnger schemalagt datum, eller datum och tid, då meddelandet ska visas. Strängen ska vara på formatet ”ÅÅÅÅ-MM-DD [TZ]” för ett alarm med bara datum (som returneras av
QDate::toString(Qt::ISODate)). För ett alarm med ett datum och en tid, ska strängen vara på formatet ”ÅÅÅÅ-MM-DD TT:MM[:SS] [TZ]” (som returneras avQDateTime::toString(Qt::ISODate)) eller ”TT:MM[:SS] [Clock]” (som returneras avQTime::toString(Qt::ISODate)). Om inget datum anges, används dagens datum. Observera att ett eventuellt sekundvärde ignoreras.Om någon tidszon inte anges, förutsätts att den lokala systemtidszonen ska användas. Om en tidszonangivelse ”TZ” finns med, kan det vara namnet på en systemtidszon (t.ex. ”Europe/London”), ”UTC” som representerar tidszonen UTC, eller ”Clock” för att använda den lokala datorns klocka och ignorera tidszoner.
avbryt_försenatGör att alarmet avbryts om det inte kan visas inom angivet antal minuter efter alarmets schemalagda tid. Om värdet är 0, avbryts inte alarmet oberoende av hur sent det visas.
flaggorAnger logiskt eller av de önskade alarmflaggorna. Flaggbitarna är definierade i klassen
KAlarmIfaceikalarmiface.h. Observera att alla flaggbitar inte gäller meddelandealarm.bgAnger bakgrundsfärg för att visa meddelandet. Formatet på strängen kan vara ”#RRGGBB” (som returneras av
QColor::name()), där RR, GG och BB är tvåsiffrors hexadecimala värden för röd, grön och blå. Alternativt kan strängen vara något av de andra format som accepteras avQColor::setNamedColor(), såsom ett namn från X-färgdatabasen (t.ex. ”red” eller ”steelblue”). Ange strängens värde som null för att välja aktuell förvald bakgrundsfärg.fgAnger förgrundsfärg för att visa meddelandet. Formatet på strängen är samma som för
bg, eller alternativt kan strängens värde anges som null för att välja aktuell förvald förgrundsfärg.teckensnittAnger teckensnittet för att visa meddelandet. Strängens format är det som skrivs ut med
QFont::toString(). Ange strängens värde som null för att använda förvalt teckensnitt för meddelanden som gäller vid tiden då meddelandet visas.ljudadressAnger ljudfilen som ska spelas när meddelandet visas. Ange värdet null om ingen ljudfil ska spelas.
påminnelse_minuterAnger antal minuter i förväg innan huvudalarmet och varje upprepning (om det finns någon) som påminnelsen ska visas. Ange ett negativt värde för en påminnelse som ska visas efter huvudalarmet. Ange 0 om ingen påminnelse krävs.
upprepningAnger en regelbunden upprepning av alarmet, med iCalendar-syntax som definieras av RFC2445. Till exempel skulle ”FREQ=MONTHLY;COUNT=4;INTERVAL=3;BYDAY=-1MO” ange fyra upprepningar med tremånadersintervall den sista måndagen i månaden. För ett alarm som inte ska upprepas, ange en tom sträng.
upprepningstypAnger alarmets upprepningstyp. Tillåtna värden är MINUTELY, DAILY, WEEKLY, MONTHLY, YEARLY. Dessa definieras i klassen
KAlarmIfaceikalarmiface.h. Månatliga upprepningar är av typen dagen under månaden, och årliga upprepningar är av typen datum under året, där datumet i båda fall tas från väljarenstartdatum_tid.upprepningsintervallAnger antal perioder (minuter/dagar/veckor/månader/år som anges av
upprepningstyp) mellan upprepningar av alarmet.upprepningsantalAnger antalet gånger som alarmet ska upprepas. Ange -1 för att upprepa alarmet för evigt.
slut_datum_tidAnger slutdatum, eller datum och tid, för alarmets upprepningar. Om
startdatum_tidinnehåller en tid, måste den här väljaren också innehålla en tid. Omstartdatum_tidbara innehåller ett datum, måste den här väljaren också bara innehålla ett datum. Den får inte innehålla en specifikation av tidzon: samma tidzon som istartdatum_tidanvänds för att tolka parameterns värde.delrepetition_intervallAnger antalet minuter mellan delrepetitioner av alarmet. Ange 0 för ingen delrepetition. Ignoreras om ingen upprepning är angiven.
delrepetition_antalAnger antalet delrepetitioner av alarmet, inklusive ursprunglig aktivering.
Beskrivning
scheduleMessage() är ett D-Bus anrop för att schemalägga det angivna alarmmeddelandet för visning vid det angivna datumet och tiden. Det har tre former. De mest generella formen tillåter att en godtycklig upprepning anges. Använd den också för alarm som inte upprepas. De övriga formerna tillhandahåller bekväm åtkomst till en begränsad mängd upprepningstyper, den ena anger ett upprepningsantal och den andra en sluttid.
Om den schemalagda tiden (inklusive eventuella upprepningar) redan har gått ut, visar KAlarm omedelbart meddelandet (om inte värdet avbryt_försenat anger att det nu är för sent att visa alarmet, då KAlarm ignorerar begäran). Om den schemalagda tiden (eller en upprepning) är i framtiden, lägger KAlarm till alarmmeddelandet i den förvalda aktiva alarmkalendern för att visas senare.