messagingappbase/schemeplugin/inc/BaseHandler.h
author hgs
Wed, 03 Nov 2010 22:55:44 +0530
changeset 80 8b14b30db193
parent 79 2981cb3aa489
permissions -rw-r--r--
201044_02
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
79
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  
hgs
parents:
diff changeset
    15
*      Declaration of class CBaseHandler.   
hgs
parents:
diff changeset
    16
*
hgs
parents:
diff changeset
    17
*/
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
#ifndef BASE_HANDLER_H
hgs
parents:
diff changeset
    22
#define BASE_HANDLER_H
hgs
parents:
diff changeset
    23
hgs
parents:
diff changeset
    24
// INCLUDES
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
#include <schemehandler.h>
hgs
parents:
diff changeset
    27
#include <e32base.h>
hgs
parents:
diff changeset
    28
hgs
parents:
diff changeset
    29
// FORWARD DECLARATION
hgs
parents:
diff changeset
    30
class CPtrC16Array;
hgs
parents:
diff changeset
    31
class CMessageData;
hgs
parents:
diff changeset
    32
hgs
parents:
diff changeset
    33
// CONSTS
hgs
parents:
diff changeset
    34
hgs
parents:
diff changeset
    35
// CLASS DECLARATION
hgs
parents:
diff changeset
    36
enum TSchemePluginPanic
hgs
parents:
diff changeset
    37
	{
hgs
parents:
diff changeset
    38
	EUnrecognisedState			= 1
hgs
parents:
diff changeset
    39
	};
hgs
parents:
diff changeset
    40
hgs
parents:
diff changeset
    41
/**
hgs
parents:
diff changeset
    42
*  Scheme Handler IF definition class
hgs
parents:
diff changeset
    43
*  @since Series60_2.6
hgs
parents:
diff changeset
    44
*/
hgs
parents:
diff changeset
    45
