1 mgfetch.h

     1 /*

     2 * Copyright (c) 2002 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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  Media fetch API

    15 *

    16 */

    17 

    18 

    19 #ifndef MGFETCH_H

    20 #define MGFETCH_H

    21 

    22 // INCLUDES

    23 #include <e32base.h>

    24 #include <MediaFileTypes.hrh>

    25 #include <badesca.h>

    26 

    27 // FORWARD DECLARATIONS

    28 class MMGFetchVerifier;

    29 class MMGFetchCanceler;

    30 

    31 // CLASS DECLARATION

    32 

    33 /**

    34 *  MGFetch can be used to to fetch media files from third party applications

    35 *

    36 *  @lib MGFetch.lib

    37 *  @since 2.0

    38 */

    39 class MGFetch

    40     {

    41     public: // New functions

    42 

    43         /**

    44         * Launch media file fetcher for single media type

    45         *

    46         * @since 2.0

    47         * @param aSelectedFiles Array to hold selected files

    48         * @param aMediaType Defines what media files to fetch

    49         * @param aMultiSelect Single or multiple file selection

    50         * @param aVerifier Optional verifier for file selection

    51         * @return ETrue if user selected file(s), EFalse if cancelled

    52         */

    53         IMPORT_C static TBool RunL( CDesCArray& aSelectedFiles,

    54                                     TMediaFileType aMediaType,

    55                                     TBool aMultiSelect,

    56                                     MMGFetchVerifier* aVerifier = NULL );

    57 

    58         /**

    59         * Launch media file fetcher for single media type

    60         *

    61         * @since 2.6

    62         * @param aSelectedFiles Array to hold selected files

    63         * @param aMediaType Defines what media files to fetch

    64         * @param aMultiSelect Single or multiple file selection

    65         * @param aSelectionSoftkey Optional text for left softkey

    66         *        (KNullDesC for default text)

    67         * @param aHeading Optional text for popup heading

    68         *        (KNullDesC for default text)

    69         * @param aVerifier Optional verifier for file selection

    70         * @return ETrue if user selected file(s), EFalse if cancelled

    71         */

    72         IMPORT_C static TBool RunL( CDesCArray& aSelectedFiles,

    73                                     TMediaFileType aMediaType,

    74                                     TBool aMultiSelect,

    75                                     const TDesC& aSelectionSoftkey,

    76                                     const TDesC& aHeading,

    77                                     MMGFetchVerifier* aVerifier = NULL );

    78 

    79         /**

    80         * Launch media file fetcher for single media type

    81         *

    82         * @since 2.6

    83         * @param aSelectedFiles Array to hold selected files

    84         * @param aMediaType Defines what media files to fetch

    85         * @param aMultiSelect Single or multiple file selection

    86         * @param aSelectionSoftkey Optional text for left softkey

    87         *        (KNullDesC for default text)

    88         * @param aHeading Optional text for popup heading

    89         *        (KNullDesC for default text)

    90         * @param aMimeTypes Optional array containing MIME types of files

    91         *                   which are displayed in the fetcher

    92         * @param aVerifier Optional verifier for file selection

    93         * @return ETrue if user selected file(s), EFalse if cancelled

    94         */

    95         IMPORT_C static TBool RunL( CDesCArray& aSelectedFiles,

    96                                     TMediaFileType aMediaType,

    97                                     TBool aMultiSelect,

    98                                     const TDesC& aSelectionSoftkey,

    99                                     const TDesC& aHeading,

   100                                     MDesCArray* aMimeTypes,

   101                                     MMGFetchVerifier* aVerifier = NULL );

   102 

   103         /**

   104         * Launch media file fetcher for single media type

   105         *

   106         * @since 2.6

   107         * @param aSelectedFiles Array to hold selected files

   108         * @param aMediaType Defines what media files to fetch

   109         * @param aMultiSelect Single or multiple file selection

   110         * @param aSelectionSoftkey Optional text for left softkey

   111         *        (KNullDesC for default text)

   112         * @param aHeading Optional text for popup heading

   113         *        (KNullDesC for default text)

   114         * @param aMimeTypes Optional array containing MIME types of files

   115         *                   which are displayed in the fetcher

   116         * @param aCanceler Reference to canceler interface pointer

   117         * @param aVerifier Optional verifier for file selection

   118         * @return ETrue if user selected file(s), EFalse if cancelled

   119         */

   120         IMPORT_C static TBool RunL( CDesCArray& aSelectedFiles,

   121                                     TMediaFileType aMediaType,

   122                                     TBool aMultiSelect,

   123                                     const TDesC& aSelectionSoftkey,

   124                                     const TDesC& aHeading,

   125                                     MDesCArray* aMimeTypes,

   126                                     MMGFetchCanceler*& aCanceler,

   127                                     MMGFetchVerifier* aVerifier = NULL

   128                                     );

   129 

   130     };

   131 #endif // MGFETCH_H

   132 

   133 // End of File