pimevent.html

qtopiaphone英文帮助,用于初学者和开发人员,初学者可以用来学习,开发人员可以用来资料查询.

<p> <p>See also <a href="#setRepeatType">setRepeatType</a>() and <a href="#RepeatType-enum">RepeatType</a>.

<h3 class=fn>bool <a name="isAllDay"></a>PimEvent::isAllDay () const
</h3>

<p> Returns TRUE if the event is an all day event.  Otherwise returns FALSE.
<p> <p>See also <a href="#setAllDay">setAllDay</a>().

<h3 class=fn>bool <a name="isException"></a>PimEvent::isException () const
</h3>
Returns TRUE if this event represents an exception to the repeat
pattern of another event.  Otherwise returns FALSE.
<p> For example if a daily event at 10am
starts on 11am one day, the 11am would be represent an exception
to the 10am repeating event.
<p> <p>See also <a href="#hasExceptions">hasExceptions</a>() and <a href="#seriesUid">seriesUid</a>().

<h3 class=fn>bool <a name="isValid"></a>PimEvent::isValid () const
</h3>
Returns TRUE if the event can occur.  Otherwise returns FALSE.

<h3 class=fn>QString <a name="location"></a>PimEvent::location () const
</h3>

<p> Returns the location of the event.
<p> <p>See also <a href="#setLocation">setLocation</a>().

<h3 class=fn>QDate <a name="nextOccurrence"></a>PimEvent::nextOccurrence ( const&nbsp;QDate&nbsp;&amp;&nbsp;from, bool&nbsp;*&nbsp;ok = 0 ) const
</h3>
Returns the first date on or after <em>from</em> that the event will next occur.
If the event only occurs once (no repeat) will return the date of the
start of the event if the start of the event is on or after <em>from</em>.
<p> If <em>ok</em> is non-NULL, *ok is set to TRUE if the event occurs on or
after <em>from</em> and FALSE if the event does not occur on or after
<em>from</em>.

<h3 class=fn>QString <a name="notes"></a>PimEvent::notes () const
</h3>

<p> Returns the notes of the event.
<p> <p>See also <a href="#setNotes">setNotes</a>().

<h3 class=fn>QValueList&lt;PimEvent&gt; <a name="readVCalendar"></a>PimEvent::readVCalendar ( const&nbsp;QString&nbsp;&amp;&nbsp;filename )<tt> [static]</tt>
</h3>
Reads the file specified by <em>filename</em> as a list of vCalendar objects
and returns the list of near equivalent events.
<p> <p>See also <a href="#writeVCalendar">writeVCalendar</a>().

<h3 class=fn>bool <a name="repeatForever"></a>PimEvent::repeatForever () const
</h3>
Returns TRUE if the event will repeat forever.  Otherwise returns FALSE.
<p> <p>See also <a href="#repeatTill">repeatTill</a>() and <a href="#setRepeatForever">setRepeatForever</a>().

<h3 class=fn>bool <a name="repeatOnWeekDay"></a>PimEvent::repeatOnWeekDay ( int&nbsp;day ) const
</h3>
If the repeat type of the event is Weekly and the event is set to repeat on
<em>day</em> of the week, then returns TRUE.  Otherwise returns FALSE.
<p> <p>See also <a href="#setRepeatOnWeekDay">setRepeatOnWeekDay</a>().

<h3 class=fn>QDate <a name="repeatTill"></a>PimEvent::repeatTill () const
</h3>
Returns the date the event will repeat until
<p> <p>See also <a href="#repeatForever">repeatForever</a>() and <a href="#setRepeatTill">setRepeatTill</a>().

<h3 class=fn>QDate <a name="repeatTillInCurrentTZ"></a>PimEvent::repeatTillInCurrentTZ () const
</h3>
Returns the date the event will repeat till in the current system timezone.
<p> <p>See also <a href="#repeatTill">repeatTill</a>().

<h3 class=fn><a href="pimevent.html#RepeatType-enum">RepeatType</a> <a name="repeatType"></a>PimEvent::repeatType () const
</h3>

<p> Returns the RepeatType of the event.
<p> <p>See also <a href="#setRepeatType">setRepeatType</a>() and <a href="#RepeatType-enum">RepeatType</a>.

<h3 class=fn><a href="quuid.html">QUuid</a> <a name="seriesUid"></a>PimEvent::seriesUid () const
</h3> 
If the event is an exception to a recuring event
returns the UID for the event this event is an exception to.
Otherwise returns the UID of this event.
<p> <p>See also <a href="#hasExceptions">hasExceptions</a>() and <a href="#isException">isException</a>().

