epoc32/include/mw/mgfetch.h
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
     1.1 --- a/epoc32/include/mw/mgfetch.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/mw/mgfetch.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,133 @@
     1.4 -mgfetch.h
     1.5 +/*
     1.6 +* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies). 
     1.7 +* All rights reserved.
     1.8 +* This component and the accompanying materials are made available
     1.9 +* 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
    1.10 +* which accompanies this distribution, and is available
    1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.12 +*
    1.13 +* Initial Contributors:
    1.14 +* Nokia Corporation - initial contribution.
    1.15 +*
    1.16 +* Contributors:
    1.17 +*
    1.18 +* Description:  Media fetch API
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 +
    1.23 +#ifndef MGFETCH_H
    1.24 +#define MGFETCH_H
    1.25 +
    1.26 +// INCLUDES
    1.27 +#include <e32base.h>
    1.28 +#include <MediaFileTypes.hrh>
    1.29 +#include <badesca.h>
    1.30 +
    1.31 +// FORWARD DECLARATIONS
    1.32 +class MMGFetchVerifier;
    1.33 +class MMGFetchCanceler;
    1.34 +
    1.35 +// CLASS DECLARATION
    1.36 +
    1.37 +/**
    1.38 +*  MGFetch can be used to to fetch media files from third party applications
    1.39 +*
    1.40 +*  @lib MGFetch.lib
    1.41 +*  @since 2.0
    1.42 +*/
    1.43 +class MGFetch
    1.44 +    {
    1.45 +    public: // New functions
    1.46 +
    1.47 +        /**
    1.48 +        * Launch media file fetcher for single media type
    1.49 +        *
    1.50 +        * @since 2.0
    1.51 +        * @param aSelectedFiles Array to hold selected files
    1.52 +        * @param aMediaType Defines what media files to fetch
    1.53 +        * @param aMultiSelect Single or multiple file selection
    1.54 +        * @param aVerifier Optional verifier for file selection
    1.55 +        * @return ETrue if user selected file(s), EFalse if cancelled
    1.56 +        */
    1.57 +        IMPORT_C static TBool RunL( CDesCArray& aSelectedFiles,
    1.58 +                                    TMediaFileType aMediaType,
    1.59 +                                    TBool aMultiSelect,
    1.60 +                                    MMGFetchVerifier* aVerifier = NULL );
    1.61 +
    1.62 +        /**
    1.63 +        * Launch media file fetcher for single media type
    1.64 +        *
    1.65 +        * @since 2.6
    1.66 +        * @param aSelectedFiles Array to hold selected files
    1.67 +        * @param aMediaType Defines what media files to fetch
    1.68 +        * @param aMultiSelect Single or multiple file selection
    1.69 +        * @param aSelectionSoftkey Optional text for left softkey
    1.70 +        *        (KNullDesC for default text)
    1.71 +        * @param aHeading Optional text for popup heading
    1.72 +        *        (KNullDesC for default text)
    1.73 +        * @param aVerifier Optional verifier for file selection
    1.74 +        * @return ETrue if user selected file(s), EFalse if cancelled
    1.75 +        */
    1.76 +        IMPORT_C static TBool RunL( CDesCArray& aSelectedFiles,
    1.77 +                                    TMediaFileType aMediaType,
    1.78 +                                    TBool aMultiSelect,
    1.79 +                                    const TDesC& aSelectionSoftkey,
    1.80 +                                    const TDesC& aHeading,
    1.81 +                                    MMGFetchVerifier* aVerifier = NULL );
    1.82 +
    1.83 +        /**
    1.84 +        * Launch media file fetcher for single media type
    1.85 +        *
    1.86 +        * @since 2.6
    1.87 +        * @param aSelectedFiles Array to hold selected files
    1.88 +        * @param aMediaType Defines what media files to fetch
    1.89 +        * @param aMultiSelect Single or multiple file selection
    1.90 +        * @param aSelectionSoftkey Optional text for left softkey
    1.91 +        *        (KNullDesC for default text)
    1.92 +        * @param aHeading Optional text for popup heading
    1.93 +        *        (KNullDesC for default text)
    1.94 +        * @param aMimeTypes Optional array containing MIME types of files
    1.95 +        *                   which are displayed in the fetcher
    1.96 +        * @param aVerifier Optional verifier for file selection
    1.97 +        * @return ETrue if user selected file(s), EFalse if cancelled
    1.98 +        */
    1.99 +        IMPORT_C static TBool RunL( CDesCArray& aSelectedFiles,
   1.100 +                                    TMediaFileType aMediaType,
   1.101 +                                    TBool aMultiSelect,
   1.102 +                                    const TDesC& aSelectionSoftkey,
   1.103 +                                    const TDesC& aHeading,
   1.104 +                                    MDesCArray* aMimeTypes,
   1.105 +                                    MMGFetchVerifier* aVerifier = NULL );
   1.106 +
   1.107 +        /**
   1.108 +        * Launch media file fetcher for single media type
   1.109 +        *
   1.110 +        * @since 2.6
   1.111 +        * @param aSelectedFiles Array to hold selected files
   1.112 +        * @param aMediaType Defines what media files to fetch
   1.113 +        * @param aMultiSelect Single or multiple file selection
   1.114 +        * @param aSelectionSoftkey Optional text for left softkey
   1.115 +        *        (KNullDesC for default text)
   1.116 +        * @param aHeading Optional text for popup heading
   1.117 +        *        (KNullDesC for default text)
   1.118 +        * @param aMimeTypes Optional array containing MIME types of files
   1.119 +        *                   which are displayed in the fetcher
   1.120 +        * @param aCanceler Reference to canceler interface pointer
   1.121 +        * @param aVerifier Optional verifier for file selection
   1.122 +        * @return ETrue if user selected file(s), EFalse if cancelled
   1.123 +        */
   1.124 +        IMPORT_C static TBool RunL( CDesCArray& aSelectedFiles,
   1.125 +                                    TMediaFileType aMediaType,
   1.126 +                                    TBool aMultiSelect,
   1.127 +                                    const TDesC& aSelectionSoftkey,
   1.128 +                                    const TDesC& aHeading,
   1.129 +                                    MDesCArray* aMimeTypes,
   1.130 +                                    MMGFetchCanceler*& aCanceler,
   1.131 +                                    MMGFetchVerifier* aVerifier = NULL
   1.132 +                                    );
   1.133 +
   1.134 +    };
   1.135 +#endif // MGFETCH_H
   1.136 +
   1.137 +// End of File