epoc32/include/mw/maknfilefilter.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2002-2006 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:  Filter interface for file selection.
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
williamr@2
    19
#ifndef MAKNFILEFILTER_H
williamr@2
    20
#define MAKNFILEFILTER_H
williamr@2
    21
williamr@2
    22
// INCLUDES
williamr@2
    23
#include <E32DEF.H> // TBool
williamr@2
    24
williamr@2
    25
// FORWARD DECLARATIONS
williamr@2
    26
class TEntry;
williamr@2
    27
williamr@2
    28
//  CLASS DEFINITION
williamr@2
    29
/**
williamr@2
    30
*  An abstract interface class for filters.
williamr@2
    31
*
williamr@2
    32
*  @lib CommonDialogs.lib
williamr@2
    33
*  @since 1.2
williamr@2
    34
*/
williamr@2
    35
class MAknFileFilter
williamr@2
    36
    {
williamr@2
    37
    public:     // Constructors and destructors
williamr@2
    38
        /**
williamr@2
    39
        * A virtual destructor to ensure that correct destructor gets called.
williamr@2
    40
        * Must have an empty implementation.
williamr@2
    41
        */
williamr@2
    42
        virtual ~MAknFileFilter() { };
williamr@2
    43
williamr@2
    44
    public:
williamr@2
    45
        /**
williamr@2
    46
        * Checks if a file is accepted by the filter.
williamr@2
    47
        * @param aDriveAndPath Drive and full path of the file.
williamr@2
    48
        * @param aEntry A directory entry.
williamr@2
    49
        * @return Returns ETrue if filter accepts the file.
williamr@2
    50
        */
williamr@2
    51
        virtual TBool Accept( const TDesC& aDriveAndPath, const TEntry& aEntry ) const = 0;
williamr@2
    52
williamr@2
    53
    };
williamr@2
    54
williamr@2
    55
#endif // MAKNFILEFILTER_H
williamr@2
    56
williamr@2
    57
// End of File