<h3 class=fn>void <a name="setAlarm"></a>PimEvent::setAlarm ( int&nbsp;minutes, <a href="pimevent.html#SoundTypeChoice-enum">SoundTypeChoice</a>&nbsp;s )
</h3>
Sets an alarm for the event, <em>minutes</em> before the start of the event, with
an alarm type of <em>s</em>.
<p> <p>See also <a href="#clearAlarm">clearAlarm</a>(), <a href="#hasAlarm">hasAlarm</a>(), <a href="#alarmSound">alarmSound</a>() and <a href="#alarmDelay">alarmDelay</a>().

<h3 class=fn>void <a name="setAllDay"></a>PimEvent::setAllDay ( bool&nbsp;enable = TRUE )
</h3>
Sets whether the event is an an all day event to <em>enable</em>.
All day events have a no set time-zone (empty string).
<p> <p>See also <a href="#isAllDay">isAllDay</a>() and <a href="#setTimeZone">setTimeZone</a>().

<h3 class=fn>void <a name="setDescription"></a>PimEvent::setDescription ( const&nbsp;QString&nbsp;&amp;&nbsp;text )
</h3>
Sets the description of the event to <em>text</em>.
<p> <p>See also <a href="#description">description</a>().

<h3 class=fn>void <a name="setEnd"></a>PimEvent::setEnd ( const&nbsp;QDateTime&nbsp;&amp;&nbsp;time )
</h3>
Sets the end time of the event to <em>time</em>.
This will also change the duration of the event. <em>time</em> must be at least
5 minutes after the start time of the event.
<p> <p>See also <a href="#end">end</a>() and <a href="#endInCurrentTZ">endInCurrentTZ</a>().

<h3 class=fn>void <a name="setFrequency"></a>PimEvent::setFrequency ( int&nbsp;freq )
</h3>
Sets the frequency of the event to <em>freq</em>.  If <em>freq</em> is less than 1
will set the frequency of the event to 1.
<p> <p>See also <a href="#frequency">frequency</a>().

<h3 class=fn>void <a name="setLocation"></a>PimEvent::setLocation ( const&nbsp;QString&nbsp;&amp;&nbsp;text )
</h3>
Set the location of the event to <em>text</em>.
<p> <p>See also <a href="#location">location</a>().

<h3 class=fn>void <a name="setNotes"></a>PimEvent::setNotes ( const&nbsp;QString&nbsp;&amp;&nbsp;text )
</h3>
Sets the notes of the event to <em>text</em>.
<p> <p>See also <a href="#notes">notes</a>().

<h3 class=fn>void <a name="setRepeatForever"></a>PimEvent::setRepeatForever ( bool&nbsp;b )
</h3>
If <em>b</em> is TRUE then sets the event to repeat forever.  Otherwise event
will repeat until repeatUntil()
<p> <p>See also <a href="#repeatForever">repeatForever</a>().

<h3 class=fn>void <a name="setRepeatOnWeekDay"></a>PimEvent::setRepeatOnWeekDay ( int&nbsp;day, bool&nbsp;enable )
</h3>
Sets the event to repeat on the <em>day</em> of the wekif <em>enable</em> is TRUE.
Otherwise sets the event not to repeat on the <em>day</em> of the week.
<p> Event will always repeat on the day of the week that it started on.
<p> <p>See also <a href="#repeatOnWeekDay">repeatOnWeekDay</a>().

<h3 class=fn>void <a name="setRepeatTill"></a>PimEvent::setRepeatTill ( const&nbsp;QDate&nbsp;&amp;&nbsp;date )
</h3>
Sets the date the event will repeat until to <em>date</em>.  If date is before
the end of the first event will set the event to occur once.
<p> <p>See also <a href="#repeatTill">repeatTill</a>() and <a href="#repeatForever">repeatForever</a>().

<h3 class=fn>void <a name="setRepeatType"></a>PimEvent::setRepeatType ( <a href="pimevent.html#RepeatType-enum">RepeatType</a>&nbsp;t )
</h3>
Sets the repeat type of the event to <em>t</em>.
<p> <p>See also <a href="#repeatType">repeatType</a>(), <a href="#hasRepeat">hasRepeat</a>() and <a href="#RepeatType-enum">RepeatType</a>.

<h3 class=fn>void <a name="setShowOnNearest"></a>PimEvent::setShowOnNearest ( bool&nbsp;b )
</h3>
Sets whether to show a repeating event on the nearest previous date if the
day it would repeat on does not exist to <em>b</em>.
<p> An example would be a repeating event that occures on the 31st of each month.
Setting showOnNearest to TRUE will have the event show up on the 30th on
months that do not have 31 days, (or 28/29 in the case of Febuary).
<p> <p>See also <a href="#showOnNearest">showOnNearest</a>().

