epoc32/include/mw/mgfetch.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:27:01 +0100
branchSymbian2
changeset 3 e1b950c65cb4
parent 1 666f914201fb
child 4 837f303aceeb
permissions -rw-r--r--
Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies). 
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     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
williamr@2
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:  Media fetch API
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
williamr@2
    19
#ifndef MGFETCH_H
williamr@2
    20
#define MGFETCH_H
williamr@2
    21
williamr@2
    22
// INCLUDES
williamr@2
    23
#include <e32base.h>
williamr@2
    24
#include <MediaFileTypes.hrh>
williamr@2
    25
#include <badesca.h>
williamr@2
    26
williamr@2
    27
// FORWARD DECLARATIONS
williamr@2
    28
class MMGFetchVerifier;
williamr@2
    29
class MMGFetchCanceler;
williamr@2
    30
williamr@2
    31
// CLASS DECLARATION
williamr@2
    32
williamr@2
    33
/**
williamr@2
    34
*  MGFetch can be used to to fetch media files from third party applications
williamr@2
    35
*
williamr@2
    36
*  @lib MGFetch.lib
williamr@2
    37
*  @since 2.0
williamr@2
    38
*/
williamr@2
    39
class MGFetch
williamr@2
    40
    {
williamr@2
    41
    public: // New functions
williamr@2
    42
williamr@2
    43
        /**
williamr@2
    44
        * Launch media file fetcher for single media type
williamr@2
    45
        *
williamr@2
    46
        * @since 2.0
williamr@2
    47
        * @param aSelectedFiles Array to hold selected files
williamr@2
    48
        * @param aMediaType Defines what media files to fetch
williamr@2
    49
        * @param aMultiSelect Single or multiple file selection
williamr@2
    50
        * @param aVerifier Optional verifier for file selection
williamr@2
    51
        * @return ETrue if user selected file(s), EFalse if cancelled
williamr@2
    52
        */
williamr@2
    53
        IMPORT_C static TBool RunL( CDesCArray& aSelectedFiles,
williamr@2
    54
                                    TMediaFileType aMediaType,
williamr@2
    55
                                    TBool aMultiSelect,
williamr@2
    56
                                    MMGFetchVerifier* aVerifier = NULL );
williamr@2
    57
williamr@2
    58
        /**
williamr@2
    59
        * Launch media file fetcher for single media type
williamr@2
    60
        *
williamr@2
    61
        * @since 2.6
williamr@2
    62
        * @param aSelectedFiles Array to hold selected files
williamr@2
    63
        * @param aMediaType Defines what media files to fetch
williamr@2
    64
        * @param aMultiSelect Single or multiple file selection
williamr@2
    65
        * @param aSelectionSoftkey Optional text for left softkey
williamr@2
    66
        *        (KNullDesC for default text)
williamr@2
    67
        * @param aHeading Optional text for popup heading
williamr@2
    68
        *        (KNullDesC for default text)
williamr@2
    69
        * @param aVerifier Optional verifier for file selection
williamr@2
    70
        * @return ETrue if user selected file(s), EFalse if cancelled
williamr@2
    71
        */
williamr@2
    72
        IMPORT_C static TBool RunL( CDesCArray& aSelectedFiles,
williamr@2
    73
                                    TMediaFileType aMediaType,
williamr@2
    74
                                    TBool aMultiSelect,
williamr@2
    75
                                    const TDesC& aSelectionSoftkey,
williamr@2
    76
                                    const TDesC& aHeading,
williamr@2
    77
                                    MMGFetchVerifier* aVerifier = NULL );
williamr@2
    78
williamr@2
    79
        /**
williamr@2
    80
        * Launch media file fetcher for single media type
williamr@2
    81
        *
williamr@2
    82
        * @since 2.6
williamr@2
    83
        * @param aSelectedFiles Array to hold selected files
williamr@2
    84
        * @param aMediaType Defines what media files to fetch
williamr@2
    85
        * @param aMultiSelect Single or multiple file selection
williamr@2
    86
        * @param aSelectionSoftkey Optional text for left softkey
williamr@2
    87
        *        (KNullDesC for default text)
williamr@2
    88
        * @param aHeading Optional text for popup heading
williamr@2
    89
        *        (KNullDesC for default text)
williamr@2
    90
        * @param aMimeTypes Optional array containing MIME types of files
williamr@2
    91
        *                   which are displayed in the fetcher
williamr@2
    92
        * @param aVerifier Optional verifier for file selection
williamr@2
    93
        * @return ETrue if user selected file(s), EFalse if cancelled
williamr@2
    94
        */
williamr@2
    95
        IMPORT_C static TBool RunL( CDesCArray& aSelectedFiles,
williamr@2
    96
                                    TMediaFileType aMediaType,
williamr@2
    97
                                    TBool aMultiSelect,
williamr@2
    98
                                    const TDesC& aSelectionSoftkey,
williamr@2
    99
                                    const TDesC& aHeading,
williamr@2
   100
                                    MDesCArray* aMimeTypes,
williamr@2
   101
                                    MMGFetchVerifier* aVerifier = NULL );
williamr@2
   102
williamr@2
   103
        /**
williamr@2
   104
        * Launch media file fetcher for single media type
williamr@2
   105
        *
williamr@2
   106
        * @since 2.6
williamr@2
   107
        * @param aSelectedFiles Array to hold selected files
williamr@2
   108
        * @param aMediaType Defines what media files to fetch
williamr@2
   109
        * @param aMultiSelect Single or multiple file selection
williamr@2
   110
        * @param aSelectionSoftkey Optional text for left softkey
williamr@2
   111
        *        (KNullDesC for default text)
williamr@2
   112
        * @param aHeading Optional text for popup heading
williamr@2
   113
        *        (KNullDesC for default text)
williamr@2
   114
        * @param aMimeTypes Optional array containing MIME types of files
williamr@2
   115
        *                   which are displayed in the fetcher
williamr@2
   116
        * @param aCanceler Reference to canceler interface pointer
williamr@2
   117
        * @param aVerifier Optional verifier for file selection
williamr@2
   118
        * @return ETrue if user selected file(s), EFalse if cancelled
williamr@2
   119
        */
williamr@2
   120
        IMPORT_C static TBool RunL( CDesCArray& aSelectedFiles,
williamr@2
   121
                                    TMediaFileType aMediaType,
williamr@2
   122
                                    TBool aMultiSelect,
williamr@2
   123
                                    const TDesC& aSelectionSoftkey,
williamr@2
   124
                                    const TDesC& aHeading,
williamr@2
   125
                                    MDesCArray* aMimeTypes,
williamr@2
   126
                                    MMGFetchCanceler*& aCanceler,
williamr@2
   127
                                    MMGFetchVerifier* aVerifier = NULL
williamr@2
   128
                                    );
williamr@2
   129
williamr@2
   130
    };
williamr@2
   131
#endif // MGFETCH_H
williamr@2
   132
williamr@2
   133
// End of File