metadatasrv_pub/media_fetch_api/inc/MGFetch.h
changeset 0 31ef7fef3f45
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/metadatasrv_pub/media_fetch_api/inc/MGFetch.h	Thu Dec 17 08:55:22 2009 +0200
@@ -0,0 +1,146 @@
+/*
+* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies). 
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:  Media fetch API
+*
+*/
+
+
+#ifndef MGFETCH_H
+#define MGFETCH_H
+
+// INCLUDES
+#include <e32base.h>
+#include <MediaFileTypes.hrh>
+#include <badesca.h>
+
+// FORWARD DECLARATIONS
+class MMGFetchVerifier;
+class MMGFetchCanceler;
+
+// CLASS DECLARATION
+
+/**
+*  MGFetch can be used to to fetch media files from third party applications.
+*  Supported TMediaFileType's EImageFile, EVideoFile, EAudioFile and EMusicFile.
+*
+*  @lib MGFetch.lib
+*  @since 2.0
+*/
+class MGFetch
+    {
+    public: // New functions
+
+        /**
+        * Launch media file fetcher for single media type
+        *
+        * @since 2.0
+        * @param aSelectedFiles Array to hold selected files
+        * @param aMediaType Defines what media files to fetch
+        * @param aMultiSelect Single or multiple file selection
+        * @param aVerifier Optional verifier for file selection
+        * @return ETrue if user selected file(s), EFalse if cancelled
+        *
+        * will leave with KErrNotSupported if plugin for wanted content
+        * is not found.
+        */
+        IMPORT_C static TBool RunL( CDesCArray& aSelectedFiles,
+                                    TMediaFileType aMediaType,
+                                    TBool aMultiSelect,
+                                    MMGFetchVerifier* aVerifier = NULL );
+
+        /**
+        * Launch media file fetcher for single media type
+        *
+        * @since 2.6
+        * @param aSelectedFiles Array to hold selected files
+        * @param aMediaType Defines what media files to fetch
+        * @param aMultiSelect Single or multiple file selection
+        * @param aSelectionSoftkey Optional text for left softkey
+        *        (KNullDesC for default text)
+        * @param aHeading Optional text for popup heading
+        *        (KNullDesC for default text)
+        * @param aVerifier Optional verifier for file selection
+        * @return ETrue if user selected file(s), EFalse if cancelled
+        *
+        * will leave with KErrNotSupported if plugin for wanted content
+        * is not found.
+        */
+        IMPORT_C static TBool RunL( CDesCArray& aSelectedFiles,
+                                    TMediaFileType aMediaType,
+                                    TBool aMultiSelect,
+                                    const TDesC& aSelectionSoftkey,
+                                    const TDesC& aHeading,
+                                    MMGFetchVerifier* aVerifier = NULL );
+
+        /**
+        * Launch media file fetcher for single media type
+        *
+        * @since 2.6
+        * @param aSelectedFiles Array to hold selected files
+        * @param aMediaType Defines what media files to fetch
+        * @param aMultiSelect Single or multiple file selection
+        * @param aSelectionSoftkey Optional text for left softkey
+        *        (KNullDesC for default text)
+        * @param aHeading Optional text for popup heading
+        *        (KNullDesC for default text)
+        * @param aMimeTypes Optional array containing MIME types of files
+        *                   which are displayed in the fetcher
+        * @param aVerifier Optional verifier for file selection
+        * @return ETrue if user selected file(s), EFalse if cancelled
+        *
+        * will leave with KErrNotSupported if plugin for wanted content
+        * is not found.
+        */
+        IMPORT_C static TBool RunL( CDesCArray& aSelectedFiles,
+                                    TMediaFileType aMediaType,
+                                    TBool aMultiSelect,
+                                    const TDesC& aSelectionSoftkey,
+                                    const TDesC& aHeading,
+                                    MDesCArray* aMimeTypes,
+                                    MMGFetchVerifier* aVerifier = NULL );
+
+        /**
+        * Launch media file fetcher for single media type
+        *
+        * @since 2.6
+        * @param aSelectedFiles Array to hold selected files
+        * @param aMediaType Defines what media files to fetch
+        * @param aMultiSelect Single or multiple file selection
+        * @param aSelectionSoftkey Optional text for left softkey
+        *        (KNullDesC for default text)
+        * @param aHeading Optional text for popup heading
+        *        (KNullDesC for default text)
+        * @param aMimeTypes Optional array containing MIME types of files
+        *                   which are displayed in the fetcher
+        * @param aCanceler Reference to canceler interface pointer
+        * @param aVerifier Optional verifier for file selection
+        * @return ETrue if user selected file(s), EFalse if cancelled
+        *
+        * will leave with KErrNotSupported if plugin for wanted content
+        * is not found.
+        */
+        IMPORT_C static TBool RunL( CDesCArray& aSelectedFiles,
+                                    TMediaFileType aMediaType,
+                                    TBool aMultiSelect,
+                                    const TDesC& aSelectionSoftkey,
+                                    const TDesC& aHeading,
+                                    MDesCArray* aMimeTypes,
+                                    MMGFetchCanceler*& aCanceler,
+                                    MMGFetchVerifier* aVerifier = NULL
+                                    );
+
+    };
+#endif // MGFETCH_H
+
+// End of File