localisation/apparchitecture/inc/APPARC.H
author Maciej Seroka <maciejs@symbian.org>
Wed, 28 Jul 2010 16:03:37 +0100
branchSymbian3
changeset 56 aa99f2208aad
parent 6 c108117318cb
child 57 b8d18c84f71c
permissions -rw-r--r--
Updated END_TESTCASE for LbsApi test set
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
     1
// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
     2
// All rights reserved.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
     3
// This component and the accompanying materials are made available
6
c108117318cb adding EPL notices
victorp@symbian.org
parents: 1
diff changeset
     4
// under the terms of the License "Eclipse Public License v1.0"
1
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
     5
// which accompanies this distribution, and is available
6
c108117318cb adding EPL notices
victorp@symbian.org
parents: 1
diff changeset
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
     7
//
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
     8
// Initial Contributors:
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
     9
// Nokia Corporation - initial contribution.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    10
//
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    11
// Contributors:
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    12
//
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    13
// Description:
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    14
//
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    15
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    16
#ifndef __APPARC_H__
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    17
#define __APPARC_H__
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    18
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    19
#if !defined(__E32STD_H__)
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    20
#include <e32std.h>
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    21
#endif
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    22
#if !defined(__E32BASE_H__)
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    23
#include <e32base.h>
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    24
#endif
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    25
#if !defined(__F32FILE_H__)
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    26
#include <f32file.h>
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    27
#endif
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    28
#if !defined(__GDI_H__)
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    29
#include <gdi.h>
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    30
#endif
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    31
#if !defined(__APADEF_H__)
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    32
#include <apadef.h>
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    33
#endif
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    34
#if !defined(__APAID_H__)
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    35
#include <apaid.h>
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    36
#endif
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    37
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    38
// classes defined:
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    39
class CApaApplication;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    40
class CApaDocument;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    41
class CApaProcess;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    42
class MApaEmbeddedDocObserver;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    43
//
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    44
// classes referenced:
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    45
class CApaDll;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    46
class CApaExe;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    47
class RFile;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    48
class RReadStream;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    49
class RWriteStream;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    50
class CFileStore;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    51
class CPersistentStore;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    52
class CStreamDictionary;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    53
class CDictionaryStore;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    54
class TApaAppHolderInfo;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    55
class CImplementationInformation;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    56
class TApaApplicationFactory;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    57
class CApaAppHolder;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    58
class CApaAppServer;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    59
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    60
/** Creates an application interface object.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    61
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    62
Provides the basic roles of an application class as a factory that
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    63
creates concrete document objects, and supplies utility functions 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    64
not specific to any particular instance of a document.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    65
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    66
@publishedAll
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    67
@released
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    68
*/
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    69
typedef CApaApplication* (*CreateCApaApplication)();
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    70
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    71
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    72
// CApaApplication
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    73
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    74
class CApaApplication : public CBase
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    75
// base class for applications; allows creation of documents & file stores + display of app icon and name.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    76
/** Defines the basic behaviour for applications.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    77
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    78
The class defines the basic twin roles of an application class as a factory 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    79
that creates concrete document objects, and as a supplier of utility functions 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    80
not specific to any particular instance of a document. For example, returning 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    81
an application's caption, or accessing its .ini file.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    82
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    83
The class is derived from by the UI framework and is further derived from 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    84
by the UI application.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    85
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    86
@publishedAll 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    87
@released 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    88
@see CEikApplication */
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    89
	{
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    90
public:
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    91
	/** Completes construction of this application object.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    92
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    93
	The function is called after an instance of a derived class has been successfully 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    94
	created using the ordinal 1 function of the application DLL.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    95
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    96
	After calling this function, an application can create document objects.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    97
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    98
	An implementation of this function is supplied by the UI framework.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
    99
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   100
	@see CEikApplication */
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   101
	virtual void PreDocConstructL()=0; // call once before creating document
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   102
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   103
	/** Creates a document object.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   104
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   105
	The function is called by the application process when a new document is required. 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   106
	The application process adds the new document to its list of documents.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   107
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   108
	An implementation of this function is supplied by the UI framework.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   109
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   110
	@param aProcess A pointer to the process associated with the application.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   111
	@return A pointer to the newly created document.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   112
	@see CApaProcess::AddNewDocumentL() */
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   113
	virtual CApaDocument* CreateDocumentL(CApaProcess* aProcess)=0;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   114
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   115
	/** Gets the application specific UID.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   116
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   117
	The UID is used to differentiate between UI applications.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   118
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   119
	An implementation of this function must be supplied by the UI application.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   120
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   121
	@return The application specific UID. */
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   122
	virtual TUid AppDllUid()const=0;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   123
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   124
	//
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   125
	// utility functions
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   126
	IMPORT_C static TInt GenerateFileName(RFs& aFs,TFileName& aRootName);
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   127
	IMPORT_C CDictionaryStore* OpenIniFileL(RFs& aFs)const;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   128
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   129
	/** Opens the .ini file associated with the application, constructs the dictionary 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   130
	store object, returns a pointer to it and puts the pointer onto the cleanupstack.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   131
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   132
	The .ini file must be created, if it does not already exist.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   133
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   134
	An implementation of this function is supplied by the UI framework.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   135
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   136
	@param aFs Handle to a file server session 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   137
	@return A pointer to the dictionary store object that represents the application's 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   138
	.ini file. 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   139
	@see CEikApplication */
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   140
	virtual CDictionaryStore* OpenIniFileLC(RFs& aFs)const=0;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   141
	//
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   142
	// enquiry functions
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   143
	IMPORT_C virtual TFileName AppFullName()const; // returns the full path and name of the app
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   144
	/** Returns the capabilities of the application.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   145
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   146
	Application capability information is represented by an instance of a TApaAppCapability 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   147
	object wrapped in a packaged modifiable buffer descriptor.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   148
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   149
	The function is called from a number of places within the application framework.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   150
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   151
	An implementation of this function is supplied by the UI framework.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   152
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   153
	@param aInfo A packaged modifiable buffer descriptor (a TPckgBuf), encapsulating 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   154
	a TApaAppCapability object. 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   155
	@see CEikApplication
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   156
	@see TApaAppCapability
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   157
	@see TPckgBuf */
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   158
	virtual void Capability(TDes8& aInfo)const=0;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   159
	//
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   160
	// accessor function
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   161
	IMPORT_C TFileName DllName()const;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   162
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   163
	IMPORT_C ~CApaApplication();
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   164
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   165
	// formerly a reserved virtual, Reserved_1()
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   166
	IMPORT_C virtual void NewAppServerL(CApaAppServer*& aAppServer);
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   167
protected:
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   168
	IMPORT_C CApaApplication();
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   169
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   170
	IMPORT_C virtual void CApaApplication_Reserved1();
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   171
	IMPORT_C virtual void CApaApplication_Reserved2();
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   172
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   173
private:
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   174
	CApaAppHolder* iAppHolder;  // the CApaAppHolder that owns me
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   175
	TUid iDtorKey;	//	TInt iSpare;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   176
	friend class CApaAppHolder;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   177
	friend class CApaProcess;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   178
	friend class TApaApplicationFactory; // so that it can access iDtorKey
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   179
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   180
private:
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   181
	TInt iCApaApplication_Reserved1;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   182
	};
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   183
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   184
class CApaDocument : public CBase
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   185
// base class for documents; allows insertion of glass doors.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   186
/** Defines basic behaviour for documents.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   187
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   188
This is the base class for all documents. A document contains the data associated 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   189
with the application's content.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   190
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   191
The class is derived from by the UI framework and is further derived from 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   192
by the UI application.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   193
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   194
@publishedAll 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   195
@released
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   196
@see CEikDocument */
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   197
	{
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   198
public:
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   199
	class TCapability
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   200
	/** CApaDocument capabilities.*/
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   201
		{
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   202
	public:
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   203
		IMPORT_C TCapability();
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   204
		//
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   205
		inline TBool CanDrawGlass()const;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   206
		inline TBool CanPrint()const;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   207
		inline void SetCanDrawGlass();
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   208
		inline void SetCanPrint();
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   209
		//
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   210
	private:
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   211
		enum {
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   212
			ECanDrawGlass	=0x01,
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   213
			ECanPrint		=0x02
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   214
			};
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   215
	private:
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   216
		TUint iCapability;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   217
		TInt TCapability_Reserved1;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   218
		};
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   219
	//
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   220
public:
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   221
	// document instantiation functions
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   222
	/** Initialises a new, empty, document with a default setup.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   223
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   224
	This can be the main document or an embedded document. The function is called 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   225
	by the UI framework when it creates a default document file.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   226
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   227
	An implementation of this function must be supplied by the UI application.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   228
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   229
	If initialisation fails, the document must be left in the same state as it 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   230
	was before the function was called. */
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   231
	virtual void NewDocumentL()=0; // builds a new embedded or main document without loading from a store (may create the content from eg code or a template file).
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   232
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   233
	/** Creates and fully initialises a new filestore and stores the document into it, 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   234
	replacing any existing file of the same name.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   235
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   236
	The function should put the pointer to the filestore object onto the cleanup 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   237
	stack.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   238
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   239
	An implementation of this function is supplied by the UI framework.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   240
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   241
	@param aFs Handle to a file server session. 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   242
	@param aFileName The full path name of the file to be created. 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   243
	@return A pointer to the newly constructed file store. 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   244
	@see CEikDocument */
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   245
	virtual CFileStore* CreateFileStoreLC(RFs& aFs,const TDesC& aFileName)=0; // creates a file for a document and stores itself to that store (store should be put on cleanup stack).
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   246
	//
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   247
	// interaction functions
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   248
	IMPORT_C virtual CPicture* GlassPictureL(); // Does nothing by default, override to return handle to glass picture.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   249
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   250
	/** Starts an editing session on an embedded document.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   251
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   252
	The function should cause the application's UI to be created and the document 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   253
	to be fully restored for editing.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   254
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   255
	An implementation of this function is supplied by the UI framework.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   256
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   257
	@param aContainer This document's observer.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   258
	@param aReadOnly True, the document should be opened in read-only mode and 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   259
	should not persist any changes made to the content. False, the document can 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   260
	be opened in read/write mode; this is the default. 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   261
	@see CEikDocument */
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   262
	virtual void EditL(MApaEmbeddedDocObserver* aContainer,TBool aReadOnly=EFalse)=0; // Edit the document in the context of the container's environment. If aContainer is null, edit as the main document
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   263
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   264
	/** Prints the document without a need for it to be open for editing.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   265
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   266
	Typically, this is called from a shell or a file manager type application 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   267
	that wants to print the document without opening it fully.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   268
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   269
	An empty implementation of this function is supplied by the UI framework.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   270
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   271
	The UI application can provide its own implementation.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   272
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   273
	@param aSourceStore A reference to the store containing the document. 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   274
	@see CEikDocument */
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   275
	virtual void PrintL(const CStreamStore& aSourceStore)=0; // default print parameters, assume print context supplied by environment
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   276
	//
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   277
	// persistence functions
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   278
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   279
	/** Stores the document to the current file, commits the changes, and marks the 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   280
	document status as unchanged.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   281
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   282
	Typically, the function is called by the application when it implements a 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   283
	"Save" type menu option in its User Interface.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   284
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   285
	An implementation of this function is supplied by the UI framework. This is 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   286
	adequate for direct file store applications. Applications using a permanent 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   287
	file store model, need to provide their own implementation.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   288
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   289
	If the function leaves, an implementation should ensure that any changes made 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   290
	to the file are rolled back, leaving the file in the state it was in before 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   291
	the function was called.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   292
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   293
	@see CEikDocument */
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   294
	virtual void SaveL()=0; // save the doc to the file in the custody of iAppProcess. This fn should be called by any "Save" menu option. store->Commit() should be called within it.	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   295
	/** Stores the document's content and state to the specified store, recording the 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   296
	identity of any headstreams created in the specified stream dictionary.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   297
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   298
	The store must be fully constructed before this function is called.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   299
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   300
	An empty implementation of this function is supplied by the UI framework. 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   301
	UI applications that need to persist any data must provide their own implementation.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   302
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   303
	If the function leaves, an implementation should ensure that the store and 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   304
	the stream dictionary are returned to the state they were in before the function 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   305
	was called.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   306
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   307
	@param aStore The store into which document data is to be stored. 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   308
	@param aStreamDic The stream dictionary into which stream IDs and associated 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   309
	UIDs are to be recorded. 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   310
	@see CEikDocument */
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   311
	virtual void StoreL(CStreamStore& aStore,CStreamDictionary& aStreamDic) const=0; // store to aStore, lodging the headstream in aStreamDic
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   312
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   313
	/** Restores the document's content and state from data persisted in the specified 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   314
	store.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   315
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   316
	An empty implementation of this function is supplied by the UI framework. 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   317
	UI applications that need to restore data must provide their own implementation.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   318
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   319
	If the function leaves, an implementation should ensure that the store and 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   320
	the stream dictionary are returned to the state they were in before the function 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   321
	was called.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   322
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   323
	@param aStore The store from which document data is to be restored. 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   324
	@param aStreamDic The stream dictionary containing stream IDs and associated 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   325
	UIDs. 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   326
	@see CEikDocument */
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   327
	virtual void RestoreL(const CStreamStore& aStore,const CStreamDictionary& aStreamDic)=0; // restore from aStore using aStreamDic
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   328
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   329
	/** Restores the document to the extent that it does not need the store
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   330
	further.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   331
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   332
	A document only keeps a pointer to a store if it implements deferred
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   333
	loading. This also tells the document that any store pointer that it
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   334
	might have is just about to become invalid.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   335
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   336
	An empty implementation of this function is supplied by the UI framework. 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   337
	UI applications that support deferred loading or embedding should provide an
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   338
	implementation.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   339
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   340
	If a document supports embedding, then it should
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   341
	propagate the DetachFromStoreL() call on to all embedded objects that
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   342
	it contains.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   343
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   344
	If the function leaves, the operation should be aborted
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   345
	because the document has not successfully detached from the store.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   346
	Continuing with the operation may leave the document in an unsafe
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   347
	state or cause user data to be lost.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   348
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   349
	@param aDegree The degree of detachment required. */
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   350
	virtual void DetachFromStoreL(CPicture::TDetach /*aDegree*/=CPicture::EDetachFull) {} // supply an implementation if you support deferred loading or embedding
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   351
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   352
	IMPORT_C virtual void ExternalizeL(RWriteStream& aStream)const;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   353
	//
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   354
	// enquiry functions
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   355
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   356
	/** Tests whether the document is empty.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   357
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   358
	The UI framework provides a default implementation which always returns a 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   359
	true value.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   360
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   361
	The UI application can provide its own implementation. Typically, any application 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   362
	that has editable content should supply an implementation that acts according 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   363
	to the state of that content. Applications without associated document data 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   364
	need not supply an implementation.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   365
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   366
	@return True if the document is empty, false otherwise. 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   367
	@see CEikDocument */
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   368
	virtual TBool IsEmpty()const=0; // return ETrue if the document is empty
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   369
	IMPORT_C virtual void ValidatePasswordL()const; // return EFalse if there *is* a password *and* the user doesn't get it right, ETrue otherwise (ie they get it right or there isn't one). Returns ETrue by default
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   370
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   371
	IMPORT_C virtual TCapability Capability()const; // returns "cant do anything" by default
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   372
	inline CApaApplication* Application()const;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   373
	inline CApaProcess* Process()const;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   374
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   375
	/** Tests whether the document has changed since it was last persisted.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   376
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   377
	An implementation of this function is supplied by the UI framework and need 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   378
	not be changed by the UI application.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   379
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   380
	@return True, if the document has changed since the last time that it was 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   381
	persisted, false, otherwise.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   382
	@see CEikDocument */
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   383
	virtual TBool HasChanged()const =0;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   384
	//
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   385
	IMPORT_C virtual ~CApaDocument();
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   386
protected:
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   387
	IMPORT_C CApaDocument();
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   388
	IMPORT_C CApaDocument(CApaApplication& aApp,CApaProcess& aProcess);
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   389
private:
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   390
	IMPORT_C virtual void OpenFileL(CFileStore*& aFileStore, RFile& aFile); // was previously Reserved_1
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   391
	// Reserved virtual functions...
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   392
	IMPORT_C virtual void Reserved_2();
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   393
protected:
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   394
	MApaEmbeddedDocObserver* iContainer; // null unless this is an embedded object currently being edited
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   395
private:
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   396
	CApaApplication* iApplication; // the doc's associated application
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   397
	CApaProcess* iApaProcess;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   398
	TInt iSpare;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   399
	};
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   400
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   401
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   402
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   403
class TApaApplicationFactory
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   404
/** Encapsulates the functionality of creating an application, whether it be via a factory function
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   405
or an ECOM plugin. Instances of this class can usually be created implicitly when required as
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   406
function parameters - just specify the function pointer, ECOM plugin UID or CImplementationInformation
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   407
reference.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   408
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   409
@publishedAll
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   410
@released
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   411
@see CApaProcess
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   412
@see EikStart */
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   413
	{
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   414
public:
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   415
	typedef CApaApplication* (*TFunction)();
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   416
public:
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   417
	IMPORT_C TApaApplicationFactory();
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   418
	IMPORT_C TApaApplicationFactory(TFunction aFunction);
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   419
	IMPORT_C TApaApplicationFactory(const CImplementationInformation& aEmbeddedApplicationInformation);
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   420
	IMPORT_C TApaApplicationFactory(TUid aEmbeddedApplicationUid);
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   421
	CApaApplication* CreateApplicationL() const;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   422
	HBufC* AppFileNameL() const;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   423
	TUid AppFileUid() const;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   424
private:
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   425
	enum TType
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   426
		{
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   427
		ETypeFunction,							// if iType is this, iData is a TFunction
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   428
		ETypeEmbeddedApplicationInformation,	// if iType is this, iData is an ECOM CImplementationInformation
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   429
		ETypeEmbeddedApplicationUid				// if iType is this, iData is an ECOM implementation TUid
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   430
		};
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   431
private:
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   432
	static CApaApplication* CreateEmbeddedApplicationL(TUid aUid);
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   433
	static HBufC* EmbeddedApplicationDisplayNameLC(TUid aUid);
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   434
	static HBufC* FullAppFileNameL(const TDesC& aAppName);
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   435
	static void CleanupImplementationArray(TAny* aImplementationArray);
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   436
private:
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   437
	TType iType;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   438
	TUint iData;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   439
	mutable CApaApplication* iApplication; // used to be iSpare1
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   440
	TInt iSpare2;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   441
	};
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   442
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   443
class CApaParentProcessMonitor;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   444
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   445
class CApaProcess : public CBase
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   446
/** Maintains a list of documents and all of the potentially shared resources used 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   447
by documents.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   448
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   449
This includes the application DLLs. The class also supplies utility functions 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   450
that provide the basic structure for persisted document files.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   451
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   452
The class deals with the loading of application DLLs and manages the creation 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   453
and destruction of application (CApaApplication) objects and document (CApaDocument) 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   454
objects.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   455
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   456
The class is derived from by the UI framework and further derivation by the 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   457
UI application is not necessary unless it needs to add extra utility functions 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   458
for the use of applications.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   459
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   460
@publishedAll
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   461
@released
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   462
@see CApaApplication
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   463
@see CApaDocument */
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   464
	{
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   465
public:
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   466
	IMPORT_C static CApaProcess* NewL(const RFs& aFs);
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   467
	IMPORT_C void ResetL();
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   468
	//
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   469
	// static utility functions
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   470
	IMPORT_C static CStreamDictionary* ReadRootStreamLC(RFs& aFs,CFileStore*& aStore,const TDesC& aDocFullFileName,TUint aFileMode); // opens aDocFileName as aStore and returns the stream dictionary contained in its root stream on the cleanup stack
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   471
	IMPORT_C static CStreamDictionary* ReadRootStreamLC(CFileStore*& aStore, const RFile& aFile);
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   472
	IMPORT_C static void WriteRootStreamL(CPersistentStore& aStore,CStreamDictionary& aStreamDic,const CApaApplication& aApp);
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   473
	IMPORT_C static void WriteRootStreamL(CPersistentStore& aStore,CStreamDictionary& aStreamDic,const TApaAppIdentifier& aAppId);
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   474
	IMPORT_C static TApaAppIdentifier ReadAppIdentifierL(const CStreamStore& aStore,const CStreamDictionary& aStreamDic);
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   475
	IMPORT_C static void WriteAppIdentifierL(CStreamStore& aStore,CStreamDictionary& aStreamDic,const TApaAppIdentifier& aAppId);
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   476
	//
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   477
	// document management
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   478
	IMPORT_C CApaDocument* AddNewDocumentL(TApaApplicationFactory aApplicationFactory);
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   479
	IMPORT_C CApaDocument* OpenNewDocumentL(CFileStore*& aStore,CStreamDictionary*& aStreamDic,const TDesC& aDocFullFileName,TUint aFileMode); // Open a file and restore the contained document
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   480
	IMPORT_C void DestroyDocument(CApaDocument* aDoc); // Removes a doc (identified by the object) from the list and destroys it. Also removes the app and closes the AppDll if appropriate.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   481
	//
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   482
	// setter functions
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   483
	IMPORT_C void SetMainDocument(CApaDocument* aDocument);
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   484
	IMPORT_C void SetMainDocFileName(const TDesC& aMainDocFileName); // panics if the descriptor is too long
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   485
	IMPORT_C void SetMainDocFileNameL(const TDesC& aMainDocFileName);
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   486
	//
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   487
	// accessor functions
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   488
	IMPORT_C TPtrC MainDocFileName()const;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   489
	inline RFs& FsSession()const;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   490
	inline CApaDocument* MainDocument()const;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   491
	//
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   492
	IMPORT_C ~CApaProcess();
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   493
protected:
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   494
	IMPORT_C CApaProcess();
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   495
	IMPORT_C CApaProcess(const RFs& aFs);
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   496
	IMPORT_C void ConstructL();
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   497
	IMPORT_C void ConstructL(TProcessId aParentProcessId);
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   498
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   499
	IMPORT_C virtual void CApaProcess_Reserved1();
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   500
	IMPORT_C virtual void CApaProcess_Reserved2();
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   501
public:
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   502
	static TInt IdleRemoveApplications(TAny* aThis);
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   503
	void RemoveMarkedApplications();
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   504
private:
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   505
	CApaDll* AddAppDllL(const TDesC& aDllFullPath);
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   506
	CApaExe* AddAppExeL(TApaApplicationFactory aApplicationFactory);
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   507
	void RemoveApp(CApaAppHolder* aAppHolder);
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   508
	CApaDocument* CreateDocL(CApaApplication* aApp);
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   509
	CApaAppHolder* FindAppInListL(const TDesC& aAppFileName,TUid aUid)const; // returns NULL if not in list
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   510
	void DeleteAllDocs();
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   511
	void MarkApplicationForRemoval(const CApaApplication* aApp);
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   512
	static void DoReadRootStreamL(CStreamDictionary& aStreamDictionary, const CFileStore& aStore);
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   513
private:
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   514
	CArrayFixFlat<TApaAppHolderInfo>* iAppList; // array of apps in use
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   515
	CArrayFixFlat<CApaDocument*>* iDocList; // array of documents (1 main + n embedded)
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   516
	CApaDocument* iMainDoc;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   517
	HBufC* iMainDocFileName;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   518
	RFs iFsSession; // file server session for doc store
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   519
	CIdle* iApplicationRemover;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   520
	CApaParentProcessMonitor* iMonitor;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   521
	TInt iCApaProcess_Reserved1;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   522
	};
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   523
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   524
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   525
class MApaEmbeddedDocObserver
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   526
/** An interface class for handling the completion of the editing of an embedded 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   527
document.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   528
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   529
@publishedAll 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   530
@released
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   531
@see CApaDocument::EditL() */
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   532
	{
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   533
public:
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   534
	/** Defines the state of the embedded document on completion of editing. */
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   535
	enum TExitMode {
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   536
		/** Changes to the embedded document must be saved. */
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   537
		EKeepChanges,
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   538
		/** Reverts back to the saved version of the embedded document, i.e. reloads the 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   539
		whole document. */
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   540
		ERevertToSaved,
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   541
		/** No changes have been made to the embedded document. */
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   542
		ENoChanges,
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   543
		/** The embedded document is empty. */
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   544
		EEmpty
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   545
		};
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   546
public:
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   547
	/** Implements the required behaviour when the editing of an embedded document completes.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   548
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   549
	@param aMode Indicates the state of the document. */
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   550
	virtual void NotifyExit(TExitMode aMode)=0; // called on completion of editing of an embedded document
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   551
protected:
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   552
	IMPORT_C MApaEmbeddedDocObserver();
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   553
private:
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   554
	IMPORT_C virtual void MApaEmbeddedDocObserver_Reserved1();
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   555
	IMPORT_C virtual void MApaEmbeddedDocObserver_Reserved2();
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   556
private:
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   557
	TInt iMApaEmbeddedDocObserver_Reserved1;
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   558
	};
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   559
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   560
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   561
//// inlines ////
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   562
inline CApaApplication* CApaDocument::Application()const
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   563
/** Returns a pointer to the application that created the document.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   564
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   565
@return A pointer to the document's associated application. */
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   566
	{ return iApplication; }
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   567
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   568
inline CApaProcess* CApaDocument::Process()const
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   569
/** Returns a pointer to the application process associated with this document.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   570
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   571
@return A pointer to the application process associated with this document. */
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   572
	{ return iApaProcess; }
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   573
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   574
inline TBool CApaDocument::TCapability::CanDrawGlass()const
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   575
/** Tests whether the document supports being embedded as a glass door.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   576
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   577
@return True if embedding as a glass door is supported; false otherwise. */
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   578
	{ return iCapability&ECanDrawGlass; }
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   579
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   580
inline TBool CApaDocument::TCapability::CanPrint()const
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   581
/** Tests whether the document supports being printed without using the full application 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   582
UI.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   583
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   584
@return True, if printing is supported; false, otherwise. */
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   585
	{ return iCapability&ECanPrint; }
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   586
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   587
inline void CApaDocument::TCapability::SetCanDrawGlass()
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   588
/** Sets the document as being capable of being embedded as a glass door. */
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   589
	{ iCapability = iCapability|ECanDrawGlass; }
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   590
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   591
inline void CApaDocument::TCapability::SetCanPrint()
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   592
/** Sets the document as being capable of being printed without using the full application 
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   593
UI. */
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   594
	{ iCapability = iCapability|ECanPrint; }
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   595
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   596
inline RFs& CApaProcess::FsSession()const
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   597
/** Returns a handle to the file server session used by this application process.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   598
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   599
@return The file server session. */
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   600
	{ return (RFs&)iFsSession; } //lint !e1536 Exposing low access member - Kept for backward BC
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   601
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   602
inline CApaDocument* CApaProcess::MainDocument()const
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   603
/** Returns a pointer to the main document.
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   604
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   605
@return A pointer to the main document. */
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   606
	{ return iMainDoc; }
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   607
	
8758140453c0 Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff changeset
   608
#endif