1.1 --- a/epoc32/include/mw/akncustomtreeordering.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/mw/akncustomtreeordering.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,57 @@
     1.4 -akncustomtreeordering.h
     1.5 +/*
     1.6 +* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
     1.7 +* All rights reserved.
     1.8 +* This component and the accompanying materials are made available
     1.9 +* 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
    1.10 +* which accompanies this distribution, and is available
    1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.12 +*
    1.13 +* Initial Contributors:
    1.14 +* Nokia Corporation - initial contribution.
    1.15 +*
    1.16 +* Contributors:
    1.17 +*
    1.18 +* Description:  Interface for implementing custom ordering for tree list.
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 +
    1.23 +#ifndef M_AKNCUSTOMTREEORDERING_H
    1.24 +#define M_AKNCUSTOMTREEORDERING_H
    1.25 +
    1.26 +
    1.27 +#include <akntreelistconstants.h>
    1.28 +
    1.29 +
    1.30 +/**
    1.31 + *  Interface class for implementing custom ordering for hierarchical list.
    1.32 + *
    1.33 + *  Implementation of this interface class can be set to hierarchical
    1.34 + *  list to define the ordering of items in the list. Hierarchical list
    1.35 + *  then uses the implementation of @c MAknCustomTreeOrdering::Compare
    1.36 + *  method in sorting the items within each node of the list.
    1.37 + *
    1.38 + *  @since S60 v3.2
    1.39 + */
    1.40 +class MAknCustomTreeOrdering
    1.41 +    {
    1.42 +
    1.43 +public:
    1.44 +
    1.45 +    /**
    1.46 +     * Compares two tree list items.
    1.47 +     *
    1.48 +     * @param aFirst Item ID of the first compared hierarchical list item.
    1.49 +     *
    1.50 +     * @param aSecond Item ID of the second compared hierarchical list item.
    1.51 +     *
    1.52 +     * @return Positive, if the first item is greater than the second item;
    1.53 +     *      negative, if the first item is less than the second item;
    1.54 +     *      and zero, if the items are equal.
    1.55 +     */
    1.56 +    virtual TInt Compare( TAknTreeItemID aFirst, TAknTreeItemID aSecond ) = 0;
    1.57 +
    1.58 +    };
    1.59 +
    1.60 +
    1.61 +#endif // M_AKNCUSTOMTREEORDERING_H