Collapse all Symbian^3 Product Developer Library

CalenLauncher Class Reference

class CalenLauncher

CalenLauncher allows external applications to start the S60 Calendar application in any of its views.

Available launch options are:

Launch the Calendar and edit a new entry
Launch the Calendar and view an existing entry
Launch the Calendar and view an instance of a repeating entry
Launch the Calendar and edit an existing entry
Launch the Calendar and edit an instance of a repeating entry
Launch the Calendar to the default view
Launch the Calendar to the specified view
Launch the Calendar to the specified view at a given time and date

 // To create a new meeting
 CalenLauncher::NewEntryL( CCalEntry::EAppt );

 // To create a new todo
 CalenLauncher::NewEntryL( CCalEntry::ETodo );

 // To launch Calendar in the month view
 CalenLauncher::LaunchL( KCalMonthViewUid );

Public Member Functions
IMPORT_C void	EditEntryL(const TCalLocalUid &, TInt)
IMPORT_C void	EditEntryL(const TCalLocalUid &, const TCalTime &, TInt)
IMPORT_C void	LaunchL(const TUid &, TInt)
IMPORT_C void	LaunchL(const TUid &, const TCalTime &, TInt)
IMPORT_C void	NewEntryL(const CCalEntry::TType &, TInt)
IMPORT_C void	ViewEntryL(const TCalLocalUid &, TInt)
IMPORT_C void	ViewEntryL(const TCalLocalUid &, const TCalTime &, TInt)
IMPORT_C void	ViewEntryL(const TCalLocalUid &, const TCalTime &, const TDesC &, TInt)

Public Member Enumerations
enum	anonymous { EAlarmViewer = 0x01, EAlarmViewerNoSnooze = 0x02 }

Member Functions Documentation

EditEntryL(const TCalLocalUid &, TInt)

IMPORT_C void	EditEntryL	(	const TCalLocalUid &	aUid,
			TInt	aFlags = 0
		)	[static]

Opens a Calendar entry directly in the entry editor. If the entry is a repeating entry then entire series will be opened. Calendar will be closed when the editor is closed, even if it was already open. Any open dialogs (eg entry viewer or editor) will be closed. Opens a Calendar entry directly in the entry editor. If the entry is a repeating entry then entire series will be opened. Calendar will be closed when the editor is closed. Any open dialogs (eg entry viewer or editor) will be closed.

Parameters

const TCalLocalUid & aUid	LocalUid of the entry to view
TInt aFlags = 0	Reserved for future use

EditEntryL(const TCalLocalUid &, const TCalTime &, TInt)

IMPORT_C void	EditEntryL	(	const TCalLocalUid &	aUid,
			const TCalTime &	aInstanceTime,
			TInt	aFlags = 0
		)	[static]

Opens an instance of a repeating Calendar entry directly in the entry editor. Calendar will be closed when the editor is closed, even if it was already open. Any open dialogs (eg entry viewer or editor) will be closed. Opens an instance of a repeating Calendar entry directly in the entry editor. Calendar will be closed when the editor is closed. Any open dialogs (eg entry viewer or editor) will be closed.

Parameters

const TCalLocalUid & aUid	LocalUid of the entry to view
const TCalTime & aInstanceTime	Instance time of the repeated entry
TInt aFlags = 0	Reserved for future use

LaunchL(const TUid &, TInt)

IMPORT_C void	LaunchL	(	const TUid &	aViewUid,
			TInt	aFlags = 0
		)	[static]

Launches Calendar in the specified view. If Calendar is already running it will be brought to the foreground in the specified view. Any open dialogs (eg entry viewer or editor) will be closed. Launches Calendar in the specified view. If Calendar is already running it will be brought to the foreground in the specified view. Any open dialogs (eg entry viewer or editor) will be closed.

Parameters

const TUid & aViewUid	UID of the Calendar view to use.
TInt aFlags = 0	Reserved for future use

