meetingrequest/mrcommon/inc/esmrdef.h
changeset 0 8466d47a6819
child 12 4ce476e64c59
equal deleted inserted replaced
-1:000000000000 0:8466d47a6819
       
     1 /*
       
     2 * Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies). 
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  Definitions for project mrui
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef ESMRDEF_H
       
    20 #define ESMRDEF_H
       
    21 
       
    22 //<cmail>
       
    23 #include "esmrcommands.h"
       
    24 
       
    25 /**
       
    26  * Enumeration for calendar entry types
       
    27  */
       
    28 enum TESMRCalendarEventType
       
    29     {
       
    30     EESMREventTypeAppt = 0,     // Appointment calendar item
       
    31     EESMREventTypeETodo,        // TO-DO calendar item
       
    32     EESMREventTypeEEvent,       // Event calendar item
       
    33     EESMREventTypeEReminder,    // Reminder calendar item
       
    34     EESMREventTypeEAnniv        // Anniversary calendar item
       
    35     };
       
    36 
       
    37 /**
       
    38  * Enumeration for response message type
       
    39  */
       
    40 enum TESMRResponseType
       
    41     {
       
    42     EESMRResponseDontSend = 0,  // Don't send response message
       
    43     EESMRResponsePlain,         // Response sent without message
       
    44     EESMRResponseMessage        // Response sent with message
       
    45     };
       
    46 
       
    47 /**
       
    48  * Enumeration for MRUI  query mode
       
    49  */
       
    50 enum TESMRQueryMode
       
    51     {
       
    52     EESMRQueryModeNo,           // Do not perform queries
       
    53     EESMRQueryModeYes           // Perform queries
       
    54     };
       
    55 
       
    56 /**
       
    57  * Definitions for ES MR policies
       
    58  */
       
    59 enum TESMRPolicyID
       
    60     {
       
    61     // PolicyId unspecified
       
    62     EESMRPolicyUnspecified = 0,
       
    63     // Receive MR from mail
       
    64     EESMRPolicyReceiveMRFromEmail,
       
    65     // Organizer edit MR from calendar
       
    66     EESMRPolicyOrganizerEditMRFromCal,
       
    67     // Organizer view MR from calendar
       
    68     EESMRPolicyOrganizerViewMRFromCal,
       
    69     // Attendee  view MR from calendar
       
    70     EESMRPolicyAttendeeViewMRFromCal,
       
    71     // Forward MR from calendar as MR
       
    72     EESMRPolicyForwardAsMeetingRequestFromCal,
       
    73     // Forward MR from mail as MR
       
    74     EESMRPolicyForwardAsMeetingRequestFromMail,
       
    75     // Edit locally from calendar
       
    76     EESMRPolicyAttendeeEditMRFromCal,
       
    77     // Meeting editor policy
       
    78     EESMRPolicyMeetingEditor,
       
    79     // Meeting viewer policy
       
    80     EESMRPolicyMeetingViewer,
       
    81     // TO-DO editor policy
       
    82     EESMRPolicyTodoEditor,
       
    83     // TO-DO viewer policy
       
    84     EESMRPolicyTodoViewer,
       
    85     // Memo editor policy
       
    86     EESMRPolicyMemoEditor,
       
    87     // Memo viewer policy
       
    88     EESMRPolicyMemoViewer,
       
    89     // Anniversary editor policy
       
    90     EESMRPolicyAnniversaryEditor,
       
    91     // Anniversary viewer policy
       
    92     EESMRPolicyAnniversaryViewer,
       
    93     EESMRPolicyAttendeeViewAllDayEventMRFromCal,
       
    94     // Attendee - view allday MR from email app
       
    95     EESMRPolicyAttendeeViewAllDayEventMRFromEmail,
       
    96     // Attendee - view allday MR from calendar app
       
    97     EESMRPolicyOrganizerViewAllDayEventMRFromCal,
       
    98     // Organzier  - view allday MR from email app
       
    99     EESMRPolicyOrganizerViewAllDayEventMRFromEmail,
       
   100     // Tracking view policy
       
   101     EESMRPolicyTrackingView,
       
   102     // Organizer view MR from email
       
   103     EESMRPolicyOrganizerViewMREmail
       
   104     // Add new policies here
       
   105     };
       
   106 
       
   107 /**
       
   108  * Definition for MRUI MR view mode
       
   109  */
       
   110 enum TESMRViewMode
       
   111     {
       
   112     EESMRViewUndef = 1,         // MR view mode not specified
       
   113     EESMRViewMR,                // MR view mode (read-only)
       
   114     EESMREditMR,                // MR edit mode
       
   115     EESMRForwardMR,             // MR forward mode
       
   116     EESMRViewAllDayMR,           // MR view mode for all day events (read-only)
       
   117     EESMRTrackingViewMR         // MR Tracking view mode
       
   118     };
       
   119 
       
   120 /**
       
   121  * Definition for ES MR fields
       
   122  */
       
   123 enum TESMREntryFieldId
       
   124     {
       
   125     // Response area
       
   126     EESMRFieldResponseArea = 1,
       
   127     // Response ready area, this is created always
       
   128     // when EESMRFieldResponseArea is given by policy
       
   129     EESMRFieldResponseReadyArea,
       
   130     // Response area with one item, this used at runtime.
       
   131     // Not working in policy. The EESMRFieldResponseArea should be used in
       
   132     // policy. If the response is e.g. Cancelled then this is used
       
   133     // solve the measures of the ui components.
       
   134     EESMRFieldResponseAreaWithOneItem,
       
   135     // Organizer field
       
   136     EESMRFieldOrganizer,
       
   137     // Attendee & opt attendee label
       
   138     EESMRFieldAttendeeLabel,
       
   139     // Attendee field
       
   140     EESMRFieldAttendee,
       
   141     // Optional attendee field
       
   142     EESMRFieldOptAttendee,
       
   143     // Meeting time
       
   144     EESMRFieldMeetingTime,
       
   145     // Start date
       
   146     EESMRFieldStartDate,
       
   147     // End date
       
   148     EESMRFieldStopDate,
       
   149     // Location
       
   150     EESMRFieldLocation,
       
   151     // Alarm
       
   152     EESMRFieldAlarm,
       
   153     // Alarm date field
       
   154     EESMRFieldAlarmDate,
       
   155     // Subject field
       
   156     EESMRFieldSubject,
       
   157     // Description
       
   158     EESMRFieldDescription,
       
   159     // Recurrence
       
   160     EESMRFieldRecurrence,
       
   161     // Recurrence until-date field
       
   162     EESMRFieldRecurrenceDate,
       
   163     // Priority
       
   164     EESMRFieldPriority,
       
   165     // All day event
       
   166     EESMRFieldAllDayEvent,
       
   167     // Alarm (on/off) for all day event
       
   168     EESMRFieldAlarmOnOff,
       
   169     // Time for all day event alarm
       
   170     EESMRFieldAlarmTime,
       
   171     // Synchronization
       
   172     EESMRFieldSync,
       
   173     // Occasion
       
   174     EESMRFieldOccasion,
       
   175     // Date field
       
   176     EESMRFieldDate,
       
   177     // Basic viewer field
       
   178     EESMRFieldViewerBasic,
       
   179     // Additional Subject field for viewer
       
   180     EESMRFieldDetailedSubject,
       
   181     // Attachments field
       
   182     EESMRFieldAttachments,
       
   183     // Tracking required attendeee field
       
   184     EESMRFieldReqTrack,
       
   185     // Tracking Optional Attendee field
       
   186     EESMRFieldOptTrack,
       
   187     // Tracking status
       
   188     EESMRTrackStatus
       
   189     };
       
   190 
       
   191 /**
       
   192  * Definition for MRUI GUI field type
       
   193  */
       
   194 enum TESMRFieldType
       
   195     {
       
   196     EESMRFieldTypeDefault,      // Default field
       
   197     EESMRFieldTypeAdditional    // Additional field
       
   198     };
       
   199 
       
   200 /**
       
   201  * Definition for MRUI GUI field mode
       
   202  */
       
   203 enum TESMRFieldMode
       
   204     {
       
   205     EESMRFieldModeView,     // Viewable (read only) field
       
   206     EESMRFieldModeEdit      // Editable field
       
   207     };
       
   208 
       
   209 /**
       
   210  * Definition for meeting request user role
       
   211  */
       
   212 enum TESMRRole
       
   213     {
       
   214     EESMRRoleUndef            = 0,     // Undefined
       
   215     EESMRRoleOrganizer        = 0x01,  // Organizer
       
   216     EESMRRoleRequiredAttendee = 0x02,  // Participant
       
   217     EESMRRoleOptionalAttendee = 0x04,  // Participant
       
   218     EESMRRoleNonParticipant   = 0x08   // Non-Participant
       
   219     };
       
   220 
       
   221 // Flag definitions for for meeting request user role
       
   222 // These should be used in resource files
       
   223 #define KEESMRFlagOrganizer 0x01
       
   224 #define KEESMRFlagRequiredAttendee 0x02
       
   225 #define KEESMRFlagOptionalAttendee 0x04
       
   226 #define KEESMRFlagNonParticipant 0x08
       
   227 
       
   228 /**
       
   229  * Definition for applications using MRUI subsystem
       
   230  */
       
   231 enum TESMRUsingApp
       
   232     {
       
   233     EESMRAppUndef    = 0x00, // undefined
       
   234     EESMRAppCalendar = 0x01, // ES Calendar
       
   235     EESMRAppESEmail  = 0x02  // ES Email
       
   236     };
       
   237 
       
   238 // Resource definitions for MRUI client application
       
   239 // These should be used in resource files
       
   240 #define KEESMRFlagAppUndef 0x00
       
   241 #define KEESMRFlagAppEsCalendar 0x01
       
   242 #define KEESMRFlagAppEsEmail 0x02
       
   243 
       
   244 /**
       
   245  * Meeting reqeust mode definition
       
   246  */
       
   247 enum TESMREntryMode
       
   248     {
       
   249     EESMREntryNoRecurrent,          // No recurrent event
       
   250     EESMREntryRecurrent             // Recurrent event
       
   251     };
       
   252 
       
   253 /**
       
   254  * Recurrence definition
       
   255  */
       
   256 enum TESMRRecurrenceValue
       
   257     {
       
   258     ERecurrenceNot = 0,             // No recurrence
       
   259     ERecurrenceDaily,               // Daily recurrence
       
   260     ERecurrenceWeekly,              // Weekly recurrence
       
   261     ERecurrenceEverySecondWeek,     // Bi-weekly recurrence
       
   262     ERecurrenceMonthly,             // Monthly recurrence
       
   263     ERecurrenceYearly,              // Yearly recurrence
       
   264     ERecurrenceUnknown              // Unknown recurrence
       
   265     };
       
   266 
       
   267 /**
       
   268  * Definition for relative alarm values.
       
   269  */
       
   270 enum TESMRAlarmValue
       
   271     {
       
   272     EAlarmOff = 0,          // No alarm
       
   273     EAlarmZeroMinutes,      // 0 minutes before
       
   274     EAlarmFiveMinutes,      // 5 minutes before
       
   275     EAlarmFifteenMinutes,   // 15 minutes before
       
   276     EAlarmThirtyMinutes,    // 30 minutes before
       
   277     EAlarmOneHour,          // 1 hour before
       
   278     EAlarmTwoHours,         // 2 hours before
       
   279     EAlarmThreeHours,       // 3 hours before
       
   280     EAlarmFourHours,        // 4 hours before
       
   281     EAlarmFiveHours,        // 5 hours before
       
   282     EAlarmSixHours,         // 6 hours before
       
   283     EAlarmSevenHours,       // 7 hours before
       
   284     EAlarmEightHours,       // 8 hours before
       
   285     EAlarmTwelveHours,      // 12 hours before
       
   286     EAlarmOneDay,           // 1 day before
       
   287     EAlarmTwoDays,          // 2 days before
       
   288     EAlarmOneWeek           // 1 week before
       
   289     };
       
   290 
       
   291 /**
       
   292  * Definition for synchronization values
       
   293  */
       
   294 enum TESMRSyncValue
       
   295    {
       
   296    ESyncNone,           // No synchronization
       
   297    ESyncPrivate,        // Private synchronization
       
   298    ESyncPublic          // Public synchronization
       
   299    };
       
   300 
       
   301 /** 
       
   302  * Enumeration for 'Send update' query results
       
   303  */
       
   304 enum TESMRSendUpdateQueryResponeStatus
       
   305     {
       
   306     EESMRSendToAllParticipants = 0,         // Send to all participants
       
   307     EESMRSendToAddedOrRemovedParticipants   // Send to added / removed
       
   308     };
       
   309 
       
   310 /**
       
   311  * Enumeration for 'Edit recurrent MR' query results
       
   312  */
       
   313 enum TESMRThisOccurenceOrSeriesQuery
       
   314     {
       
   315     EESMRThisOccurence = 0,             // Only this MR entry
       
   316     EESMRSeries                         // All MR entries
       
   317     };
       
   318 
       
   319 #ifndef FSCALENCOMMON_HRH
       
   320 /** 
       
   321  * Priorities for meeting request entries.
       
   322  */
       
   323 enum TFSCalenMRPriority
       
   324     {
       
   325     EFSCalenMRPriorityUnknown = 0,      // Unknown priority
       
   326     EFSCalenMRPriorityHigh = 1,         // High priority
       
   327     EFSCalenMRPriorityNormal = 5,       // Normal priority
       
   328     EFSCalenMRPriorityLow = 9           // Low priority
       
   329     };
       
   330 
       
   331 /** 
       
   332  * Priorities for to-do items
       
   333  */
       
   334 enum TFSCalenTodoPriority
       
   335     {
       
   336     EFSCalenTodoPriorityHigh = 1,
       
   337     EFSCalenTodoPriorityNormal,
       
   338     EFSCalenTodoPriorityLow
       
   339     };
       
   340 
       
   341 #endif // FSCALENCOMMON_HRH
       
   342 
       
   343 /**
       
   344  * Enumeration for email plug-in codes
       
   345  */
       
   346 enum TESMRMailPlugin
       
   347     {
       
   348     // Unknow plug-in
       
   349     EESMRUnknownPlugin,
       
   350     // ActiceSync plug-in
       
   351     EESMRActiveSync,
       
   352     // IntelliSync plug-in
       
   353     EESMRIntelliSync,
       
   354     // IMAP-POP plug-in
       
   355     EESMRImapPop
       
   356     };
       
   357 
       
   358 // ESMRICALVIEWER definitions
       
   359 #include "esmricalviewerdefs.hrh"
       
   360 //</cmail>
       
   361 
       
   362 #endif // ESMRDEF_H
       
   363 
       
   364 // EOF