epoc32/include/mw/mgfetch.h
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
--- a/epoc32/include/mw/mgfetch.h	Tue Nov 24 13:55:44 2009 +0000
+++ b/epoc32/include/mw/mgfetch.h	Tue Mar 16 16:12:26 2010 +0000
@@ -1,1 +1,133 @@
-mgfetch.h
+/*
+* 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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
+* which accompanies this distribution, and is available
+* at the URL "http://www.symbianfoundation.org/legal/licencesv10.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
+*
+*  @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
+        */
+        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
+        */
+        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
+        */
+        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
+        */
+        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