epoc32/include/calcontent.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@2
     4
// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@2
    16
#ifndef __CALCONTENT_H__
williamr@2
    17
#define __CALCONTENT_H__
williamr@2
    18
williamr@2
    19
#include <e32base.h>
williamr@2
    20
williamr@2
    21
class RReadStream;
williamr@2
    22
class RWriteStream;
williamr@2
    23
class CAgnContent;
williamr@2
    24
williamr@2
    25
NONSHARABLE_CLASS(CCalContent) : public CBase
williamr@2
    26
/**
williamr@2
    27
This class holds in memory 8-bit data of any type, or a link to 8-bit
williamr@2
    28
data such as a URI.  The MIME type of the data may also be held to help
williamr@2
    29
callers determine the appropriate application to launch the content.
williamr@2
    30
williamr@2
    31
Because the data is held in memory, callers should only use this class
williamr@2
    32
to store small amounts of data or a URI to some content elsewhere.
williamr@2
    33
williamr@2
    34
This class can be used to set an alarm action using
williamr@2
    35
CCalAlarm::SetAlarmAction() (such as a link to an internet
williamr@2
    36
radio station, or a small animated icon).
williamr@2
    37
williamr@2
    38
@see CCalAlarm
williamr@2
    39
@capability None
williamr@2
    40
@publishedAll
williamr@2
    41
@released
williamr@2
    42
*/
williamr@2
    43
	{
williamr@2
    44
public:
williamr@2
    45
	/** Disposition of the data which maybe used while setting an alarm. The data can be a link or inline.
williamr@2
    46
	@publishedPartner
williamr@2
    47
	@released
williamr@2
    48
	*/
williamr@2
    49
	enum TDisposition
williamr@2
    50
		{
williamr@2
    51
		/** URL disposition */
williamr@2
    52
		EDispositionUrl = 0,
williamr@2
    53
		/** Inline disposition */
williamr@2
    54
		EDispositionInline = 1,
williamr@2
    55
		/** Unknown disposition */
williamr@2
    56
		EDispositionUnknown = 15
williamr@2
    57
		};
williamr@2
    58
williamr@2
    59
	IMPORT_C static CCalContent* NewL();
williamr@2
    60
	IMPORT_C ~CCalContent();
williamr@2
    61
	IMPORT_C void SetContentL(TDesC8* aSmallContent, TDesC8* aContentMIMEType, CCalContent::TDisposition aContentDisposition);
williamr@2
    62
	IMPORT_C const TDesC8& Content() const;
williamr@2
    63
	IMPORT_C const TDesC8& MimeType() const;
williamr@2
    64
	IMPORT_C TDisposition Disposition() const;
williamr@2
    65
	CAgnContent* Impl() const;
williamr@2
    66
	void SetImpl(CAgnContent* aImpl);
williamr@2
    67
williamr@2
    68
private:
williamr@2
    69
	CCalContent();
williamr@2
    70
	void ConstructL();
williamr@2
    71
williamr@2
    72
private:
williamr@2
    73
	CAgnContent* iImpl;
williamr@2
    74
	};
williamr@2
    75
williamr@2
    76
williamr@2
    77
#endif // __CALCONTENT_H__