epoc32/include/mw/akncustomtreeordering.h
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
--- a/epoc32/include/mw/akncustomtreeordering.h	Tue Nov 24 13:55:44 2009 +0000
+++ b/epoc32/include/mw/akncustomtreeordering.h	Tue Mar 16 16:12:26 2010 +0000
@@ -1,1 +1,57 @@
-akncustomtreeordering.h
+/*
+* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* 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
+* which accompanies this distribution, and is available
+* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:  Interface for implementing custom ordering for tree list.
+*
+*/
+
+
+#ifndef M_AKNCUSTOMTREEORDERING_H
+#define M_AKNCUSTOMTREEORDERING_H
+
+
+#include <akntreelistconstants.h>
+
+
+/**
+ *  Interface class for implementing custom ordering for hierarchical list.
+ *
+ *  Implementation of this interface class can be set to hierarchical
+ *  list to define the ordering of items in the list. Hierarchical list
+ *  then uses the implementation of @c MAknCustomTreeOrdering::Compare
+ *  method in sorting the items within each node of the list.
+ *
+ *  @since S60 v3.2
+ */
+class MAknCustomTreeOrdering
+    {
+
+public:
+
+    /**
+     * Compares two tree list items.
+     *
+     * @param aFirst Item ID of the first compared hierarchical list item.
+     *
+     * @param aSecond Item ID of the second compared hierarchical list item.
+     *
+     * @return Positive, if the first item is greater than the second item;
+     *      negative, if the first item is less than the second item;
+     *      and zero, if the items are equal.
+     */
+    virtual TInt Compare( TAknTreeItemID aFirst, TAknTreeItemID aSecond ) = 0;
+
+    };
+
+
+#endif // M_AKNCUSTOMTREEORDERING_H