API_REF/Public_API: comparison epoc32/include/mw/eiklbx.h

equal deleted inserted replaced

-:e1b950c65cb4
+:837f303aceeb
 /*
 * Copyright (c) 1997-2009 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
+* under the terms of "Eclipse Public License v1.0"
 * which accompanies this distribution, and is available
-* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
 *
 * Initial Contributors:
 * Nokia Corporation - initial contribution.
 *
 * Contributors:
 * using @c SHIFT button.
 */
 ENoExtendedSelection        = SLafListBox::ENoExtendedSelection,
 /**
-* Construction flag that sets the list box to match user’s keystrokes
+* Construction flag that sets the list box to match user?s keystrokes
 * incrementally.
 */
 EIncrementalMatching        = SLafListBox::EIncrementalMatching,
 /**
 ES60StyleMultiselection     = SLafListBox::ES60StyleMultiselection,
 /**
 * Construction flag for enabling S60 style markable items.
 */
-ES60StyleMarkable           = SLafListBox::ES60StyleMarkable
+ES60StyleMarkable           = SLafListBox::ES60StyleMarkable,
+/**
+* Construction flag for disabling item specific stylus popup menu.
+*/
+EDisableItemSpecificMenu    = 0x00040000
 };
 enum {KEikMaxMatchingBufferLength = 2};
 /**
 * Indicates who owns the scroll bar.
 // not available before Release 005u
 /**
 * From @c CCoeControl
 *
-* Handles a change to the list box’s resources of type @c aType which are
+* Handles a change to the list box?s resources of type @c aType which are
 * shared across the environment, colours or fonts for example.
 *
 * @param aType The type of resources that have changed.
 */
 IMPORT_C virtual void HandleResourceChange(TInt aType);
 */
 IMPORT_C TBool LastCharMatched() const;
 // functions needed for supporting scrollbars
 /**
-* Updates the position of this list box’s scroll bars’ thumbs to reflect
+* Updates the position of this list box?s scroll bars? thumbs to reflect
 * the horizontal and vertical position of the list view within the list.
 */
 IMPORT_C virtual void UpdateScrollBarThumbs() const;
 /**
 * @param aFlags Construction flags.
 */
 IMPORT_C virtual void ConstructL(const CCoeControl* aParent, TInt aFlags = 0);
 /**
-* Completes the list box view’s construction.
+* Completes the list box view?s construction.
 *
 * This function is called by @c ConstructL() to complete construction
 * of the resource view, calling its @c ConstructL() with appropriate
 * arguments and assigning it to @c iView. Also prepares the view for use.
 */
 * If there is no match buffer, this function returns immediately;
 * otherwise the cursor is drawn on the current item using
 * @c CListBoxView::DrawMatcherCursor() after scrolling to make the current
 * item visible.
 *
-* A list box control’s matcher cursor is an on-screen cursor which is
+* A list box control?s matcher cursor is an on-screen cursor which is
 * drawn to indicate to the user the location of the current text. Whether
 * the cursor is drawn is dependent on the
 * @c CListBoxView::TFlags::EHasMatcherCursor flag, which may be set on the
-* list box’s view.
+* list box?s view.
 *
 * Note, that CListBoxView::DrawMatcherCursor() is not implemented in S60.
 */
 IMPORT_C void DrawMatcherCursor() const;
 IMPORT_C void FireItemChange();
 protected:	// functions which deal with extension
 /**
-* Sets the reason for the list box’s loss of focus.
+* Sets the reason for the list box?s loss of focus.
 *
 * This is required so the list box can determine whether
 * loss of focus is due to an external control or an internal component.
 *
 * @param aReasonForFocusLost The reason for the loss of focus.
 */
 IMPORT_C void SetReasonForFocusLostL( TReasonForFocusLost aReasonForFocusLost );
 /**
-* Gets the reason for the list box’s loss of focus.
+* Gets the reason for the list box?s loss of focus.
 *
 * @return The reason for the loss of focus.
 */
 IMPORT_C TReasonForFocusLost ReasonForFocusLostL();
 	*
 	* @since S60 5.0
 	* @param aItems Number of items in one grid line.
 	*/
 IMPORT_C void SetItemsInSingleLine(TInt aItems);
+/**
+* Gets the number of list items in one line. This is more than one for
+* grids only.
+	*
+	* @since S60 5.2
+	* @return The number of list items in one line.
+	*/
+IMPORT_C TInt ItemsInSingleLine() const;
 /**
 * Removes pointer event filtering for list items.
 *
 * When there are two pointer up events on the same item at short interval,
 *
 * @param aSuspend ETrue to suspend effects, EFalse to re-enable them.
 */
 IMPORT_C void SuspendEffects( TBool aSuspend );
+/**
+* Disables the single click functionality in the list.
+* By default the feature is enabled.
+*
+* @since S60 5.2
+*
+* @param  aDisabled @c ETrue to disable single click
+*                   @c EFalse does currently nothing
+*/
+IMPORT_C void DisableSingleClick( TBool aDisabled );
+/**
+* Disables item specific menu from the list. This has the same effect as
+* construction time flag @c EAknListBoxItemSpecificMenuDisabled and
+* calling this method also turns that flag on.
+*
+* @since S60 5.2
+*/
+IMPORT_C void DisableItemSpecificMenu();
 private:
 IMPORT_C virtual void CEikListBox_Reserved(); // listbox use only
 void HorizontalScroll(TInt aScrollAmountInPixels);
 void DrawItemInView(TInt aItemIndex) const;
 void ClearMargins(CWindowGc& aGc) const;
 *
 * @internal
 * @since 5.0
 */
 void UpdateHighlightL( TInt aItemIndex );
+public:
+/**
+* Sets this control as visible or invisible.
+*
+* @param aVisible ETrue to make the control visible, EFalse to make
+*                 it invisible.
+* @since 5.2
+*/
+IMPORT_C virtual void MakeVisible( TBool aVisible );
 protected:
 /** Flags for this list box  */
 TInt iListBoxFlags;
 /** This List box's view  */
 /**
 * This is a list box that scrolls horizontally, displaying its items
 * in as many vertical columns as needed. Columns are arranged across
 * the control from left to right; within columns, items are arranged
-* from top to bottom. The flow of items or text ‘snakes’ across the
+* from top to bottom. The flow of items or text ?snakes? across the
 * face of the control.
 *
 * This is a flexible control class that makes good use of short, wide
 * display areas; for instance, subclasses of @c CEikSnakingListBox could
 * be used for file lists or for a control panel. A standard user
 * @return The view which will be used by the list box being created
 */
 IMPORT_C virtual CListBoxView* MakeViewClassInstanceL();
 /**
-* Sets the top item’s index.
+* Sets the top item?s index.
 *
 * @param aItemIndex Index of the item to set as the top item.
 */
 IMPORT_C virtual void SetTopItemIndex(TInt aItemIndex) const;
 /**
-* Gets the width of this list box’s columns.
+* Gets the width of this list box?s columns.
 *
 * @return Width of each column.
 */
 IMPORT_C TInt ColumnWidth() const;
 CArrayFix<TCoeColorUse>& aColorUseList) const;
 // not available before Release 005u
 /**
 * From @c CCoeControl.
 *
-* Handles a change to the list box’s resources of type @c aType which are
+* Handles a change to the list box?s resources of type @c aType which are
 * shared across the environment, colours or fonts for example.
 *
 * @param aType The type of resources that have changed.
 */
 IMPORT_C virtual void HandleResourceChange(TInt aType);

branch	Symbian3
changeset 4	837f303aceeb
parent 2	2fe1408b6811