photosgallery/collectionframework/datasource/manager/inc/glxrequest.h
changeset 0 4e91876724a2
equal deleted inserted replaced
-1:000000000000 0:4e91876724a2
       
     1 /*
       
     2 * Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies). 
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:    Represents a  request
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 #ifndef C_GLXREQUEST_H
       
    22 #define C_GLXREQUEST_H
       
    23 
       
    24 // INCLUDES
       
    25 #include <e32cmn.h>
       
    26 #include <e32base.h>
       
    27 #include <mpxfilter.h>
       
    28 		
       
    29 // FORWARD DECLARATIONS
       
    30 
       
    31 // CONSTANTS
       
    32 
       
    33 // CLASS DECLARATION
       
    34 
       
    35 /**
       
    36  *  CGlxRequest class 
       
    37  *
       
    38  *  Requests encapsulate the requests with filters that can be sent from
       
    39  *  collection plugins to the Data Source Manager.
       
    40  *	@ingroup collection_component_design
       
    41  *  @internal reviewed 11/07/2007 by Dave Schofield
       
    42  */
       
    43 class CGlxRequest : public CBase 
       
    44 	{
       
    45 public:
       
    46 	IMPORT_C virtual ~CGlxRequest();
       
    47 
       
    48 	/**
       
    49 	 * Collection plugin UID.
       
    50 	 * Gets the UID of the collection plugin that created this request.
       
    51 	 * @return the UID of the collection plugin that created this request.
       
    52 	 */
       
    53 	IMPORT_C TUid CollectionPluginUid() const;
       
    54 	IMPORT_C CMPXFilter* Filter() const;
       
    55 	
       
    56 	inline const TBool DoNotNeedDataSource() const
       
    57 	{
       
    58 	return iDoNotNeedDataSource;
       
    59 	}
       
    60 	
       
    61 
       
    62 
       
    63 protected:
       
    64 	CGlxRequest(const TUid& aCollectionPluginUid, const TBool aDoNotNeedDataSource = EFalse);
       
    65 	void ConstructL(const CMPXFilter* aFilter);
       
    66 
       
    67 private:
       
    68 	const TUid iCollectionPluginUid;
       
    69 	CMPXFilter* iFilter;
       
    70 protected:
       
    71 	const TBool iDoNotNeedDataSource;
       
    72 	};
       
    73 
       
    74 #endif // C_GLXREQUEST_H
       
    75