<h3 class=fn>void <a name="setStart"></a>PimEvent::setStart ( const&nbsp;QDateTime&nbsp;&amp;&nbsp;time )
</h3>
Sets the start time of the event to <em>time</em>.
This will change the end time fo the event to maintain the same duration.
<p> <p>See also <a href="#start">start</a>() and <a href="#startInCurrentTZ">startInCurrentTZ</a>().

<h3 class=fn>void <a name="setTimeZone"></a>PimEvent::setTimeZone ( const&nbsp;<a href="timezone.html">TimeZone</a>&nbsp;&amp;&nbsp;zone )
</h3>
Sets the time zone of the event to <em>zone</em>.
This will affect when the event occurs in UTC.  All day events cannot have
a time zone set.
<p> Setting the time zone to an invalid <a href="timezone.html">TimeZone</a> will cause the event to
have no associated time zone.
<p> <p>See also <a href="#timeZone">timeZone</a>() and <a href="#isAllDay">isAllDay</a>().

<h3 class=fn>bool <a name="showOnNearest"></a>PimEvent::showOnNearest () const
</h3>

<p> Returns if the event should be shown on the nearest match of an occurrence
if the exact date the event would occur is not a valid date.
<p> <p>See also <a href="#setShowOnNearest">setShowOnNearest</a>().

<h3 class=fn>QDateTime <a name="start"></a>PimEvent::start () const
</h3>

<p> Returns when the first occurrence of the event starts.
<p> <p>See also <a href="#startInCurrentTZ">startInCurrentTZ</a>() and <a href="#setStart">setStart</a>().

<h3 class=fn>QDateTime <a name="startInCurrentTZ"></a>PimEvent::startInCurrentTZ () const
</h3>
Returns the start time of the event in the current system timezone.
<p> <p>See also <a href="#start">start</a>().

<h3 class=fn><a href="timezone.html">TimeZone</a> <a name="timeZone"></a>PimEvent::timeZone () const
</h3>
Returns the time zone of the event or an invalid <a href="timezone.html">TimeZone</a> if the event has
no time zone.  All day events allways have no time zone.
<p> <p>See also <a href="#setTimeZone">setTimeZone</a>() and <a href="#isAllDay">isAllDay</a>().

<h3 class=fn>int <a name="weekOffset"></a>PimEvent::weekOffset () const
</h3>
Returns the instance of the week the event will occur for the repeat types
MonthlyDay and MonthlyEndDay.  The week offset is determined by the starting
date of the event.
<p> if (<a href="#weekOffset">weekOffset</a>() == 1) event occurs in first week of the month.
if (weekOffset() == 3) event occurs in third week of the month.
if (weekOffset() == -1) event occurs in last week of the month.
<p> Returns 0 if there is no week offset for the event.

<h3 class=fn>void <a name="writeVCalendar"></a>PimEvent::writeVCalendar ( const&nbsp;QString&nbsp;&amp;&nbsp;filename, const&nbsp;QValueList&lt;PimEvent&gt;&nbsp;&amp;&nbsp;events )<tt> [static]</tt>
</h3>
Write the list of <em>events</em> as vCalendar objects to the file
specified by <em>filename</em>.
<p> <p>See also <a href="#readVCalendar">readVCalendar</a>().

<h3 class=fn>void <a name="writeVCalendar-2"></a>PimEvent::writeVCalendar ( const&nbsp;QString&nbsp;&amp;&nbsp;filename, const&nbsp;<a href="pimevent.html">PimEvent</a>&nbsp;&amp;&nbsp;event )<tt> [static]</tt>
</h3>
Write the <em>event</em> as a vCalendar to the file specified by <em>filename</em>.
<p> <p>See also <a href="#readVCalendar">readVCalendar</a>().

<!-- eof -->
<hr><p>
This file is part of the <a href="../index.html">Qtopia</a> platform,
copyright &copy; 1995-2004
<a href="http://www.trolltech.com/">Trolltech</a>, all rights reserved.<p><address><hr><div align="center">
<table width="100%" cellspacing="0" border="0">
<tr>
<td>Copyright &copy; 2001-2004 Trolltech
<td><a href="http://www.trolltech.com/trademarks.html">Trademarks</a>
<td align="right"><div align="right">Qtopia version 2.0.0</div>
</table></div></address></body>
</html>