pimappservices/calendar/client/src/calentry.cpp
changeset 89 b57382753122
parent 18 c198609911f9
equal deleted inserted replaced
83:5aadd1120515 89:b57382753122
    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 */
   892 */
   892 */
   893 EXPORT_C void CCalEntry::SetPhoneOwnerL(const CCalUser* aOwner)
   893 EXPORT_C void CCalEntry::SetPhoneOwnerL(const CCalUser* aOwner)
   894 	{
   894 	{
   895 	iImpl->SetPhoneOwnerL(aOwner);
   895 	iImpl->SetPhoneOwnerL(aOwner);
   896 	}
   896 	}
       
   897 
       
   898 /** Clears the Organizer and phone owner.
       
   899 @pre None.
       
   900 @post The entry's organizer and phone owner is cleared.
       
   901 @publishedPartner
       
   902 @released
       
   903 @capability None
       
   904 */
       
   905 EXPORT_C void CCalEntry::ClearMRSpecificDataL()
       
   906     {
       
   907     iImpl->ClearMRSpecificDataL();
       
   908     }
       
   909 
   897 
   910 
   898 /** Gets the organizer for this entry.
   911 /** Gets the organizer for this entry.
   899 This function creates a new CCalUser object containing the organizer data.
   912 This function creates a new CCalUser object containing the organizer data.
   900 
   913 
   901 @return The organizer if present, NULL if not (Caller takes ownership).
   914 @return The organizer if present, NULL if not (Caller takes ownership).
  1141 TUint8 CCalEntry::ShortFileIdL()
  1154 TUint8 CCalEntry::ShortFileIdL()
  1142 	{
  1155 	{
  1143 	return iImpl->ShortFileIdL();
  1156 	return iImpl->ShortFileIdL();
  1144 	}
  1157 	}
  1145 
  1158 
  1146 /** Set the entry as favourite
  1159 /** Sets the user data field.
  1147    
  1160 
  1148 @param aFavourite value for favourite
  1161 @param aUserInt The userdata to be set
  1149 	positive integer for setting entry as favourite
  1162 @capability None
  1150 	zero for unmarking as favourite
  1163 @publishedAll
  1151 	
  1164 @released
  1152 @pre None
  1165 */
  1153 @post None
  1166 EXPORT_C void CCalEntry::SetUserInt32L( TUint32 aUserInt )    
  1154 @capability None
  1167     {       
  1155  */
  1168     iImpl->SetUserInt32L( aUserInt );       
  1156 EXPORT_C void CCalEntry::SetFavouriteL(TUint32 aFavourite)
  1169     }       
  1157 	{
  1170 
  1158 	iImpl->SetUserIntL(aFavourite);
  1171 /** Fetches the userdata field
  1159 	}
  1172 
  1160 
  1173 @publishedAll
  1161 /** Get favourite property from the entry
  1174 @released
  1162 
  1175 @capability None
  1163 @return TUint32 return value for favourite
  1176 @return The Userdata field.
  1164 	positive integer if entry is favourite
  1177 */
  1165 	zero if entry is not favourite 
  1178 EXPORT_C TUint32 CCalEntry::UserInt32L()       
  1166 @capability None
  1179     {       
  1167  */
  1180     return iImpl->UserInt32L();       
  1168 EXPORT_C TUint32 CCalEntry::FavouriteL()
  1181     }       
  1169 	{
       
  1170 	return iImpl->UserIntL();
       
  1171 	}
       
  1172 
  1182 
  1173 // CCalEntryId //
  1183 // CCalEntryId //
  1174 
  1184 
  1175 
  1185 
  1176 /** Allocates and constructs IDs for new entry of the specified type.
  1186 /** Allocates and constructs IDs for new entry of the specified type.