47 marked by list client with API methods, but when list is set markable, |
47 marked by list client with API methods, but when list is set markable, |
48 it responds to specified pointer and key event by marking/unmarking |
48 it responds to specified pointer and key event by marking/unmarking |
49 items as required. */ |
49 items as required. */ |
50 const TUint32 KAknTreeListMarkable = 0x0010; |
50 const TUint32 KAknTreeListMarkable = 0x0010; |
51 |
51 |
|
52 /** Flag to enalbe smiley in tree list. */ |
|
53 const TUint32 KAknTreeListSmiley = 0x0020; |
52 |
54 |
53 /** |
55 /** |
54 * Abstract base class for hierarchical lists. |
56 * Abstract base class for hierarchical lists. |
55 * |
57 * |
56 * This class functions as a base class for hierarchical lists. It contains |
58 * This class functions as a base class for hierarchical lists. It contains |
844 * |
846 * |
845 * @param aItem Item ID of the item to be focused. |
847 * @param aItem Item ID of the item to be focused. |
846 * |
848 * |
847 * @panic EAknHListPanicInvalidItemID Item with specified ID is not found. |
849 * @panic EAknHListPanicInvalidItemID Item with specified ID is not found. |
848 */ |
850 */ |
849 IMPORT_C void SetFocusedItem( TAknTreeItemID aItem ); |
851 IMPORT_C void SetFocusedItem( TAknTreeItemID aItem ); |
850 |
852 |
851 /** |
853 /** |
852 * Gets the index of the focused item on the screen. Possible values are |
854 * Gets the index of the focused item on the screen. Possible values are |
853 * from 0 to max. number of visible lines - 1. Value -1 is |
855 * from 0 to max. number of visible lines - 1. Value -1 is |
854 * returned if no item is focused or focused item is not visible. |
856 * returned if no item is focused or focused item is not visible. |
855 * |
857 * |
856 * @return index of the focused item on the screen. |
858 * @return index of the focused item on the screen. |
857 */ |
859 */ |
858 IMPORT_C TInt FocusedItemIndex() const; |
860 IMPORT_C TInt FocusedItemIndex() const; |
859 |
861 |
860 /** |
862 /** |
861 * Gets the index of the item on the screen. Possible values are |
863 * Gets the index of the item on the screen. Possible values are |
862 * from 0 to max. number of visible lines - 1. Value -1 is |
864 * from 0 to max. number of visible lines - 1. Value -1 is |
863 * returned if the requested item is not visible on the screen. |
865 * returned if the requested item is not visible on the screen. |
864 * |
866 * |
865 * @return index of the requested item. |
867 * @return index of the requested item. |
866 */ |
868 */ |
867 IMPORT_C TInt VisibleItemIndex( TAknTreeItemID aItem ) const; |
869 IMPORT_C TInt VisibleItemIndex( TAknTreeItemID aItem ) const; |
868 |
870 |
869 |
871 |
870 /** |
872 /** |
871 * Sets custom ordering for the hierarchical list and sorts the list |
873 * Sets custom ordering for the hierarchical list and sorts the list |
872 * with the use of given ordering interface. The given interface is |
874 * with the use of given ordering interface. The given interface is |
873 * used until it is replaced with some other ordering. |
875 * used until it is replaced with some other ordering. |
874 * |
876 * |
875 * @param aOrdering Custom ordering interface used in list sorting. |
877 * @param aOrdering Custom ordering interface used in list sorting. |
879 * @c EMoveFocusToFirstItem changes view to the beginning of the list |
881 * @c EMoveFocusToFirstItem changes view to the beginning of the list |
880 * and moves focus to the first item. |
882 * and moves focus to the first item. |
881 * |
883 * |
882 * @param aDrawNow @c ETrue to redraw the list after sorting. |
884 * @param aDrawNow @c ETrue to redraw the list after sorting. |
883 */ |
885 */ |
884 IMPORT_C void Sort( MAknCustomTreeOrdering* aOrdering, TFocusBehaviour aFocusBehaviour, TBool aDrawNow ); |
886 IMPORT_C void Sort( MAknCustomTreeOrdering* aOrdering, TFocusBehaviour aFocusBehaviour, TBool aDrawNow ); |
885 |
887 |
886 /** |
888 /** |
887 * Sorts the specified node with the use of previously set ordering |
889 * Sorts the specified node with the use of previously set ordering |
888 * interface. The sorting can be restricted to the specified node, or |
890 * interface. The sorting can be restricted to the specified node, or |
889 * the sorting can be set to include also every descendant node of the |
891 * the sorting can be set to include also every descendant node of the |
890 * specified node. Whole list can be sorted by giving the constant |
892 * specified node. Whole list can be sorted by giving the constant |
891 * @c KAknTreeIIDRoot as the @c aNode parameter. This method has no |
893 * @c KAknTreeIIDRoot as the @c aNode parameter. This method has no |
906 * |
908 * |
907 * @panic EAknHListPanicInvalidItemID Item with specified ID is not found. |
909 * @panic EAknHListPanicInvalidItemID Item with specified ID is not found. |
908 * |
910 * |
909 * @panic EAknHListPanicInvalidItemType Specified item is not a node. |
911 * @panic EAknHListPanicInvalidItemType Specified item is not a node. |
910 */ |
912 */ |
911 IMPORT_C void Sort( TAknTreeItemID aNode, TFocusBehaviour aFocusBehaviour, TBool aSortDescendants, TBool aDrawNow ); |
913 IMPORT_C void Sort( TAknTreeItemID aNode, TFocusBehaviour aFocusBehaviour, TBool aSortDescendants, TBool aDrawNow ); |
912 |
914 |
913 /** |
915 /** |
914 * Sets text for the empty list. This text is visible if the list box |
916 * Sets text for the empty list. This text is visible if the list box |
915 * has no items. |
917 * has no items. |
916 * |
918 * |
917 * @param aText The text for the empty list. |
919 * @param aText The text for the empty list. |
918 */ |
920 */ |
919 IMPORT_C void SetEmptyTextL(const TDesC& aText); |
921 IMPORT_C void SetEmptyTextL(const TDesC& aText); |
920 |
922 |
921 |
923 |
922 // From base class CCoeControl |
924 // From base class CCoeControl |
923 |
925 |
924 /** |
926 /** |