1.1 --- a/epoc32/include/mw/eiklbx.h Wed Mar 31 12:27:01 2010 +0100
1.2 +++ b/epoc32/include/mw/eiklbx.h Wed Mar 31 12:33:34 2010 +0100
1.3 @@ -2,9 +2,9 @@
1.4 * Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 * All rights reserved.
1.6 * This component and the accompanying materials are made available
1.7 -* 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.8 +* under the terms of "Eclipse Public License v1.0"
1.9 * which accompanies this distribution, and is available
1.10 -* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.11 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.12 *
1.13 * Initial Contributors:
1.14 * Nokia Corporation - initial contribution.
1.15 @@ -135,7 +135,7 @@
1.16 ENoExtendedSelection = SLafListBox::ENoExtendedSelection,
1.17
1.18 /**
1.19 - * Construction flag that sets the list box to match user’s keystrokes
1.20 + * Construction flag that sets the list box to match user?s keystrokes
1.21 * incrementally.
1.22 */
1.23 EIncrementalMatching = SLafListBox::EIncrementalMatching,
1.24 @@ -236,7 +236,12 @@
1.25 /**
1.26 * Construction flag for enabling S60 style markable items.
1.27 */
1.28 - ES60StyleMarkable = SLafListBox::ES60StyleMarkable
1.29 + ES60StyleMarkable = SLafListBox::ES60StyleMarkable,
1.30 +
1.31 + /**
1.32 + * Construction flag for disabling item specific stylus popup menu.
1.33 + */
1.34 + EDisableItemSpecificMenu = 0x00040000
1.35 };
1.36 enum {KEikMaxMatchingBufferLength = 2};
1.37
1.38 @@ -773,7 +778,7 @@
1.39 /**
1.40 * From @c CCoeControl
1.41 *
1.42 - * Handles a change to the list box’s resources of type @c aType which are
1.43 + * Handles a change to the list box?s resources of type @c aType which are
1.44 * shared across the environment, colours or fonts for example.
1.45 *
1.46 * @param aType The type of resources that have changed.
1.47 @@ -944,7 +949,7 @@
1.48
1.49 // functions needed for supporting scrollbars
1.50 /**
1.51 - * Updates the position of this list box’s scroll bars’ thumbs to reflect
1.52 + * Updates the position of this list box?s scroll bars? thumbs to reflect
1.53 * the horizontal and vertical position of the list view within the list.
1.54 */
1.55 IMPORT_C virtual void UpdateScrollBarThumbs() const;
1.56 @@ -1033,7 +1038,7 @@
1.57 IMPORT_C virtual void ConstructL(const CCoeControl* aParent, TInt aFlags = 0);
1.58
1.59 /**
1.60 - * Completes the list box view’s construction.
1.61 + * Completes the list box view?s construction.
1.62 *
1.63 * This function is called by @c ConstructL() to complete construction
1.64 * of the resource view, calling its @c ConstructL() with appropriate
1.65 @@ -1219,11 +1224,11 @@
1.66 * @c CListBoxView::DrawMatcherCursor() after scrolling to make the current
1.67 * item visible.
1.68 *
1.69 - * A list box control’s matcher cursor is an on-screen cursor which is
1.70 + * A list box control?s matcher cursor is an on-screen cursor which is
1.71 * drawn to indicate to the user the location of the current text. Whether
1.72 * the cursor is drawn is dependent on the
1.73 * @c CListBoxView::TFlags::EHasMatcherCursor flag, which may be set on the
1.74 - * list box’s view.
1.75 + * list box?s view.
1.76 *
1.77 * Note, that CListBoxView::DrawMatcherCursor() is not implemented in S60.
1.78 */
1.79 @@ -1260,7 +1265,7 @@
1.80
1.81 protected: // functions which deal with extension
1.82 /**
1.83 - * Sets the reason for the list box’s loss of focus.
1.84 + * Sets the reason for the list box?s loss of focus.
1.85 *
1.86 * This is required so the list box can determine whether
1.87 * loss of focus is due to an external control or an internal component.
1.88 @@ -1270,7 +1275,7 @@
1.89 IMPORT_C void SetReasonForFocusLostL( TReasonForFocusLost aReasonForFocusLost );
1.90
1.91 /**
1.92 - * Gets the reason for the list box’s loss of focus.
1.93 + * Gets the reason for the list box?s loss of focus.
1.94 *
1.95 * @return The reason for the loss of focus.
1.96 */
1.97 @@ -1431,6 +1436,15 @@
1.98 * @param aItems Number of items in one grid line.
1.99 */
1.100 IMPORT_C void SetItemsInSingleLine(TInt aItems);
1.101 +
1.102 + /**
1.103 + * Gets the number of list items in one line. This is more than one for
1.104 + * grids only.
1.105 + *
1.106 + * @since S60 5.2
1.107 + * @return The number of list items in one line.
1.108 + */
1.109 + IMPORT_C TInt ItemsInSingleLine() const;
1.110
1.111 /**
1.112 * Removes pointer event filtering for list items.
1.113 @@ -1485,6 +1499,26 @@
1.114 */
1.115 IMPORT_C void SuspendEffects( TBool aSuspend );
1.116
1.117 + /**
1.118 + * Disables the single click functionality in the list.
1.119 + * By default the feature is enabled.
1.120 + *
1.121 + * @since S60 5.2
1.122 + *
1.123 + * @param aDisabled @c ETrue to disable single click
1.124 + * @c EFalse does currently nothing
1.125 + */
1.126 + IMPORT_C void DisableSingleClick( TBool aDisabled );
1.127 +
1.128 + /**
1.129 + * Disables item specific menu from the list. This has the same effect as
1.130 + * construction time flag @c EAknListBoxItemSpecificMenuDisabled and
1.131 + * calling this method also turns that flag on.
1.132 + *
1.133 + * @since S60 5.2
1.134 + */
1.135 + IMPORT_C void DisableItemSpecificMenu();
1.136 +
1.137 private:
1.138 IMPORT_C virtual void CEikListBox_Reserved(); // listbox use only
1.139 void HorizontalScroll(TInt aScrollAmountInPixels);
1.140 @@ -1527,7 +1561,17 @@
1.141 * @since 5.0
1.142 */
1.143 void UpdateHighlightL( TInt aItemIndex );
1.144 -
1.145 +
1.146 +public:
1.147 + /**
1.148 + * Sets this control as visible or invisible.
1.149 + *
1.150 + * @param aVisible ETrue to make the control visible, EFalse to make
1.151 + * it invisible.
1.152 + * @since 5.2
1.153 + */
1.154 + IMPORT_C virtual void MakeVisible( TBool aVisible );
1.155 +
1.156 protected:
1.157 /** Flags for this list box */
1.158 TInt iListBoxFlags;
1.159 @@ -1583,7 +1627,7 @@
1.160 * This is a list box that scrolls horizontally, displaying its items
1.161 * in as many vertical columns as needed. Columns are arranged across
1.162 * the control from left to right; within columns, items are arranged
1.163 -* from top to bottom. The flow of items or text ‘snakes’ across the
1.164 +* from top to bottom. The flow of items or text ?snakes? across the
1.165 * face of the control.
1.166 *
1.167 * This is a flexible control class that makes good use of short, wide
1.168 @@ -1621,14 +1665,14 @@
1.169 IMPORT_C virtual CListBoxView* MakeViewClassInstanceL();
1.170
1.171 /**
1.172 - * Sets the top item’s index.
1.173 + * Sets the top item?s index.
1.174 *
1.175 * @param aItemIndex Index of the item to set as the top item.
1.176 */
1.177 IMPORT_C virtual void SetTopItemIndex(TInt aItemIndex) const;
1.178
1.179 /**
1.180 - * Gets the width of this list box’s columns.
1.181 + * Gets the width of this list box?s columns.
1.182 *
1.183 * @return Width of each column.
1.184 */
1.185 @@ -1783,7 +1827,7 @@
1.186 /**
1.187 * From @c CCoeControl.
1.188 *
1.189 - * Handles a change to the list box’s resources of type @c aType which are
1.190 + * Handles a change to the list box?s resources of type @c aType which are
1.191 * shared across the environment, colours or fonts for example.
1.192 *
1.193 * @param aType The type of resources that have changed.