epoc32/include/mw/mgfetch.h
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
equal deleted inserted replaced
3:e1b950c65cb4 4:837f303aceeb
     1 /*
     1 /*
     2 * Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies). 
     2 * Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies). 
     3 * All rights reserved.
     3 * All rights reserved.
     4 * This component and the accompanying materials are made available
     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
     5 * under the terms of "Eclipse Public License v1.0"
     6 * which accompanies this distribution, and is available
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
     8 *
     8 *
     9 * Initial Contributors:
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    10 * Nokia Corporation - initial contribution.
    11 *
    11 *
    12 * Contributors:
    12 * Contributors:
    29 class MMGFetchCanceler;
    29 class MMGFetchCanceler;
    30 
    30 
    31 // CLASS DECLARATION
    31 // CLASS DECLARATION
    32 
    32 
    33 /**
    33 /**
    34 *  MGFetch can be used to to fetch media files from third party applications
    34 *  MGFetch can be used to to fetch media files from third party applications.
       
    35 *  Supported TMediaFileType's EImageFile, EVideoFile, EAudioFile and EMusicFile.
    35 *
    36 *
    36 *  @lib MGFetch.lib
    37 *  @lib MGFetch.lib
    37 *  @since 2.0
    38 *  @since 2.0
    38 */
    39 */
    39 class MGFetch
    40 class MGFetch
    47         * @param aSelectedFiles Array to hold selected files
    48         * @param aSelectedFiles Array to hold selected files
    48         * @param aMediaType Defines what media files to fetch
    49         * @param aMediaType Defines what media files to fetch
    49         * @param aMultiSelect Single or multiple file selection
    50         * @param aMultiSelect Single or multiple file selection
    50         * @param aVerifier Optional verifier for file selection
    51         * @param aVerifier Optional verifier for file selection
    51         * @return ETrue if user selected file(s), EFalse if cancelled
    52         * @return ETrue if user selected file(s), EFalse if cancelled
       
    53         *
       
    54         * will leave with KErrNotSupported if plugin for wanted content
       
    55         * is not found.
    52         */
    56         */
    53         IMPORT_C static TBool RunL( CDesCArray& aSelectedFiles,
    57         IMPORT_C static TBool RunL( CDesCArray& aSelectedFiles,
    54                                     TMediaFileType aMediaType,
    58                                     TMediaFileType aMediaType,
    55                                     TBool aMultiSelect,
    59                                     TBool aMultiSelect,
    56                                     MMGFetchVerifier* aVerifier = NULL );
    60                                     MMGFetchVerifier* aVerifier = NULL );
    66         *        (KNullDesC for default text)
    70         *        (KNullDesC for default text)
    67         * @param aHeading Optional text for popup heading
    71         * @param aHeading Optional text for popup heading
    68         *        (KNullDesC for default text)
    72         *        (KNullDesC for default text)
    69         * @param aVerifier Optional verifier for file selection
    73         * @param aVerifier Optional verifier for file selection
    70         * @return ETrue if user selected file(s), EFalse if cancelled
    74         * @return ETrue if user selected file(s), EFalse if cancelled
       
    75         *
       
    76         * will leave with KErrNotSupported if plugin for wanted content
       
    77         * is not found.
    71         */
    78         */
    72         IMPORT_C static TBool RunL( CDesCArray& aSelectedFiles,
    79         IMPORT_C static TBool RunL( CDesCArray& aSelectedFiles,
    73                                     TMediaFileType aMediaType,
    80                                     TMediaFileType aMediaType,
    74                                     TBool aMultiSelect,
    81                                     TBool aMultiSelect,
    75                                     const TDesC& aSelectionSoftkey,
    82                                     const TDesC& aSelectionSoftkey,
    89         *        (KNullDesC for default text)
    96         *        (KNullDesC for default text)
    90         * @param aMimeTypes Optional array containing MIME types of files
    97         * @param aMimeTypes Optional array containing MIME types of files
    91         *                   which are displayed in the fetcher
    98         *                   which are displayed in the fetcher
    92         * @param aVerifier Optional verifier for file selection
    99         * @param aVerifier Optional verifier for file selection
    93         * @return ETrue if user selected file(s), EFalse if cancelled
   100         * @return ETrue if user selected file(s), EFalse if cancelled
       
   101         *
       
   102         * will leave with KErrNotSupported if plugin for wanted content
       
   103         * is not found.
    94         */
   104         */
    95         IMPORT_C static TBool RunL( CDesCArray& aSelectedFiles,
   105         IMPORT_C static TBool RunL( CDesCArray& aSelectedFiles,
    96                                     TMediaFileType aMediaType,
   106                                     TMediaFileType aMediaType,
    97                                     TBool aMultiSelect,
   107                                     TBool aMultiSelect,
    98                                     const TDesC& aSelectionSoftkey,
   108                                     const TDesC& aSelectionSoftkey,
   114         * @param aMimeTypes Optional array containing MIME types of files
   124         * @param aMimeTypes Optional array containing MIME types of files
   115         *                   which are displayed in the fetcher
   125         *                   which are displayed in the fetcher
   116         * @param aCanceler Reference to canceler interface pointer
   126         * @param aCanceler Reference to canceler interface pointer
   117         * @param aVerifier Optional verifier for file selection
   127         * @param aVerifier Optional verifier for file selection
   118         * @return ETrue if user selected file(s), EFalse if cancelled
   128         * @return ETrue if user selected file(s), EFalse if cancelled
       
   129         *
       
   130         * will leave with KErrNotSupported if plugin for wanted content
       
   131         * is not found.
   119         */
   132         */
   120         IMPORT_C static TBool RunL( CDesCArray& aSelectedFiles,
   133         IMPORT_C static TBool RunL( CDesCArray& aSelectedFiles,
   121                                     TMediaFileType aMediaType,
   134                                     TMediaFileType aMediaType,
   122                                     TBool aMultiSelect,
   135                                     TBool aMultiSelect,
   123                                     const TDesC& aSelectionSoftkey,
   136                                     const TDesC& aSelectionSoftkey,