📄 pimevent.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><!-- /home/edba/dist/qtopia/main-Sunday/qtopia/src/libraries/qtopiapim/event.cpp:40 --><html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>PimEvent Class</title><style type="text/css"><!--h3.fn,span.fn { margin-left: 1cm; text-indent: -1cm; }a:link { color: #004faf; text-decoration: none }a:visited { color: #672967; text-decoration: none }body { background: #ffffff; color: black; }--></style></head><body><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr><td width="200" align="left" valign="top"><a href="index.html"><img height="27" width="472" src="dochead.png" border="0"></a><br><font face="Arial,Helvetica,Geneva,Swiss,SunSans-Regular" align="center" size=32>Qtopia</font> <a href="index.html">Home</a> - <a href="qtopiaclasses.html">Classes</a> - <a href="qtopiaannotated.html">Annotated</a> - <a href="qtopiafunctions.html">Functions</a> - <a href="qtindex.html">Qt Embedded</a></td><td align="right" valign="top"> <table border="0" cellpadding="0" cellspacing="0" width="137"> <tr> <td><a href="http://www.trolltech.com/company/about/trolls.html"><img height="100" width="100" src="face.png" border="0"></a></td> <td><img height="100" width="100" src="qtlogo.png" align="top" border="0"></td> </tr> </table></td></tr></table><h1 align=center>PimEvent Class Reference<br><small>[<a href="qpepim.html">qpepim module</a>]</small></h1><p>The PimEvent class holds the data of a calendar event.<a href="#details">More...</a><p><tt>#include <<a href="event-h.html">event.h</a>></tt><p>Inherits <a href="pimrecord.html">PimRecord</a>.<p><a href="pimevent-members.html">List of all member functions.</a><h2>Public Members</h2><ul><li><div class=fn>enum <a href="#RepeatType-enum"><b>RepeatType</b></a> { NoRepeat, Daily, Weekly, MonthlyDate, MonthlyDay, Yearly, MonthlyEndDay }</div></li><li><div class=fn>enum <a href="#SoundTypeChoice-enum"><b>SoundTypeChoice</b></a> { Silent, Loud }</div></li><li><div class=fn><a href="#PimEvent"><b>PimEvent</b></a> ()</div></li><li><div class=fn><a href="#PimEvent-2"><b>PimEvent</b></a> ( const QDateTime & start, const QDateTime & end )</div></li><li><div class=fn>virtual <a href="#~PimEvent"><b>~PimEvent</b></a> ()</div></li><li><div class=fn>QString <a href="#description"><b>description</b></a> () const</div></li><li><div class=fn>QString <a href="#location"><b>location</b></a> () const</div></li><li><div class=fn>QDateTime <a href="#start"><b>start</b></a> () const</div></li><li><div class=fn>QDateTime <a href="#startInCurrentTZ"><b>startInCurrentTZ</b></a> () const</div></li><li><div class=fn>QDateTime <a href="#end"><b>end</b></a> () const</div></li><li><div class=fn>QDateTime <a href="#endInCurrentTZ"><b>endInCurrentTZ</b></a> () const</div></li><li><div class=fn>QString <a href="#notes"><b>notes</b></a> () const</div></li><li><div class=fn>TimeZone <a href="#timeZone"><b>timeZone</b></a> () const</div></li><li><div class=fn>bool <a href="#hasAlarm"><b>hasAlarm</b></a> () const</div></li><li><div class=fn>int <a href="#alarmDelay"><b>alarmDelay</b></a> () const</div></li><li><div class=fn>SoundTypeChoice <a href="#alarmSound"><b>alarmSound</b></a> () const</div></li><li><div class=fn>RepeatType <a href="#repeatType"><b>repeatType</b></a> () const</div></li><li><div class=fn>bool <a href="#hasRepeat"><b>hasRepeat</b></a> () const</div></li><li><div class=fn>int <a href="#frequency"><b>frequency</b></a> () const</div></li><li><div class=fn>int <a href="#weekOffset"><b>weekOffset</b></a> () const</div></li><li><div class=fn>QDate <a href="#repeatTill"><b>repeatTill</b></a> () const</div></li><li><div class=fn>QDate <a href="#repeatTillInCurrentTZ"><b>repeatTillInCurrentTZ</b></a> () const</div></li><li><div class=fn>bool <a href="#repeatForever"><b>repeatForever</b></a> () const</div></li><li><div class=fn>bool <a href="#showOnNearest"><b>showOnNearest</b></a> () const</div></li><li><div class=fn>bool <a href="#repeatOnWeekDay"><b>repeatOnWeekDay</b></a> ( int day ) const</div></li><li><div class=fn>bool <a href="#isException"><b>isException</b></a> () const</div></li><li><div class=fn>QUuid <a href="#seriesUid"><b>seriesUid</b></a> () const</div></li><li><div class=fn>bool <a href="#hasExceptions"><b>hasExceptions</b></a> () const</div></li><li><div class=fn>bool <a href="#isValid"><b>isValid</b></a> () const</div></li><li><div class=fn>QValueList<EventException> <a href="#eventExceptions"><b>eventExceptions</b></a> () const</div></li><li><div class=fn>bool <a href="#isAllDay"><b>isAllDay</b></a> () const</div></li><li><div class=fn>void <a href="#setAllDay"><b>setAllDay</b></a> ( bool enable = TRUE )</div></li><li><div class=fn>void <a href="#setDescription"><b>setDescription</b></a> ( const QString & text )</div></li><li><div class=fn>void <a href="#setLocation"><b>setLocation</b></a> ( const QString & text )</div></li><li><div class=fn>void <a href="#setStart"><b>setStart</b></a> ( const QDateTime & time )</div></li><li><div class=fn>void <a href="#setEnd"><b>setEnd</b></a> ( const QDateTime & time )</div></li><li><div class=fn>void <a href="#setNotes"><b>setNotes</b></a> ( const QString & text )</div></li><li><div class=fn>void <a href="#setTimeZone"><b>setTimeZone</b></a> ( const TimeZone & zone )</div></li><li><div class=fn>void <a href="#setAlarm"><b>setAlarm</b></a> ( int minutes, SoundTypeChoice s )</div></li><li><div class=fn>void <a href="#clearAlarm"><b>clearAlarm</b></a> ()</div></li><li><div class=fn>void <a href="#setRepeatType"><b>setRepeatType</b></a> ( RepeatType t )</div></li><li><div class=fn>void <a href="#setFrequency"><b>setFrequency</b></a> ( int freq )</div></li><li><div class=fn>void <a href="#setRepeatTill"><b>setRepeatTill</b></a> ( const QDate & date )</div></li><li><div class=fn>void <a href="#setRepeatForever"><b>setRepeatForever</b></a> ( bool b )</div></li><li><div class=fn>void <a href="#setShowOnNearest"><b>setShowOnNearest</b></a> ( bool b )</div></li><li><div class=fn>void <a href="#setRepeatOnWeekDay"><b>setRepeatOnWeekDay</b></a> ( int day, bool enable )</div></li><li><div class=fn>QDate <a href="#nextOccurrence"><b>nextOccurrence</b></a> ( const QDate & from, bool * ok = 0 ) const</div></li><li><div class=fn>QColor <a href="#color"><b>color</b></a> () const</div></li></ul><h2>Static Public Members</h2><ul><li><div class=fn>void <a href="#writeVCalendar"><b>writeVCalendar</b></a> ( const QString & filename, const QValueList<PimEvent> & events )</div></li><li><div class=fn>void <a href="#writeVCalendar-2"><b>writeVCalendar</b></a> ( const QString & filename, const PimEvent & event )</div></li><li><div class=fn>QValueList<PimEvent> <a href="#readVCalendar"><b>readVCalendar</b></a> ( const QString & filename )</div></li></ul><hr><a name="details"></a><h2>Detailed Description</h2>The PimEvent class holds the data of a calendar event.<p> This data includes descriptive data of the event and schedualing information.<p> <p>See also <a href="qpepim.html">Qtopia PIM Library</a>.<hr><h2>Member Type Documentation</h2><h3 class=fn><a name="RepeatType-enum"></a>PimEvent::RepeatType</h3><p> This enum type defines how an event repeats.<p> <ul><li><a href="#RepeatType-enum">NoRepeat</a> - Event occurs only once.<li><a href="#RepeatType-enum">Daily</a> - Event occurs every N days.<li><a href="#RepeatType-enum">Weekly</a> - Event occurs every N weeks.<li><a href="#RepeatType-enum">MonthlyDate</a> - Event occurs on the Xth day of the month every N months.<li><a href="#RepeatType-enum">MonthlyDay</a> - Event occurs on the Xth week of the month every N months.<li><a href="#RepeatType-enum">MonthlyEndDay</a> - Event occurs on the Xth last week of the month every N months.<li><a href="#RepeatType-enum">Yearly</a> - Event occurs every N years.</ul><p> <p>See also <a href="#frequency">frequency</a>(), <a href="#weekOffset">weekOffset</a>(), <a href="#showOnNearest">showOnNearest</a>() and <a href="#repeatOnWeekDay">repeatOnWeekDay</a>().<h3 class=fn><a name="SoundTypeChoice-enum"></a>PimEvent::SoundTypeChoice</h3><p> This enum type defines what kind of sound is made when an alarm occursfor an event. The currently defined types are:<p> <ul><li><a href="#SoundTypeChoice-enum">Silent</a> - No sound is produced.<li><a href="#SoundTypeChoice-enum">Loud</a> - A loud sound is produced.</ul><p> <p>See also <a href="#setAlarm">setAlarm</a>() and <a href="#alarmSound">alarmSound</a>().<hr><h2>Member Function Documentation</h2><h3 class=fn><a name="PimEvent"></a>PimEvent::PimEvent ()</h3>Constructs a new PimEvent.<h3 class=fn><a name="PimEvent-2"></a>PimEvent::PimEvent ( const QDateTime & start, const QDateTime & end )</h3>Constructs a new PimEvent starting at <em>start</em> and running till <em>end</em>.<h3 class=fn><a name="~PimEvent"></a>PimEvent::~PimEvent ()<tt> [virtual]</tt></h3>Destroys a PimEvent.<h3 class=fn>int <a name="alarmDelay"></a>PimEvent::alarmDelay () const</h3><p> Returns the number of minutes before the event to activate the alarmfor the event.<p> <p>See also <a href="#setAlarm">setAlarm</a>().<h3 class=fn><a href="pimevent.html#SoundTypeChoice-enum">SoundTypeChoice</a> <a name="alarmSound"></a>PimEvent::alarmSound () const</h3><p> Returns the type of alarm to sound.<p> <p>See also <a href="#setAlarm">setAlarm</a>() and <a href="#SoundTypeChoice-enum">SoundTypeChoice</a>.<h3 class=fn>void <a name="clearAlarm"></a>PimEvent::clearAlarm ()</h3>Clears any alarms set for the event.<p> <p>See also <a href="#setAlarm">setAlarm</a>().<h3 class=fn>QColor <a name="color"></a>PimEvent::color () const</h3>returns the color associated with the event.<h3 class=fn>QString <a name="description"></a>PimEvent::description () const</h3><p> Returns the description of the event.<p> <p>See also <a href="#setDescription">setDescription</a>().<h3 class=fn>QDateTime <a name="end"></a>PimEvent::end () const</h3><p> Returns when the first occurrence of the event starts.<p> <p>See also <a href="#endInCurrentTZ">endInCurrentTZ</a>() and <a href="#setEnd">setEnd</a>().<h3 class=fn>QDateTime <a name="endInCurrentTZ"></a>PimEvent::endInCurrentTZ () const</h3>Returns the end time of the event in the current system timezone.<p> <p>See also <a href="#end">end</a>().<h3 class=fn>QValueList<EventException> <a name="eventExceptions"></a>PimEvent::eventExceptions () const</h3> Returns the list of exceptions to the repeat rule for this event.<p> The exceptions are returned as a list of EventExceptions, with the form,<p> <pre> struct EventException { QDate date; <a href="quuid.html">QUuid</a> eventId; }; </pre><p> The date field is the date for which a repeating event would otherwise occur on.For instance, if an event would normally occur on July 1st, every year, and date isJuly 1st, 2000, then the event exception would indicate the repeating event wouldnot occur on July 1st, 2000. The date for each EventException is unique for thelist of exceptions returned.<p> If eventId is not null, then eventId describes an alturnate event that would occurinstead of the normal occurrance for the date specified by the date field. The eventit identifies does not have to occur on the same date as the date field. To extend theabove example, the event for eventId might occur on July 2nd, 2000. If the EventId is nullthen it describes an exception where no alternate event occurred.<p> <h3 class=fn>int <a name="frequency"></a>PimEvent::frequency () const</h3><p> Returns how often the event repeats.<p> <p>See also <a href="#setFrequency">setFrequency</a>().<h3 class=fn>bool <a name="hasAlarm"></a>PimEvent::hasAlarm () const</h3><p> Returns TRUE if there is an alarm set for the event. Otherwisereturns FALSE.<p> <p>See also <a href="#setAlarm">setAlarm</a>().<h3 class=fn>bool <a name="hasExceptions"></a>PimEvent::hasExceptions () const</h3>Returns TRUE if the event is a repeating event that has exceptions to the repeat pattern for that event.Otherwise returns FALSE.<p> <p>See also <a href="#isException">isException</a>() and <a href="#seriesUid">seriesUid</a>().<h3 class=fn>bool <a name="hasRepeat"></a>PimEvent::hasRepeat () const</h3><p> Returns FALSE if the event has repeat type NoRepeat. Otherwise returns TRUE.⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -