classicui_plat/common_file_dialogs_api/inc/MAknFileFilter.h
author hgs
Thu, 29 Jul 2010 14:21:56 +0800
changeset 46 0e1e0022bd03
permissions -rw-r--r--
201029_1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
46
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
     1
/*
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
     2
* Copyright (c) 2002-2006 Nokia Corporation and/or its subsidiary(-ies).
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
     3
* All rights reserved.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
     8
*
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
     9
* Initial Contributors:
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    11
*
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    12
* Contributors:
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    13
*
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    14
* Description:  Filter interface for file selection.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    15
*
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    16
*/
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    17
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    18
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    19
#ifndef MAKNFILEFILTER_H
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    20
#define MAKNFILEFILTER_H
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    21
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    22
// INCLUDES
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    23
#include <e32def.h> // TBool
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    24
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    25
// FORWARD DECLARATIONS
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    26
class TEntry;
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    27
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    28
//  CLASS DEFINITION
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    29
/**
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    30
*  An abstract interface class for filters.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    31
*
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    32
*  @lib CommonDialogs.lib
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    33
*  @since 1.2
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    34
*/
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    35
class MAknFileFilter
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    36
    {
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    37
    public:     // Constructors and destructors
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    38
        /**
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    39
        * A virtual destructor to ensure that correct destructor gets called.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    40
        * Must have an empty implementation.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    41
        */
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    42
        virtual ~MAknFileFilter() { };
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    43
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    44
    public:
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    45
        /**
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    46
        * Checks if a file is accepted by the filter.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    47
        * @param aDriveAndPath Drive and full path of the file.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    48
        * @param aEntry A directory entry.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    49
        * @return Returns ETrue if filter accepts the file.
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    50
        */
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    51
        virtual TBool Accept( const TDesC& aDriveAndPath, const TEntry& aEntry ) const = 0;
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    52
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    53
    };
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    54
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    55
#endif // MAKNFILEFILTER_H
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    56
0e1e0022bd03 201029_1
hgs
parents:
diff changeset
    57
// End of File