epoc32/include/mw/eiklbv.h
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
equal deleted inserted replaced
3:e1b950c65cb4 4:837f303aceeb
     1 /*
     1 /*
     2 * Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 * Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
     3 * All rights reserved.
     3 * All rights reserved.
     4 * This component and the accompanying materials are made available
     4 * This component and the accompanying materials are made available
     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
     5 * under the terms of "Eclipse Public License v1.0"
     6 * which accompanies this distribution, and is available
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
     8 *
     8 *
     9 * Initial Contributors:
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    10 * Nokia Corporation - initial contribution.
    11 *
    11 *
    12 * Contributors:
    12 * Contributors:
   899      * For CEikListBox.
   899      * For CEikListBox.
   900      * @param aItemIndex New item index.
   900      * @param aItemIndex New item index.
   901      */
   901      */
   902     void SetItemIndex( TInt aItemIndex );
   902     void SetItemIndex( TInt aItemIndex );
   903  
   903  
   904     /**
       
   905      * Tests whether an item is visible. This method get bottom item index 
       
   906      * from parameter
       
   907      *
       
   908      * @param aItemIndex Index of item to be tested.
       
   909      * @param aBottomItemIndex Index of item in the bottom of view.
       
   910      * @return @c ETrue if the item is visible.
       
   911      */
       
   912     TBool ItemIsVisible(TInt aItemIndex, TInt aBottomItemIndex) const;
       
   913 
       
   914     /**
       
   915      * Selects an item by index. 
       
   916      *
       
   917      * This function leaves if memory could not be allocated for an extra item
       
   918      * in the array of selected items.
       
   919      *
       
   920      * @param aItemIndex Item to select.
       
   921      * @param aBottomItemIndex Index of item in the bottom of view.
       
   922      * @panic EEikPanicListBoxNoSelIndexArray Panics if selection indexes have 
       
   923      *        not been defined for this class. 
       
   924      */
       
   925     void SelectItemL(TInt aItemIndex, TInt aBottomItemIndex);
       
   926 
       
   927     /**
       
   928      * Deselects an item by index.
       
   929      *
       
   930      * @param aItemIndex Item to deselect.
       
   931      * @param aBottomItemIndex Index of item in the bottom of view.
       
   932      * @panic EEikPanicListBoxNoSelIndexArray Panics if selection indexes have 
       
   933      *        not been defined for this class. 
       
   934      */
       
   935     void DeselectItem(TInt aItemIndex, TInt aBottomItemIndex);
       
   936 
       
   937     /**
       
   938      * Draws the specified item via @c CListBoxDrawer::DrawItem() if it is 
       
   939      * visible.
       
   940      *
       
   941      * @param aItemIndex Index number of the item to draw.
       
   942      * @param aBottomItemIndex Index of item in the bottom of view.
       
   943      */
       
   944     void DrawItem(TInt aItemIndex, TInt aBottomItemIndex) const;
       
   945     
       
   946     /**
       
   947      * Updates item selection.
       
   948      *
       
   949      * @param aSelectionMode The selection mode. 
       
   950      * @param aBottomItemIndex Index of item in the bottom of view.
       
   951      */
       
   952     void UpdateSelectionL(TSelectionMode aSelectionMode, TInt aBottomItemIndex);
       
   953 
       
   954 protected:
   904 protected:
   955 
   905 
   956     /**
   906     /**
   957      * The flags for this list box. These flags are defined by the nested enum
   907      * The flags for this list box. These flags are defined by the nested enum
   958      * @c TFlags (below).
   908      * @c TFlags (below).