pimappservices/calendar/client/src/calentry.cpp
branchRCL_3
changeset 30 bd7edf625bdd
parent 29 12af337248b1
child 31 97232defd20e
equal deleted inserted replaced
29:12af337248b1 30:bd7edf625bdd
    26 The entry takes ownership of the Uid descriptor.
    26 The entry takes ownership of the Uid descriptor.
    27 
    27 
    28 Note that this function will not work unless a CCalSession has been created
    28 Note that this function will not work unless a CCalSession has been created
    29 by calling CCalSession::NewL().
    29 by calling CCalSession::NewL().
    30 
    30 
    31 @param aType One of: EAppt, ETodo, EEvent, EReminder, EAnniv, ENote to create
    31 @param aType One of: EAppt, ETodo, EEvent, EReminder, EAnniv to create
    32 an appointment, a todo, an event, a reminder or an anniversary entry.
    32 an appointment, a todo, an event, a reminder or an anniversary entry.
    33 @param aUid The Global UID of the entry. This field is mandatory. NewL takes ownership of the global UID.
    33 @param aUid The Global UID of the entry. This field is mandatory. NewL takes ownership of the global UID.
    34 @param aMethod The Method value describing the entry. Default value is EGSMethodNone.
    34 @param aMethod The Method value describing the entry. Default value is EGSMethodNone.
    35 @param aSeqNum The sequence number of the entry. Default value is 0.
    35 @param aSeqNum The sequence number of the entry. Default value is 0.
    36 @return Pointer to the new entry.
    36 @return Pointer to the new entry.
    50 /** Allocates and constructs a new entry of the specified type, Global UID,
    50 /** Allocates and constructs a new entry of the specified type, Global UID,
    51 sequence number and recurrence ID.
    51 sequence number and recurrence ID.
    52 
    52 
    53 The entry takes ownership of the Uid descriptor.
    53 The entry takes ownership of the Uid descriptor.
    54 
    54 
    55 @param aType One of: EAppt, ETodo, EEvent, EReminder, EAnniv, ENote to create
    55 @param aType One of: EAppt, ETodo, EEvent, EReminder, EAnniv to create
    56 an appointment, a todo, an event, a reminder or an anniversary entry.
    56 an appointment, a todo, an event, a reminder or an anniversary entry.
    57 @param aUid The Global UID of the entry. This field is mandatory. NewL takes ownership of the global UID.
    57 @param aUid The Global UID of the entry. This field is mandatory. NewL takes ownership of the global UID.
    58 @param aMethod The Method value describing the entry.
    58 @param aMethod The Method value describing the entry.
    59 @param aSeqNum The sequence number of the entry.
    59 @param aSeqNum The sequence number of the entry.
    60 @param aRecurrenceId The recurrence ID of the entry.
    60 @param aRecurrenceId The recurrence ID of the entry.
   511 	return iImpl->DescriptionL();
   511 	return iImpl->DescriptionL();
   512 	}
   512 	}
   513 
   513 
   514 /** Gets the type of entry.
   514 /** Gets the type of entry.
   515 
   515 
   516 @return The entry type. One of: EAppt, ETodo, EEvent, EReminder, EAnniv, ENote.
   516 @return The entry type. One of: EAppt, ETodo, EEvent, EReminder, EAnniv.
   517 
   517 
   518 @publishedAll
   518 @publishedAll
   519 @released
   519 @released
   520 @capability None
   520 @capability None
   521 */
   521 */
  1139 	}
  1139 	}
  1140 
  1140 
  1141 TUint8 CCalEntry::ShortFileIdL()
  1141 TUint8 CCalEntry::ShortFileIdL()
  1142 	{
  1142 	{
  1143 	return iImpl->ShortFileIdL();
  1143 	return iImpl->ShortFileIdL();
  1144 	}
       
  1145 
       
  1146 /** Set the entry as favourite
       
  1147    
       
  1148 @param aFavourite value for favourite
       
  1149 	positive integer for setting entry as favourite
       
  1150 	zero for unmarking as favourite
       
  1151 	
       
  1152 @pre None
       
  1153 @post None
       
  1154 @capability None
       
  1155  */
       
  1156 EXPORT_C void CCalEntry::SetFavouriteL(TUint32 aFavourite)
       
  1157 	{
       
  1158 	iImpl->SetUserIntL(aFavourite);
       
  1159 	}
       
  1160 
       
  1161 /** Get favourite property from the entry
       
  1162 
       
  1163 @return TUint32 return value for favourite
       
  1164 	positive integer if entry is favourite
       
  1165 	zero if entry is not favourite 
       
  1166 @capability None
       
  1167  */
       
  1168 EXPORT_C TUint32 CCalEntry::FavouriteL()
       
  1169 	{
       
  1170 	return iImpl->UserIntL();
       
  1171 	}
  1144 	}
  1172 
  1145 
  1173 // CCalEntryId //
  1146 // CCalEntryId //
  1174 
  1147 
  1175 
  1148