inc/NPRDocument.h
author tahirm@symbian.org
Fri, 24 Jul 2009 08:46:02 +0100
changeset 0 0049171ecffb
child 1 7c64bff801d1
permissions -rw-r--r--
initial release
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
     1
/*
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
     2
 ============================================================================
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
     3
 Name	: NPRDocument.h
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
     4
 Author	: John Kern
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
     5
 
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
     6
 Copyright (c) 2009 Symbian Foundation Ltd
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
     7
 This component and the accompanying materials are made available
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
     8
 under the terms of the License "Eclipse Public License v1.0"
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
     9
 which accompanies this distribution, and is available
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    10
 at the URL "http://www.eclipse.org/legal/epl-v10.html".
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    11
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    12
 Initial Contributors:
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    13
 - Symbian Foundation Ltd - initial contribution.
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    14
 
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    15
 Contributors:
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    16
 - John Kern
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    17
 - Symsource
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    18
 
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    19
 Description : Declares document class for application.
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    20
 ============================================================================
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    21
 */
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    22
 
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    23
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    24
#ifndef __NPR_DOCUMENT_H__
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    25
#define __NPR_DOCUMENT_H__
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    26
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    27
// INCLUDES
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    28
#include <akndoc.h>
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    29
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    30
#include "NPRStory.h"
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    31
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    32
// FORWARD DECLARATIONS
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    33
class CNPRAppUi;
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    34
class CEikApplication;
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    35
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    36
// CLASS DECLARATION
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    37
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    38
/**
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    39
 * CNPRDocument application class.
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    40
 * An instance of class CNPRDocument is the Document part of the
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    41
 * AVKON application framework for the NPR example application.
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    42
 */
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    43
class CNPRDocument : public CAknDocument
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    44
	{
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    45
public:
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    46
	// Constructors and destructor
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    47
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    48
	/**
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    49
	 * NewL.
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    50
	 * Two-phased constructor.
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    51
	 * Construct a CNPRDocument for the AVKON application aApp
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    52
	 * using two phase construction, and return a pointer
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    53
	 * to the created object.
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    54
	 * @param aApp Application creating this document.
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    55
	 * @return A pointer to the created instance of CNPRDocument.
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    56
	 */
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    57
	static CNPRDocument* NewL(CEikApplication& aApp);
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    58
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    59
	/**
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    60
	 * NewLC.
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    61
	 * Two-phased constructor.
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    62
	 * Construct a CNPRDocument for the AVKON application aApp
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    63
	 * using two phase construction, and return a pointer
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    64
	 * to the created object.
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    65
	 * @param aApp Application creating this document.
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    66
	 * @return A pointer to the created instance of CNPRDocument.
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    67
	 */
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    68
	static CNPRDocument* NewLC(CEikApplication& aApp);
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    69
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    70
	/**
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    71
	 * ~CNPRDocument
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    72
	 * Virtual Destructor.
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    73
	 */
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    74
	virtual ~CNPRDocument();
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    75
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    76
public:
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    77
	// Functions from base classes
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    78
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    79
	/**
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    80
	 * CreateAppUiL
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    81
	 * From CEikDocument, CreateAppUiL.
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    82
	 * Create a CNPRAppUi object and return a pointer to it.
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    83
	 * The object returned is owned by the Uikon framework.
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    84
	 * @return Pointer to created instance of AppUi.
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    85
	 */
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    86
	CEikAppUi* CreateAppUiL();
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    87
		
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    88
private:
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    89
	// Constructors
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    90
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    91
	/**
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    92
	 * ConstructL
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    93
	 * 2nd phase constructor.
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    94
	 */
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    95
	void ConstructL();
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    96
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    97
	/**
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    98
	 * CNPRDocument.
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
    99
	 * C++ default constructor.
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
   100
	 * @param aApp Application creating this document.
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
   101
	 */
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
   102
	CNPRDocument(CEikApplication& aApp);
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
   103
	};
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
   104
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
   105
#endif // __NPR_DOCUMENT_H__
0049171ecffb initial release
tahirm@symbian.org
parents:
diff changeset
   106
// End of File