mmlibs/mmfw/inc/mmf/ControllerFramework/mmfcustomcommandparsermanager.h
author hgs
Thu, 07 Oct 2010 22:34:12 +0100
changeset 0 b8ed18f6c07b
permissions -rw-r--r--
2010wk40
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     1
// Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     2
// All rights reserved.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     3
// This component and the accompanying materials are made available
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     4
// under the terms of "Eclipse Public License v1.0"
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     5
// which accompanies this distribution, and is available
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     7
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     8
// Initial Contributors:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     9
// Nokia Corporation - initial contribution.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    10
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    11
// Contributors:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    12
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    13
// Description:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    14
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    15
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    16
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    17
#ifndef __MMFCUSTOMCOMMANDPARSERMANAGER_H__
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    18
#define __MMFCUSTOMCOMMANDPARSERMANAGER_H__
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    19
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    20
/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    21
@publishedPartner
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    22
@released
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    23
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    24
Class to manage custom command parsers.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    25
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    26
An object of this type is owned by the controller framework to contain all the custom command
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    27
parsers for the controller plugin.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    28
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    29
@since 7.0s
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    30
*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    31
class CMMFCustomCommandParserManager : public CBase
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    32
	{
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    33
public:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    34
	/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    35
	Factory constructor.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    36
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    37
	@return A pointer to the newly created object.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    38
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    39
	@since 7.0s
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    40
	*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    41
	IMPORT_C static CMMFCustomCommandParserManager* NewL();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    42
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    43
	/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    44
	Destructor.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    45
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    46
	Deletes all custom command parsers added to the manager.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    47
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    48
	@since 7.0s
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    49
	*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    50
	IMPORT_C ~CMMFCustomCommandParserManager();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    51
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    52
	/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    53
	Attempts to find a custom command parser capable of handling the message.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    54
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    55
	@param  aMessage
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    56
            The message to be handled.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    57
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    58
	@return A boolean indicating in the message has been handled. ETrue if the message has been handled, EFalse
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    59
	        if it has not.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    60
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    61
	@since 7.0s
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    62
	*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    63
	IMPORT_C TBool HandleRequest(TMMFMessage& aMessage);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    64
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    65
	/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    66
	Adds a custom command parser to the manager.  The manager takes ownership of the parser.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    67
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    68
	Note:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    69
	This method will leave if it fails to add the parser. If it does leave, ownership
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    70
	of the parser will remain with the caller.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    71
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    72
	@param  aParser
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    73
	        A reference to the parser to be added to the manager.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    74
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    75
	@since 7.0s
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    76
	*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    77
	IMPORT_C void AddCustomCommandParserL(CMMFCustomCommandParserBase& aParser);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    78
private:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    79
	CMMFCustomCommandParserManager();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    80
private:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    81
	/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    82
	The array of custom command parsers.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    83
	*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    84
	RPointerArray<CMMFCustomCommandParserBase> iParsers;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    85
	};
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    86
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    87
#endif __MMFCUSTOMCOMMANDPARSERMANAGER_H__