williamr@2: /*
williamr@2: * Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: * All rights reserved.
williamr@2: * This component and the accompanying materials are made available
williamr@2: * 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: * which accompanies this distribution, and is available
williamr@2: * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2: *
williamr@2: * Initial Contributors:
williamr@2: * Nokia Corporation - initial contribution.
williamr@2: *
williamr@2: * Contributors:
williamr@2: *
williamr@2: * Description:  Interface for implementing custom ordering for tree list.
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: 
williamr@2: #ifndef M_AKNCUSTOMTREEORDERING_H
williamr@2: #define M_AKNCUSTOMTREEORDERING_H
williamr@2: 
williamr@2: 
williamr@2: #include <akntreelistconstants.h>
williamr@2: 
williamr@2: 
williamr@2: /**
williamr@2:  *  Interface class for implementing custom ordering for hierarchical list.
williamr@2:  *
williamr@2:  *  Implementation of this interface class can be set to hierarchical
williamr@2:  *  list to define the ordering of items in the list. Hierarchical list
williamr@2:  *  then uses the implementation of @c MAknCustomTreeOrdering::Compare
williamr@2:  *  method in sorting the items within each node of the list.
williamr@2:  *
williamr@2:  *  @since S60 v3.2
williamr@2:  */
williamr@2: class MAknCustomTreeOrdering
williamr@2:     {
williamr@2: 
williamr@2: public:
williamr@2: 
williamr@2:     /**
williamr@2:      * Compares two tree list items.
williamr@2:      *
williamr@2:      * @param aFirst Item ID of the first compared hierarchical list item.
williamr@2:      *
williamr@2:      * @param aSecond Item ID of the second compared hierarchical list item.
williamr@2:      *
williamr@2:      * @return Positive, if the first item is greater than the second item;
williamr@2:      *      negative, if the first item is less than the second item;
williamr@2:      *      and zero, if the items are equal.
williamr@2:      */
williamr@2:     virtual TInt Compare( TAknTreeItemID aFirst, TAknTreeItemID aSecond ) = 0;
williamr@2: 
williamr@2:     };
williamr@2: 
williamr@2: 
williamr@2: #endif // M_AKNCUSTOMTREEORDERING_H