LaunchL(const TUid &, const TCalTime &, TInt)

IMPORT_C void	LaunchL	(	const TUid &	aViewUid,
			const TCalTime &	aFocusTime,
			TInt	aFlags = 0
		)	[static]

Launches Calendar in the specified view, focused to the specified time If Calendar is already running it will be brought to the foreground in the specified view. Any open dialogs (eg entry viewer or editor) will be closed. Launches Calendar in the specified view, focused to the specified time If Calendar is already running it will be brought to the foreground in the specified view. Any open dialogs (eg entry viewer or editor) will be closed.

Parameters

const TUid & aViewUid	UID of the Calendar view to use.
const TCalTime & aFocusTime	Initial focus time
TInt aFlags = 0	Reserved for future use

NewEntryL(const CCalEntry::TType &, TInt)

IMPORT_C void	NewEntryL	(	const CCalEntry::TType &	aEntryType,
			TInt	aFlags = 0
		)	[static]

Opens Calendar directly to the new entry editor. Calendar will be closed when the editor is closed, even if it was already open. Any open dialogs (eg entry viewer or editor) will be closed. Opens Calendar directly to the new entry editor. Calendar will be closed when the editor is closed. Any open dialogs (eg entry viewer or editor) will be closed.

Parameters

const CCalEntry::TType & aEntryType	Type of entry editor to open
TInt aFlags = 0	Reserved for future use

ViewEntryL(const TCalLocalUid &, TInt)

IMPORT_C void	ViewEntryL	(	const TCalLocalUid &	aUid,
			TInt	aFlags = 0
		)	[static]

Opens a Calendar entry directly in the entry viewer. If the entry is a repeating entry then entire series will be opened. The entry editor may be launched from the entry viewer. Calendar will be closed when the editor is closed, even if it was already open. Any open dialogs (eg entry viewer or editor) will be closed. Opens a Calendar entry directly in the entry viewer. If the entry is a repeating entry then entire series will be opened. The entry editor may be launched from the entry viewer. Calendar will be closed when the viewer is closed. Any open dialogs (eg entry viewer or editor) will be closed.

Parameters

const TCalLocalUid & aUid	LocalUid of the entry to view
TInt aFlags = 0	Reserved for future use

ViewEntryL(const TCalLocalUid &, const TCalTime &, TInt)

IMPORT_C void	ViewEntryL	(	const TCalLocalUid &	aUid,
			const TCalTime &	aInstanceTime,
			TInt	aFlags = 0
		)	[static]

Opens an instance of a repeating Calendar entry directly in the entry viewer. The entry editor may be launched from the entry viewer. Calendar will be closed when the editor is closed, even if it was already open. Any open dialogs (eg entry viewer or editor) will be closed. Opens an instance of a repeating Calendar entry directly in the entry viewer. The entry editor may be launched from the entry viewer. Calendar will be closed when the viewer is closed. Any open dialogs (eg entry viewer or editor) will be closed.

Parameters

const TCalLocalUid & aUid	LocalUid of the entry to view
const TCalTime & aInstanceTime	Instance time of the repeated entry
TInt aFlags = 0	Reserved for future use

ViewEntryL(const TCalLocalUid &, const TCalTime &, const TDesC &, TInt)

IMPORT_C void	ViewEntryL	(	const TCalLocalUid &	aUid,
			const TCalTime &	aInstanceTime,
			const TDesC &	aCalFileName,
			TInt	aFlags = 0
		)	[static]

Parameters

const TCalLocalUid & aUid	LocalUid of the entry to view
const TCalTime & aInstanceTime	Instance time of the repeated entry
const TDesC & aCalFileName	Calendar DB name of the repeated entry.
TInt aFlags = 0	Reserved for future use

Member Enumerations Documentation

Enum anonymous

Enumerators

EAlarmViewer = 0x01
EAlarmViewerNoSnooze = 0x02