epoc32/include/mw/mgfetch.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
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@4
     5
* under the terms of "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.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@4
    34
*  MGFetch can be used to to fetch media files from third party applications.
williamr@4
    35
*  Supported TMediaFileType's EImageFile, EVideoFile, EAudioFile and EMusicFile.
williamr@2
    36
*
williamr@2
    37
*  @lib MGFetch.lib
williamr@2
    38
*  @since 2.0
williamr@2
    39
*/
williamr@2
    40
class MGFetch
williamr@2
    41
    {
williamr@2
    42
    public: // New functions
williamr@2
    43
williamr@2
    44
        /**
williamr@2
    45
        * Launch media file fetcher for single media type
williamr@2
    46
        *
williamr@2
    47
        * @since 2.0
williamr@2
    48
        * @param aSelectedFiles Array to hold selected files
williamr@2
    49
        * @param aMediaType Defines what media files to fetch
williamr@2
    50
        * @param aMultiSelect Single or multiple file selection
williamr@2
    51
        * @param aVerifier Optional verifier for file selection
williamr@2
    52
        * @return ETrue if user selected file(s), EFalse if cancelled
williamr@4
    53
        *
williamr@4
    54
        * will leave with KErrNotSupported if plugin for wanted content
williamr@4
    55
        * is not found.
williamr@2
    56
        */
williamr@2
    57
        IMPORT_C static TBool RunL( CDesCArray& aSelectedFiles,
williamr@2
    58
                                    TMediaFileType aMediaType,
williamr@2
    59
                                    TBool aMultiSelect,
williamr@2
    60
                                    MMGFetchVerifier* aVerifier = NULL );
williamr@2
    61
williamr@2
    62
        /**
williamr@2
    63
        * Launch media file fetcher for single media type
williamr@2
    64
        *
williamr@2
    65
        * @since 2.6
williamr@2
    66
        * @param aSelectedFiles Array to hold selected files
williamr@2
    67
        * @param aMediaType Defines what media files to fetch
williamr@2
    68
        * @param aMultiSelect Single or multiple file selection
williamr@2
    69
        * @param aSelectionSoftkey Optional text for left softkey
williamr@2
    70
        *        (KNullDesC for default text)
williamr@2
    71
        * @param aHeading Optional text for popup heading
williamr@2
    72
        *        (KNullDesC for default text)
williamr@2
    73
        * @param aVerifier Optional verifier for file selection
williamr@2
    74
        * @return ETrue if user selected file(s), EFalse if cancelled
williamr@4
    75
        *
williamr@4
    76
        * will leave with KErrNotSupported if plugin for wanted content
williamr@4
    77
        * is not found.
williamr@2
    78
        */
williamr@2
    79
        IMPORT_C static TBool RunL( CDesCArray& aSelectedFiles,
williamr@2
    80
                                    TMediaFileType aMediaType,
williamr@2
    81
                                    TBool aMultiSelect,
williamr@2
    82
                                    const TDesC& aSelectionSoftkey,
williamr@2
    83
                                    const TDesC& aHeading,
williamr@2
    84
                                    MMGFetchVerifier* aVerifier = NULL );
williamr@2
    85
williamr@2
    86
        /**
williamr@2
    87
        * Launch media file fetcher for single media type
williamr@2
    88
        *
williamr@2
    89
        * @since 2.6
williamr@2
    90
        * @param aSelectedFiles Array to hold selected files
williamr@2
    91
        * @param aMediaType Defines what media files to fetch
williamr@2
    92
        * @param aMultiSelect Single or multiple file selection
williamr@2
    93
        * @param aSelectionSoftkey Optional text for left softkey
williamr@2
    94
        *        (KNullDesC for default text)
williamr@2
    95
        * @param aHeading Optional text for popup heading
williamr@2
    96
        *        (KNullDesC for default text)
williamr@2
    97
        * @param aMimeTypes Optional array containing MIME types of files
williamr@2
    98
        *                   which are displayed in the fetcher
williamr@2
    99
        * @param aVerifier Optional verifier for file selection
williamr@2
   100
        * @return ETrue if user selected file(s), EFalse if cancelled
williamr@4
   101
        *
williamr@4
   102
        * will leave with KErrNotSupported if plugin for wanted content
williamr@4
   103
        * is not found.
williamr@2
   104
        */
williamr@2
   105
        IMPORT_C static TBool RunL( CDesCArray& aSelectedFiles,
williamr@2
   106
                                    TMediaFileType aMediaType,
williamr@2
   107
                                    TBool aMultiSelect,
williamr@2
   108
                                    const TDesC& aSelectionSoftkey,
williamr@2
   109
                                    const TDesC& aHeading,
williamr@2
   110
                                    MDesCArray* aMimeTypes,
williamr@2
   111
                                    MMGFetchVerifier* aVerifier = NULL );
williamr@2
   112
williamr@2
   113
        /**
williamr@2
   114
        * Launch media file fetcher for single media type
williamr@2
   115
        *
williamr@2
   116
        * @since 2.6
williamr@2
   117
        * @param aSelectedFiles Array to hold selected files
williamr@2
   118
        * @param aMediaType Defines what media files to fetch
williamr@2
   119
        * @param aMultiSelect Single or multiple file selection
williamr@2
   120
        * @param aSelectionSoftkey Optional text for left softkey
williamr@2
   121
        *        (KNullDesC for default text)
williamr@2
   122
        * @param aHeading Optional text for popup heading
williamr@2
   123
        *        (KNullDesC for default text)
williamr@2
   124
        * @param aMimeTypes Optional array containing MIME types of files
williamr@2
   125
        *                   which are displayed in the fetcher
williamr@2
   126
        * @param aCanceler Reference to canceler interface pointer
williamr@2
   127
        * @param aVerifier Optional verifier for file selection
williamr@2
   128
        * @return ETrue if user selected file(s), EFalse if cancelled
williamr@4
   129
        *
williamr@4
   130
        * will leave with KErrNotSupported if plugin for wanted content
williamr@4
   131
        * is not found.
williamr@2
   132
        */
williamr@2
   133
        IMPORT_C static TBool RunL( CDesCArray& aSelectedFiles,
williamr@2
   134
                                    TMediaFileType aMediaType,
williamr@2
   135
                                    TBool aMultiSelect,
williamr@2
   136
                                    const TDesC& aSelectionSoftkey,
williamr@2
   137
                                    const TDesC& aHeading,
williamr@2
   138
                                    MDesCArray* aMimeTypes,
williamr@2
   139
                                    MMGFetchCanceler*& aCanceler,
williamr@2
   140
                                    MMGFetchVerifier* aVerifier = NULL
williamr@2
   141
                                    );
williamr@2
   142
williamr@2
   143
    };
williamr@2
   144
#endif // MGFETCH_H
williamr@2
   145
williamr@2
   146
// End of File