class CBaseHandler : public CSchemeHandler
hgs
parents:
diff changeset
    46
    {
hgs
parents:
diff changeset
    47
	public:
hgs
parents:
diff changeset
    48
	
hgs
parents:
diff changeset
    49
		enum TRecipientTypes
hgs
parents:
diff changeset
    50
			{
hgs
parents:
diff changeset
    51
			KToRecipient,
hgs
parents:
diff changeset
    52
			KCcRecipient
hgs
parents:
diff changeset
    53
			};
hgs
parents:
diff changeset
    54
			
hgs
parents:
diff changeset
    55
    public: // From base class
hgs
parents:
diff changeset
    56
hgs
parents:
diff changeset
    57
		/**
hgs
parents:
diff changeset
    58
		* Url Handler with embedding
hgs
parents:
diff changeset
    59
		* @param -
hgs
parents:
diff changeset
    60
		*/
hgs
parents:
diff changeset
    61
		virtual void HandleUrlEmbeddedL() = 0;
hgs
parents:
diff changeset
    62
hgs
parents:
diff changeset
    63
		/**
hgs
parents:
diff changeset
    64
		* Url Handler without embedding
hgs
parents:
diff changeset
    65
		* @param -
hgs
parents:
diff changeset
    66
		*/
hgs
parents:
diff changeset
    67
		virtual void HandleUrlStandaloneL() = 0;
hgs
parents:
diff changeset
    68
hgs
parents:
diff changeset
    69
		/**
hgs
parents:
diff changeset
    70
		* Observer
hgs
parents:
diff changeset
    71
		* @param - aSchemeDoc
hgs
parents:
diff changeset
    72
		*/
hgs
parents:
diff changeset
    73
        void Observer( MAknServerAppExitObserver* aSchemeDoc );
hgs
parents:
diff changeset
    74
		
hgs
parents:
diff changeset
    75
	protected:
hgs
parents:
diff changeset
    76
hgs
parents:
diff changeset
    77
        /**
hgs
parents:
diff changeset
    78
        * Constructor.
hgs
parents:
diff changeset
    79
        */      
hgs
parents:
diff changeset
    80
		CBaseHandler();
hgs
parents:
diff changeset
    81
hgs
parents:
diff changeset
    82
       /**
hgs
parents:
diff changeset
    83
        * Destructor.
hgs
parents:
diff changeset
    84
        */      
hgs
parents:
diff changeset
    85
        virtual ~CBaseHandler();
hgs
parents:
diff changeset
    86
hgs
parents:
diff changeset
    87
        /**
hgs
parents:
diff changeset
    88
        * Second phase constructor. Leaves on failure.
hgs
parents:
diff changeset
    89
		* BaseConstructL must be called from inherited ConstructL
hgs
parents:
diff changeset
    90
		* preferably before do anything
hgs
parents:
diff changeset
    91
		* @param - aUrl
hgs
parents:
diff changeset
    92
        */      
hgs
parents:
diff changeset
    93
		void BaseConstructL( const TDesC& aUrl );
hgs
parents:
diff changeset
    94
hgs
parents:
diff changeset
    95
	protected: // New functions
hgs
parents:
diff changeset
    96
hgs
parents:
diff changeset
    97
        /**
hgs
parents:
diff changeset
    98
        * Separates items from string to array.
hgs
parents:
diff changeset
    99
        * 
hgs
parents:
diff changeset
   100
        * @param aSeparator Separator mark that separates items.
hgs
parents:
diff changeset
   101
        * @param aString String to separate
hgs
parents:
diff changeset
   102
        * @param aArray Result array
hgs
parents:
diff changeset
   103
        */
hgs
parents:
diff changeset
   104
        void SeparateItemsToArrayL( 
hgs
parents:
diff changeset
   105
			const TDesC& aSeparator, 
hgs
parents:
diff changeset
   106
			const TDesC& aString, 
hgs
parents:
diff changeset
   107
			CPtrC16Array& aArray ) const;
hgs
parents:
diff changeset
   108
			
hgs
parents:
diff changeset
   109
			/**
hgs
parents:
diff changeset
   110
        * Separates items from string to array of messageData.
hgs
parents:
diff changeset
   111
        * 
hgs
parents:
diff changeset
   112
        * @param aSeparator Separator mark that separates items.
hgs
parents:
diff changeset
   113
        * @param aString String to separate
hgs
parents:
diff changeset
   114
        * @param aMessageData Object where items are appended.
hgs
parents:
diff changeset
   115
        */
hgs
parents:
diff changeset
   116
        void SeparateAndAppendAddressL(
hgs
parents:
diff changeset
   117
			const TDesC& aSeparator, 
hgs
parents:
diff changeset
   118
			const TDesC& aString, 
hgs
parents:
diff changeset
   119
			CMessageData& aMessageData,
hgs
parents:
diff changeset
   120
			const TInt aRecipientType = KToRecipient ) const;	
hgs
parents:
diff changeset
   121
			
hgs
parents:
diff changeset
   122
        /**
hgs
parents:
diff changeset
   123
        * Notify client on completion of editing of an embedded document.
hgs
parents:
diff changeset
   124
        * @param.
hgs
parents:
diff changeset
   125
        */
hgs
parents:
diff changeset
   126
		void NotifyClient();
hgs
parents:
diff changeset
   127
        
hgs
parents:
diff changeset
   128
        /**
hgs
parents:
diff changeset
   129
        * Returns the minimum value of the array.
hgs
parents:
diff changeset
   130
        * @param.
hgs
parents:
diff changeset
   131
        * @return
hgs
parents:
diff changeset
   132
        */
hgs
parents:
diff changeset
   133
        TInt Minimum( RArray<TInt>& aArray ) const;
hgs
parents:
diff changeset
   134
hgs
parents:
diff changeset
   135
        /**
hgs
parents:
diff changeset
   136
        * Launch SchemeApp passing Generic Params List
hgs
parents:
diff changeset
   137
        * @param -
hgs
parents:
diff changeset
   138
        * @return -
hgs
parents:
diff changeset
   139
        */
hgs
parents:
diff changeset
   140
        void LaunchSchemeAppWithCommandLineL();
hgs
parents:
diff changeset
   141
hgs
parents:
diff changeset
   142
hgs
parents:
diff changeset
   143
	protected: // Data
hgs
parents:
diff changeset
   144
hgs
parents:
diff changeset
   145
        MAknServerAppExitObserver* iSchemeDoc; ///< Used.
hgs
parents:
diff changeset
   146
hgs
parents:
diff changeset
   147
    protected: // Data
hgs
parents:
diff changeset
   148
hgs
parents:
diff changeset
   149
		// Results of parsing
hgs
parents:
diff changeset
   150
		HBufC* iParsedUrl; ///< Owned.
hgs
parents:
diff changeset
   151
	};
hgs
parents:
diff changeset
   152
hgs
parents:
diff changeset
   153
#endif /* def BASE_HANDLER_H */