ListView

Since: BlackBerry 10.0.0

#include <bb/cascades/ListView>

A scrollable container used to display a list of items.

A list of names sorted by the first letter

The implementation of a ListView follows an MVC (model-view-controller) architecture, with the ListView representing the controller. It accepts input from the user (such as item selections or scrolling) and instructs the model and view to perform actions based on that input. The model for a ListView is provided by the DataModel, and is a requirement for every ListView. The view for a ListView can be handled a few different ways, and the implementation is different whether you're using C++ or QML. If you're using C++, the visuals are managed by ListItemProvider. If you're using QML, you'll likely use ListItemComponent (though it's also possible to use ListItemProvider).

A ListView must have a DataModel connected to it in order to show any list items. The DataModel is used to provide data for each item, which can be displayed in the view. The DataModel can contain items in a tree structure many levels deep, but ListView only shows items from the first two levels below the root element (see rootIndexPath).

A DataModel can come in a number of different forms, including XmlDataModel (data from an XML file), QListDataModel (a DataModel template that is very similar to a QList), and GroupDataModel (can contain QVariantMap objects and/or QObject pointers).

ListView takes ownership of any QObject object returned (wrapped in QVariant) by DataModel::data(), if the returned object doesn't already have a parent, and if the user type of the QVariant is QMetaType::QObjectStar. Custom QVariant types are ignored, even if the type in question inherits QObject. QObject objects owned by ListView are deleted when the item they belong to is scrolled out of the visible area, or when the ListView itself is deleted.

Creating a list

Here's how to create a simple list from an XmlDataModel. The XML source would be located in a file called model.xml. The root index path is changed to [1] so that only the European cities are displayed in the list, with no header item.

 Page {
     content: Container {
         background: Color.White
         ListView {
             rootIndexPath: [1]
             dataModel: XmlDataModel { source: "model.xml" }
         }
     }
 }

 <model>
   <header title="North America">
     <item title="Toronto" />
     <item title="New York" />
   </header>
   <header title="Europe">
     <item title="Copenhagen" />
     <item title="Malmo" />
   </header>
 </model>

List visuals in QML

A diagram demonstrating how list items are created in QML

In QML, it's possible to define list item visuals in two ways: using ListItemProvider or ListItemComponent. Because of the declarative nature of QML, using ListItemComponent is the preferred method.

A ListItemComponent is a QML template that's used by the ListView to present data from the model. A ListItemComponent can be attached to a ListView using the ListView::listItemComponents property, and it can contain whatever visual controls that you want to display in your list item.

If item visuals are created from a ListItemComponent, ListView makes the following properties available on the root element of the item visual:

ListItem.initialized - States whether the item visual is initialized or not. true when initialization of the item visual is finished (all properties have been updated to reflect the current item), false when the item visuals become disconnected due to recycling. Explicit animations etc must not be started when the value of initialized is false.

ListItem.data - The QVariant returned by DataModel::data() for this item. Typically a QVariantMap or QObject* which means that data has properties of its own (e.g. ListItem.data.firstName), but could also be just a QString if that's the kind of QVariant the currently connected DataModel returns.

ListItem.indexInSection - The index for this item amongst its siblings. The siblings are those items that have the same parent as this item.

ListItem.indexPath - The index path identifying this item in its DataModel.

ListItem.sectionSize - The number of child items that the parent item of this item has.

ListItem.view - The ListView in which this item is visible. The item is in a context separate from the ListView, so any symbols from the ListView context that are to be accessible from items must be placed as dynamic properties on the ListView.

ListItem.component - The ListItemComponent that this item visual has been created from. The item visuals are in a context of their own, so any symbols from the ListItemComponent context that are to be accessible from item visuals must be placed as dynamic properties on the ListItemComponent.

ListItem.active - true if this item is active, false otherwise. An item is typically active if the user is holding a finger on it.

ListItem.selected - true if this item is selected, false otherwise. An item is typically selected if the user intends to access details for the item, or to perform an action on the item.

The ListItem.* symbols listed above only have values on the root element in the item visuals, so they must be prefixed by the id of the root element if used on any element further down in the tree. For convenience, ListView therefore also makes the symbol ListItemData available as an alias for ListItem.data. In contrast to ListItem.data, ListItemData is available in the entire context of the item visual, so no prefix is needed.

Here's how to create a list in QML, with a contact list item:

 ListView {
     dataModel: XmlDataModel { source: "model.xml" }
     listItemComponents: [
         ListItemComponent {
             type: "contact"

             Container {
                 id: itemRoot

                 ImageView {
                     image: ListItemData.imagePath
                     opacity: itemRoot.ListItem.selected ? 1.0 : 0.5
                 }

                 Label { text: ListItemData.name }
             }
         }
     ]
 }

Note:

A ListItemComponent has a different scope than the rest of a QML document. If you create a list in QML and need to access variables placed in the ListView in a ListItemComponent, you can access the variables using the ListItem.view property. If you need to access a property that is outside the scope of the ListView, you need to alias the property in the ListView before you can access it.

Here's how to create a list in QML and access a variable inside the ListView:

 ListView {
     property string myText: "Example text"
     dataModel: XmlDataModel {
         source: "model.xml"
     }
     listItemComponents: [
         ListItemComponent {
             type: "listItem"
             CustomListItem {
                 id: itemRoot
                 dividerVisible: true
                 highlightAppearance: HighlightAppearance.Frame
                 Container {
                     Label {
                         text: ListItemData.title + " " + itemRoot.ListItem.view.myText
                     }
                 }
             }
         }
     ]
 }

List visuals in C++

A diagram demonstrating how list items are created in C++

A ListItemProvider can be assigned to the ListView in order to provide VisualNode objects to be shown as items in the ListView. ListItemProvider::updateItem() is then called whenever an item visual should be updated with data for a specific item.

The VisualNode objects are recycled when scrolling in a ListView. Those scrolled out of the visible area are kept in an internal cache by ListView, in order to be connected to new data and used again when another item of the same type scrolls into the visible area. Therefore, it is not possible to store any states in the VisualNode objects, as all item specific data must be stored in the DataModel.

If the VisualNode objects implement the ListItemListener interface, ListView calls ListItemListener::reset() on them right before they are shown. ListView also calls ListItemListener::select() and ListItemListener::activate() whenever those visualization states should change for an already visible item.

The default list visuals

If no ListItemProvider is assigned and no ListItemComponent of a matching type can be found, the default behavior for ListView is to use Header for items of the type "header" and StandardListItem for all other types of items. This approach works great if you want just a standard list without any major visual customizations. Header and StandardListItem contain a standard set of visuals, including titles, descriptions, and images.

In this scenario the ListView tries to assign the data returned from DataModel::data() to Header::title or StandardListItem::title.

Here's a C++ example of a very simple ListView showing three StandardListItem items with "Hey", "Hello" and "Bye" as title texts:

 ListView *pListView = new ListView();
 pListView->setDataModel(new QListDataModel<QString>
        (QList<QString>() << "Hey" << "Hello" << "Bye"));

ListView calls DataModel::itemType() for each item in order to know its type. In QML this can be overridden by declaring the function itemType(data, indexPath) on the ListView element. The ListView then calls that function instead of the DataModel function.

Here's how to create a list in QML that creates a Header for all items on the top level, and a StandardListItem for each item below the top level:

 ListView {
     dataModel: XmlDataModel { source: "model.xml" }

     function itemType(data, indexPath) {
         return (indexPath.length == 1 ? 'header' : 'item');
     }
 }

If no itemType() function has been declared in QML, DataModel::itemType() can instead be overridden by assigning a ListItemTypeMapper in C++ by calling setListItemTypeMapper(). The ListView then calls ListItemTypeMapper::itemType() instead of the DataModel function.

Index paths

Index paths are used for identifying items in ListView, DataModel and all related classes. In C++, an index path is a QVariantList object containing a number of QVariant integers, one for each ancestor (including the root item) of the specified item. The reason for index paths being QVariantList objects in C++ is that QVariantList objects are the C++ equivalent of QML JavaScript arrays.

In QML, an index path is simply an array containing integers. For an item that is a direct child of the root item, the index path contains a single integer. A child of that item would instead have an index path consisting of two integers, etc.

Examples of index paths:

[3] - index path for the fourth child of the root item
[3,0] - index path for the first child of the fourth child of the root item

Example of accessing indexes from index paths in C++:

indexPath[0].toInt() - gets the top level index from this index path
indexPath[1].toInt() - gets the second level index from this index path (if the index path contains that many levels)

In the graphic below, the index path for 'A' would be [0] while the index for Astaroff Krytinisz would be [0,3], if the rootIndexPath is [] (an empty index path, i.e. the root of the DataModel).

A list showing two levels in the hierarchy

See index paths for more information.

Multi selection

By default, selection is handled by the multiSelectHandler. Within the multiSelectHandler, you can define a set of actions that are invoked when multi selection occurs. These actions are used to populate the context menu that's displayed when you long-press on a control (in this case, the list item). For example, in an application that displays a list of images, the user might want to be able to select multiple pictures and delete them. In this case, you could use the multiSelectHandler to populate the context menu with the number of pictures that are being selected for deletion

Sizing

The size of the ListView behaves as follows:

By default, the width and height are adjusted automatically to fill its parent container.
The width is adjustable using the Control::preferredWidth, Control::minWidth and Control::maxWidth properties.
The height is adjustable using the Control::preferredHeight, Control::minHeight and Control::maxHeight and properties.

ListView contains padding properties. Padding is applied to each side of the ListLayout used by the ListView, to create space between the list and any surrounding components. These padding properties can also support negative padding values.

Overview

Inheritance

bb::cascades::BaseObject
	bb::cascades::UIObject
		bb::cascades::VisualNode
			bb::cascades::Control
				bb::cascades::ListView

QML properties

bufferedScrollingEnabled	: bool
dataModel	: bb::cascades::DataModel
flickMode	: bb::cascades::FlickMode::Type
layout	: bb::cascades::ListLayout
leadingVisual	: bb::cascades::VisualNode
leadingVisualSnapThreshold	: float
listItemProvider	: bb::cascades::ListItemProvider
multiSelectAction	: bb::cascades::MultiSelectActionItem
multiSelectHandler	: bb::cascades::MultiSelectHandler [read-only]
rearrangeHandler	: bb::cascades::RearrangeHandler [read-only]
rootIndexPath	: QVariantList
scrollIndicatorMode	: bb::cascades::ScrollIndicatorMode::Type
scrollRole	: bb::cascades::ScrollRole::Type
snapMode	: bb::cascades::SnapMode::Type
stickToEdgePolicy	: bb::cascades::ListViewStickToEdgePolicy::Type
accessibility	: bb::cascades::AbstractA11yObject [read-only]
accessibilityMode	: bb::cascades::A11yMode::Type
attachedObjects	: QDeclarativeListProperty< QObject > [read-only]
keyListeners	: QDeclarativeListProperty [read-only]
bottomMargin	: float
bottomMarginSet	: bool [read-only]
bottomPadding	: float
builtInShortcutsEnabled	: bool
contextMenuHandler	: bb::cascades::ContextMenuHandler
enabled	: bool
focusAutoShow	: bb::cascades::FocusAutoShow::Type
focused	: bool [read-only]
focusPolicy	: bb::cascades::FocusPolicy::Type
focusRetentionPolicyFlags	: bb::cascades::FocusRetentionPolicy::Types
horizontalAlignment	: bb::cascades::HorizontalAlignment::Type
implicitLayoutAnimationsEnabled	: bool
inputRoute	: bb::cascades::InputRouteProperties [read-only]
layoutProperties	: bb::cascades::LayoutProperties
leftMargin	: float
leftMarginSet	: bool [read-only]
leftPadding	: float
locallyFocused	: bool
margin	: bb::cascades::Spacings [read-only]
maxHeight	: float
maxWidth	: float
minHeight	: float
minWidth	: float
navigation	: bb::cascades::Navigation [read-only]
objectName	: QString
opacity	: float
overlapTouchPolicy	: bb::cascades::OverlapTouchPolicy::Type
parent	: QObject [read-only]
pivotX	: float
pivotY	: float
preferredHeight	: float
preferredHeightSet	: bool [read-only]
preferredWidth	: float
preferredWidthSet	: bool [read-only]
rightMargin	: float
rightMarginSet	: bool [read-only]
rightPadding	: float
rotationZ	: float
scaleX	: float
scaleY	: float
topMargin	: float
topMarginSet	: bool [read-only]
topPadding	: float
touchPropagationMode	: bb::cascades::TouchPropagationMode::Type
translationX	: float
translationY	: float
ui	: bb::cascades::UIConfig [read-only]
verticalAlignment	: bb::cascades::VerticalAlignment::Type
visible	: bool

QML signals

onActivationChanged	: {}
onBufferedScrollingEnabledChanged	: {}
onDataModelChanged	: {}
onFlickModeChanged	: {}
onLayoutChanged	: {}
onLeadingVisualChanged	: {}
onLeadingVisualSnapThresholdChanged	: {}
onListItemProviderChanged	: {}
onMultiSelectActionChanged	: {}
onRootIndexPathChanged	: {}
onScrollIndicatorModeChanged	: {}
onScrollRoleChanged	: {}
onSelectionChanged	: {}
onSelectionChangeEnded	: {}
onSelectionChangeStarted	: {}
onSnapModeChanged	: {}
onStickToEdgePolicyChanged	: {}
onTriggered	: {}
onAccessibilityModeChanged	: {}
onActionSetAdded	: {}
onActionSetRemoved	: {}
onBottomMarginChanged	: {}
onBottomMarginSetChanged	: {}
onBottomPaddingChanged	: {}
onBuiltInShortcutsEnabledChanged	: {}
onContextMenuHandlerChanged	: {}
onCreationCompleted	: {}
onEnabledChanged	: {}
onFocusAutoShowChanged	: {}
onFocusedChanged	: {}
onFocusPolicyChanged	: {}
onFocusRetentionPolicyFlagsChanged	: {}
onHorizontalAlignmentChanged	: {}
onImplicitLayoutAnimationsEnabledChanged	: {}
onLayoutPropertiesChanged	: {}
onLeftMarginChanged	: {}
onLeftMarginSetChanged	: {}
onLeftPaddingChanged	: {}
onLocallyFocusedChanged	: {}
onMaxHeightChanged	: {}
onMaxWidthChanged	: {}
onMinHeightChanged	: {}
onMinWidthChanged	: {}
onObjectNameChanged	: {}
onOpacityChanged	: {}
onOpacityChanging	: {}
onOverlapTouchPolicyChanged	: {}
onPivotXChanged	: {}
onPivotYChanged	: {}
onPreferredHeightChanged	: {}
onPreferredHeightSetChanged	: {}
onPreferredWidthChanged	: {}
onPreferredWidthSetChanged	: {}
onRightMarginChanged	: {}
onRightMarginSetChanged	: {}
onRightPaddingChanged	: {}
onRotationZChanged	: {}
onRotationZChanging	: {}
onScaleXChanged	: {}
onScaleXChanging	: {}
onScaleYChanged	: {}
onScaleYChanging	: {}
onTopMarginChanged	: {}
onTopMarginSetChanged	: {}
onTopPaddingChanged	: {}
onTouch	: {}
onTouchCapture	: {}
onTouchEnter	: {}
onTouchExit	: {}
onTouchPropagationModeChanged	: {}
onTranslationXChanged	: {}
onTranslationXChanging	: {}
onTranslationYChanged	: {}
onTranslationYChanging	: {}
onVerticalAlignmentChanged	: {}
onVisibleChanged	: {}

Properties Index

bool	bufferedScrollingEnabled
bb::cascades::DataModel	dataModel
bb::cascades::FlickMode::Type	flickMode
bb::cascades::ListLayout	layout
bb::cascades::VisualNode	leadingVisual
float	leadingVisualSnapThreshold
bb::cascades::ListItemProvider	listItemProvider
bb::cascades::MultiSelectActionItem	multiSelectAction
bb::cascades::MultiSelectHandler	multiSelectHandler [read-only]
bb::cascades::RearrangeHandler	rearrangeHandler [read-only]
QVariantList	rootIndexPath
bb::cascades::ScrollIndicatorMode::Type	scrollIndicatorMode
bb::cascades::ScrollRole::Type	scrollRole
bb::cascades::SnapMode::Type	snapMode
bb::cascades::ListViewStickToEdgePolicy::Type	stickToEdgePolicy
bb::cascades::AbstractA11yObject	accessibility [read-only]
bb::cascades::A11yMode::Type	accessibilityMode
QDeclarativeListProperty< QObject >	attachedObjects [read-only]
QDeclarativeListProperty	keyListeners [read-only]
float	bottomMargin
bool	bottomMarginSet [read-only]
float	bottomPadding
bool	builtInShortcutsEnabled
bb::cascades::ContextMenuHandler	contextMenuHandler
bool	enabled
bb::cascades::FocusAutoShow::Type	focusAutoShow
bool	focused [read-only]
bb::cascades::FocusPolicy::Type	focusPolicy
bb::cascades::FocusRetentionPolicy::Types	focusRetentionPolicyFlags
bb::cascades::HorizontalAlignment::Type	horizontalAlignment
bool	implicitLayoutAnimationsEnabled
bb::cascades::InputRouteProperties	inputRoute [read-only]
bb::cascades::LayoutProperties	layoutProperties
float	leftMargin
bool	leftMarginSet [read-only]
float	leftPadding
bool	locallyFocused
bb::cascades::Spacings	margin [read-only]
float	maxHeight
float	maxWidth
float	minHeight
float	minWidth
bb::cascades::Navigation	navigation [read-only]
QString	objectName
float	opacity
bb::cascades::OverlapTouchPolicy::Type	overlapTouchPolicy
QObject	parent [read-only]
float	pivotX
float	pivotY
float	preferredHeight
bool	preferredHeightSet [read-only]
float	preferredWidth
bool	preferredWidthSet [read-only]
float	rightMargin
bool	rightMarginSet [read-only]
float	rightPadding
float	rotationZ
float	scaleX
float	scaleY
float	topMargin
bool	topMarginSet [read-only]
float	topPadding
bb::cascades::TouchPropagationMode::Type	touchPropagationMode
float	translationX
float	translationY
bb::cascades::UIConfig	ui [read-only]
bb::cascades::VerticalAlignment::Type	verticalAlignment
bool	visible

Public Static Attributes Index

const QVariantList

AllItems

Public Functions Index

	ListView (Container *parent=0)
	ListView (bb::cascades::DataModel dataModel, Container parent=0)
virtual	~ListView ()
Q_SLOT void	clearSelection ()
DataModel *	dataModel () const
bb::cascades::FlickMode::Type	flickMode () const
bool	isBufferedScrollingEnabled () const
Q_INVOKABLE bool	isSelected (const QVariantList &indexPath) const
bb::cascades::ListLayout *	layout () const
bb::cascades::VisualNode *	leadingVisual () const
float	leadingVisualSnapThreshold () const
ListItemProvider *	listItemProvider () const
ListItemTypeMapper *	listItemTypeMapper () const
bb::cascades::MultiSelectActionItem *	multiSelectAction () const
bb::cascades::MultiSelectHandler *	multiSelectHandler () const
Q_SLOT RearrangeHandler *	rearrangeHandler ()
Q_SLOT void	resetBufferedScrollingEnabled ()
Q_SLOT void	resetDataModel ()
Q_SLOT void	resetFlickMode ()
Q_SLOT void	resetLayout ()
Q_SLOT void	resetLeadingVisual ()
Q_SLOT void	resetLeadingVisualSnapThreshold ()
Q_SLOT void	resetListItemProvider ()
Q_SLOT void	resetListItemTypeMapper ()
Q_SLOT void	resetMultiSelectAction ()
Q_SLOT void	resetRootIndexPath ()
Q_SLOT void	resetScrollIndicatorMode ()
Q_SLOT void	resetScrollRole ()
Q_SLOT void	resetSnapMode ()
Q_SLOT void	resetStickToEdgePolicy ()
QVariantList	rootIndexPath () const
Q_SLOT void	scroll (float offset, bb::cascades::ScrollAnimation::Type scrollAnimation=bb::cascades::ScrollAnimation::Default)
bb::cascades::ScrollIndicatorMode::Type	scrollIndicatorMode () const
bb::cascades::ScrollRole::Type	scrollRole () const
Q_INVOKABLE QVariantList	scrollStops () const
Q_SLOT void	scrollToItem (const QVariantList &indexPath, bb::cascades::ScrollAnimation::Type scrollAnimation=bb::cascades::ScrollAnimation::Default)
Q_SLOT void	scrollToPosition (bb::cascades::ScrollPosition::Type position, bb::cascades::ScrollAnimation::Type scrollAnimation=bb::cascades::ScrollAnimation::Default)
Q_SLOT void	select (const QVariantList &indexPath, bool select=true)
Q_SLOT void	selectAll ()
Q_INVOKABLE QVariantList	selected () const
Q_INVOKABLE QVariantList	selectionList () const
Q_SLOT void	setBufferedScrollingEnabled (bool bufferedScrollingEnabled)
Q_SLOT void	setDataModel (bb::cascades::DataModel *pDataModel)
Q_SLOT void	setFlickMode (bb::cascades::FlickMode::Type mode)
Q_SLOT void	setLayout (bb::cascades::ListLayout *layout)
Q_SLOT void	setLeadingVisual (bb::cascades::VisualNode *pLeadingVisual)
Q_SLOT void	setLeadingVisualSnapThreshold (float leadingVisualSnapThreshold)
Q_SLOT void	setListItemProvider (bb::cascades::ListItemProvider *pItemProvider)
void	setListItemTypeMapper (ListItemTypeMapper *pItemTypeMapper)
Q_SLOT void	setMultiSelectAction (bb::cascades::MultiSelectActionItem *multiSelectAction)
Q_SLOT void	setRootIndexPath (const QVariantList &rootIndexPath)
Q_SLOT void	setScrollIndicatorMode (bb::cascades::ScrollIndicatorMode::Type mode)
Q_SLOT void	setScrollRole (bb::cascades::ScrollRole::Type scrollRole)
Q_INVOKABLE void	setScrollStops (const QVariantList &indexPaths)
Q_SLOT void	setSnapMode (bb::cascades::SnapMode::Type mode)
Q_SLOT void	setStickToEdgePolicy (bb::cascades::ListViewStickToEdgePolicy::Type policy)
bb::cascades::SnapMode::Type	snapMode () const
bb::cascades::ListViewStickToEdgePolicy::Type	stickToEdgePolicy () const
Q_SLOT void	toggleSelection (const QVariantList &indexPath)
bb::cascades::AbstractA11yObject *	accessibility () const
bb::cascades::A11yMode::Type	accessibilityMode () const
ActionSet *	actionSetAt (int index) const
int	actionSetCount () const
void	addActionSet (bb::cascades::ActionSet *actionSet)
void	addAnimation (AbstractAnimation *animation)
Q_INVOKABLE void	addEffect (bb::cascades::AbstractEffect *effect)
void	addEventHandler (AbstractEventHandler *eventHandler)
void	addGestureHandler (GestureHandler *gestureHandler)
Q_INVOKABLE void	addKeyListener (bb::cascades::KeyListener *keyListener)
Q_INVOKABLE void	addShortcut (bb::cascades::AbstractShortcut *shortcut)
void	addTouchBehavior (TouchBehavior *touchBehavior)
AbstractAnimation *	animationAt (int index) const
int	animationCount () const
float	bottomMargin () const
float	bottomPadding () const
Q_INVOKABLE bool	builtInShortcutsEnabled () const
bb::cascades::ContextMenuHandler *	contextMenuHandler () const
Q_INVOKABLE void	disableAllShortcuts ()
Q_INVOKABLE void	enableAllShortcuts ()
virtual bool	event (QEvent *event)
bb::cascades::FocusAutoShow::Type	focusAutoShow () const
bb::cascades::FocusPolicy::Type	focusPolicy () const
bb::cascades::FocusRetentionPolicy::Types	focusRetentionPolicyFlags ()
bb::cascades::HorizontalAlignment::Type	horizontalAlignment () const
bool	implicitLayoutAnimationsEnabled () const
bb::cascades::InputRouteProperties *	inputRoute () const
bool	isBottomMarginSet () const
bool	isEnabled () const
bool	isFocused () const
bool	isLeftMarginSet () const
bool	isLocallyFocused () const
bool	isPreferredHeightSet () const
bool	isPreferredWidthSet () const
bool	isRightMarginSet () const
bool	isTopMarginSet () const
bool	isVisible () const
Q_INVOKABLE bb::cascades::KeyListener *	keyListenerAt (int index) const
Q_INVOKABLE int	keyListenerCount () const
bb::cascades::LayoutProperties *	layoutProperties () const
float	leftMargin () const
float	leftPadding () const
Q_SLOT void	loseFocus ()
bb::cascades::Spacings *	margin ()
float	maxHeight () const
float	maxWidth () const
float	minHeight () const
float	minWidth () const
bb::cascades::Navigation *	navigation () const
float	opacity () const
bb::cascades::OverlapTouchPolicy::Type	overlapTouchPolicy () const
float	pivotX () const
float	pivotY () const
float	preferredHeight () const
float	preferredWidth () const
bool	removeActionSet (bb::cascades::ActionSet *actionSet)
void	removeAllActionSets ()
void	removeAllAnimations ()
void	removeAllEventHandlers ()
void	removeAllGestureHandlers ()
Q_INVOKABLE void	removeAllKeyListeners ()
Q_INVOKABLE void	removeAllShortcuts ()
void	removeAllTouchBehaviors ()
bool	removeAnimation (AbstractAnimation *animation)
Q_INVOKABLE void	removeEffect (bb::cascades::AbstractEffect *effect)
bool	removeEventHandler (AbstractEventHandler *eventHandler)
bool	removeGestureHandler (GestureHandler *gestureHandler)
Q_INVOKABLE bool	removeKeyListener (bb::cascades::KeyListener *keyListener)
Q_INVOKABLE bool	removeShortcut (bb::cascades::AbstractShortcut *shortcut)
bool	removeTouchBehavior (TouchBehavior *touchBehavior)
Q_SLOT void	requestFocus ()
Q_SLOT void	resetAccessibilityMode ()
Q_SLOT void	resetBottomMargin ()
Q_SLOT void	resetBottomPadding ()
Q_INVOKABLE void	resetBuiltInShortcutsEnabled ()
Q_SLOT void	resetContextMenuHandler ()
Q_SLOT void	resetEnabled ()
Q_SLOT void	resetFocusAutoShow ()
Q_SLOT void	resetFocusPolicy ()
Q_SLOT void	resetFocusRetentionPolicyFlags ()
Q_SLOT void	resetHorizontalAlignment ()
Q_SLOT void	resetImplicitLayoutAnimationsEnabled ()
Q_SLOT void	resetLayoutProperties ()
Q_SLOT void	resetLeftMargin ()
Q_SLOT void	resetLeftPadding ()
Q_SLOT void	resetLocallyFocused ()
Q_SLOT void	resetMaxHeight ()
Q_SLOT void	resetMaxWidth ()
Q_SLOT void	resetMinHeight ()
Q_SLOT void	resetMinWidth ()
Q_SLOT void	resetOpacity ()
Q_SLOT void	resetOverlapTouchPolicy ()
Q_SLOT void	resetPivot ()
Q_SLOT void	resetPivotX ()
Q_SLOT void	resetPivotY ()
Q_SLOT void	resetPreferredHeight ()
Q_SLOT void	resetPreferredSize ()
Q_SLOT void	resetPreferredWidth ()
Q_SLOT void	resetRightMargin ()
Q_SLOT void	resetRightPadding ()
Q_SLOT void	resetRotationZ ()
Q_SLOT void	resetScale ()
Q_SLOT void	resetScaleX ()
Q_SLOT void	resetScaleY ()
Q_SLOT void	resetTopMargin ()
Q_SLOT void	resetTopPadding ()
Q_SLOT void	resetTouchPropagationMode ()
Q_SLOT void	resetTranslation ()
Q_SLOT void	resetTranslationX ()
Q_SLOT void	resetTranslationY ()
Q_SLOT void	resetVerticalAlignment ()
Q_SLOT void	resetVisible ()
float	rightMargin () const
float	rightPadding () const
float	rotationZ () const
float	scaleX () const
float	scaleY () const
Q_SLOT void	setAccessibilityMode (bb::cascades::A11yMode::Type accessibilityMode)
Q_SLOT void	setBottomMargin (float bottomMargin)
Q_SLOT void	setBottomPadding (float bottomPadding)
Q_INVOKABLE void	setBuiltInShortcutEnabled (bb::cascades::SystemShortcuts::Type type, bool enabled)
Q_SLOT void	setBuiltInShortcutsEnabled (bool enabled)
void	setContextMenuHandler (bb::cascades::ContextMenuHandler *contextMenuHandler)
Q_SLOT void	setEnabled (bool enabled)
Q_SLOT void	setFocusAutoShow (const bb::cascades::FocusAutoShow::Type focusAutoShow)
Q_SLOT void	setFocusPolicy (const bb::cascades::FocusPolicy::Type focusPolicy)
Q_SLOT void	setFocusRetentionPolicyFlags (bb::cascades::FocusRetentionPolicy::Types policy)
Q_SLOT void	setHorizontalAlignment (bb::cascades::HorizontalAlignment::Type horizontalAlignment)
Q_SLOT void	setImplicitLayoutAnimationsEnabled (bool enable)
Q_SLOT void	setLayoutProperties (bb::cascades::LayoutProperties *layoutProperties)
Q_SLOT void	setLeftMargin (float leftMargin)
Q_SLOT void	setLeftPadding (float leftPadding)
Q_SLOT void	setLocallyFocused (bool locallyFocused)
Q_SLOT void	setMaxHeight (float maxHeight)
Q_SLOT void	setMaxWidth (float maxWidth)
Q_SLOT void	setMinHeight (float minHeight)
Q_SLOT void	setMinWidth (float minWidth)
void	setObjectName (const QString &name)
Q_SLOT void	setOpacity (float opacity)
Q_SLOT void	setOverlapTouchPolicy (bb::cascades::OverlapTouchPolicy::Type policy)
Q_SLOT void	setPivot (float pivotX, float pivotY)
Q_SLOT void	setPivotX (float pivotX)
Q_SLOT void	setPivotY (float pivotY)
Q_SLOT void	setPreferredHeight (float preferredHeight)
Q_SLOT void	setPreferredSize (float preferredWidth, float preferredHeight)
Q_SLOT void	setPreferredWidth (float preferredWidth)
Q_SLOT void	setRightMargin (float rightMargin)
Q_SLOT void	setRightPadding (float rightPadding)
Q_SLOT void	setRotationZ (float rotationZ)
Q_SLOT void	setScale (float scaleX, float scaleY)
Q_SLOT void	setScale (float scaleXY)
Q_SLOT void	setScaleX (float scaleX)
Q_SLOT void	setScaleY (float scaleY)
Q_SLOT void	setTopMargin (float topMargin)
Q_SLOT void	setTopPadding (float topPadding)
Q_SLOT void	setTouchPropagationMode (bb::cascades::TouchPropagationMode::Type mode)
Q_SLOT void	setTranslation (float translationX, float translationY)
Q_SLOT void	setTranslationX (float translationX)
Q_SLOT void	setTranslationY (float translationY)
Q_SLOT void	setVerticalAlignment (bb::cascades::VerticalAlignment::Type verticalAlignment)
Q_SLOT void	setVisible (bool visible)
Q_INVOKABLE bb::cascades::AbstractShortcut *	shortcutAt (int index) const
Q_INVOKABLE int	shortcutCount () const
virtual Q_INVOKABLE QString	toDebugString () const
float	topMargin () const
float	topPadding () const
TouchPropagationMode::Type	touchPropagationMode () const
float	translationX () const
float	translationY () const
Q_INVOKABLE bb::cascades::UIConfig *	ui () const
bb::cascades::VerticalAlignment::Type	verticalAlignment () const

Static Public Functions Index

Builder

create ()

Protected Functions Index

Only has inherited protected functions

	BaseObject (QObject *parent=0)
virtual void	connectNotify (const char *signal)
virtual void	disconnectNotify (const char *signal)

Signals Index

void	activationChanged (QVariantList indexPath, bool active)
void	bufferedScrollingEnabledChanged (bool bEnabled)
void	dataModelChanged (bb::cascades::DataModel *dataModel)
void	flickModeChanged (bb::cascades::FlickMode::Type newFlickMode)
void	layoutChanged (bb::cascades::ListLayout *layout)
void	leadingVisualChanged (bb::cascades::VisualNode *pLeadingVisual)
void	leadingVisualSnapThresholdChanged (float leadingVisualSnapThreshold)
void	listItemProviderChanged (bb::cascades::ListItemProvider *listItemProvider)
void	multiSelectActionChanged (bb::cascades::MultiSelectActionItem *multiSelectAction)
void	rootIndexPathChanged (QVariantList rootIndexPath)
void	scrollIndicatorModeChanged (bb::cascades::ScrollIndicatorMode::Type newScrollIndicatorMode)
void	scrollRoleChanged (bb::cascades::ScrollRole::Type newScrollRole)
void	selectionChanged (QVariantList indexPath, bool selected)
void	selectionChangeEnded ()
void	selectionChangeStarted ()
void	snapModeChanged (bb::cascades::SnapMode::Type newSnapMode)
void	stickToEdgePolicyChanged (bb::cascades::ListViewStickToEdgePolicy::Type newStickToEdgePolicy)
void	triggered (QVariantList indexPath)
void	accessibilityModeChanged (bb::cascades::A11yMode::Type newAccessibilityMode)
void	actionSetAdded (bb::cascades::ActionSet *actionSet)
void	actionSetRemoved (bb::cascades::ActionSet *actionSet)
void	bottomMarginChanged (float bottomMargin)
void	bottomMarginSetChanged (bool isSet)
void	bottomPaddingChanged (float bottomPadding)
void	builtInShortcutsEnabledChanged (bool builtInShortcutsEnabled)
void	contextMenuHandlerChanged (bb::cascades::ContextMenuHandler *contextMenuHandler)
void	creationCompleted ()
void	enabledChanged (bool enabled)
void	focusAutoShowChanged (bb::cascades::FocusAutoShow::Type newFocusAutoShow)
void	focusedChanged (bool focused)
void	focusPolicyChanged (bb::cascades::FocusPolicy::Type newFocusPolicy)
void	focusRetentionPolicyFlagsChanged (bb::cascades::FocusRetentionPolicy::Types policy)
void	horizontalAlignmentChanged (bb::cascades::HorizontalAlignment::Type newHorizontalAlignment)
void	implicitLayoutAnimationsEnabledChanged (bool implicitLayoutAnimationsEnabled)
void	layoutPropertiesChanged (bb::cascades::LayoutProperties *layoutProperties)
void	leftMarginChanged (float leftMargin)
void	leftMarginSetChanged (bool isSet)
void	leftPaddingChanged (float leftPadding)
void	locallyFocusedChanged (bool newLocallyFocused)
void	maxHeightChanged (float maxHeight)
void	maxWidthChanged (float maxWidth)
void	minHeightChanged (float minHeight)
void	minWidthChanged (float minWidth)
void	objectNameChanged (const QString &objectName)
void	opacityChanged (float opacity)
void	opacityChanging (float opacity)
void	overlapTouchPolicyChanged (bb::cascades::OverlapTouchPolicy::Type newOverlapTouchPolicy)
void	pivotXChanged (float pivotX)
void	pivotYChanged (float pivotY)
void	preferredHeightChanged (float preferredHeight)
void	preferredHeightSetChanged (bool isSet)
void	preferredWidthChanged (float preferredWidth)
void	preferredWidthSetChanged (bool isSet)
void	rightMarginChanged (float rightMargin)
void	rightMarginSetChanged (bool isSet)
void	rightPaddingChanged (float rightPadding)
void	rotationZChanged (float rotationZ)
void	rotationZChanging (float rotationZ)
void	scaleXChanged (float scaleX)
void	scaleXChanging (float scaleX)
void	scaleYChanged (float scaleY)
void	scaleYChanging (float scaleY)
void	topMarginChanged (float topMargin)
void	topMarginSetChanged (bool isSet)
void	topPaddingChanged (float topPadding)
void	touch (bb::cascades::TouchEvent *event)
void	touchCapture (bb::cascades::TouchEvent *event)
void	touchEnter (bb::cascades::TouchEnterEvent *event)
void	touchExit (bb::cascades::TouchExitEvent *event)
void	touchPropagationModeChanged (bb::cascades::TouchPropagationMode::Type newTouchPropagationMode)
void	translationXChanged (float translationX)
void	translationXChanging (float translationX)
void	translationYChanged (float translationY)
void	translationYChanging (float translationY)
void	verticalAlignmentChanged (bb::cascades::VerticalAlignment::Type newVerticalAlignment)
void	visibleChanged (bool visible)

Properties

bool bufferedScrollingEnabled

Enables the ListView to prebuffer item data during certain scroll operations in order to optimize quality and speed of layout operations.

Warning!

This functionality is currently in an experimental stage and is disabled by default. It should be used with caution and followed up with thorough testing. Examples of risks involved when when using it:

Degraded performance. For example, if the contents of a ListView change continuously and rapidly, the buffered data can become unusable.
Scroll latency. Items of considerable byte size (e.g. containing large images) will introduce higher latency from the point of the API call to actually reaching visible target.

Note:

Currently doesn't support GridListLayout. When using this type of layout the buffering property will be silently ignored. For all other layout types, the buffering functionality (once enabled) will be effective for the remainder of the lifetime of the ListView.

When enabled, the following scrolling scenarios are affected:

scrollToItem(), scrollToPosition When scrolling to items or named positions with ScrollAnimation::None, all items required to fill the visible area of the listview will be transferred to the server cache before performing the actual scroll operation. The actual layout will be perceived as instant. However the latency until jumping to the target location is dependent on the workload of transferring the items to the server.

For any other kind of scroll operation or scroll animation, the buffer functionality is disabled.

See also:

scrollToItem(), scrollToPosition

Since:

BlackBerry 10.0.0

bb::cascades::DataModel dataModel

Specifies a DataModel to use as source for item data in this ListView.

The default value is 0, which means that no items are shown.

Since:

BlackBerry 10.0.0

bb::cascades::FlickMode::Type flickMode

Specifies the scroll behavior of the list in response to a flick gesture.

The default value is FlickMode::Default, which lets the framework decide the flick mode.

See also:

FlickMode

Since:

BlackBerry 10.0.0

bb::cascades::ListLayout layout

The ListLayout for the ListView.

How a ListView positions its items is determined by the type of layout it has. The default layout for a ListView is a StackListLayout, but you can also use GridListLayout and FlowListLayout.

Since:

BlackBerry 10.0.0

bb::cascades::VisualNode leadingVisual

An optional VisualNode that the ListView can use as a leading visual.

The leading visual is placed before the first item in the list and can be reached by dragging towards the beginning of the list.

The default value is 0.

Since:

BlackBerry 10.0.0

float leadingVisualSnapThreshold

A fraction of the ListView size that determines if the ListView should snap back from its leading visual to its leading edge when scrolling ends.

The leading visual snap threshold is the fraction of the ListView size that determines how much of the leading visual that must be visible to prevent the ListView from snapping back to its leading edge when scrolling ends. For example a value of 0 will cause the ListView to never snap back from the leading visual, a value of 0.5 will cause the list view to snap back to its leading edge if scrolling ends with the leading visual occupying less than half of the ListView size in the layout direction.

The default value is 0.2.

Since:

BlackBerry 10.0.0

bb::cascades::ListItemProvider listItemProvider

Specifies a ListItemProvider to use as source for item visualizations in this ListView.

The default value is 0, which means that this ListView creates a Header for items of the type "header" and a StandardListItem for all other types of items. In that case this ListView also tries to assign the data returned from DataModel::data() to Header::title or StandardListItem::title.

Since:

BlackBerry 10.0.0

bb::cascades::MultiSelectActionItem multiSelectAction

A global multi-select action to show in the context menu for the list items.

This property is mainly for convenience. Typically, when you want to show a multi-select action, you add it to an ActionSet on each list item. But for convenience, you can use this property to add a multi-select action for all the list items.

If a list item already has a MultiSelectActionItem added to it, this property will be ignored and the one added to the item will be used.

Warning!

The list item must have an ActionSet in order for this multi-select action to be added to it. The ActionSet can be empty.

The default value is 0.

Since:

BlackBerry 10.0.0

bb::cascades::MultiSelectHandler multiSelectHandler[read-only]

The handler used during multiple selection to populate the Context menu.

Activating the multi-select handler will put the ListView in multiple selection mode, which shows the context menu populated with the actions from this handler.

This is a grouped property, meaning there is always a multi-select handler attached to a ListView. For convenience this object has a default MultiSelectHandler::multiSelectAction object set on it. If this is not needed, you will need to remove or reset it manually.

 ListView {
     id: theListView

     // This multi-select action will be placed inside the ActionSets of each 
     // list item that doesn't have a MultiSelectActionItem of its own.
     multiSelectAction: MultiSelectActionItem {}

     multiSelectHandler {
         // These actions will be shown during multiple selection, while this 
         // multiSelectHandler is active
         actions: [
             ActionItem {title: "Multi-select action"},
             DeleteActionItem {}
         ]

         status: "None selected"
     
         onActiveChanged: {
             if (active == true) {
                 console.log("Multiple selection is activated");
             }
             else {
                 console.log("Multiple selection is deactivated");
             }
         }
     }

     // Change the status text in the multiSelectHandler to show how many items
     // are selected
     onSelectionChanged: {
         if(selectionList().length > 1) {
             multiSelectHandler.status = selectionList().length + " items selected";
         }
         else if(selectionList().length == 1) {
             multiSelectHandler.status = "1 item selected";
         }
         else {
             multiSelectHandler.status = "None selected";
         }
     }

     listItemComponents: [
         ListItemComponent {
             id: photo
             
             // These actions will be shown in the Context Menu this list item is
             // long-pressed
             contextActions: [
                 ActionSet {
                     ActionItem {title: "Single-select action"}
                     DeleteActionItem {}
                 }
             ]
         }
     ]
 }

Since:

BlackBerry 10.0.0

bb::cascades::RearrangeHandler rearrangeHandler[read-only]

The handler used for managing interactive rearrange sessions controlled by user touch input.

Activating the rearrange handler will put the ListView in rearrange mode. Visual "grabber" overlays appears on all leaf items which then can be lifted and dragged by the user.

This is a grouped property, meaning there is always a rearrange handler attached to a ListView.

For more information about rearranging lists, see the [Rearranging lists documentation]("https://developer.blackberry.com/native/documentation/cascades/ui/lists/list_view_selection.html#rearranginglists").

See also:

RearrangeHandler

Since:

BlackBerry 10.3.0

QVariantList rootIndexPath

Specifies which node in the connected DataModel this ListView should use as the root.

The default value is an empty QVariantList, which means that the root node of the DataModel is used as root node by this ListView.

See index paths for more information.

Since:

BlackBerry 10.0.0

bb::cascades::ScrollIndicatorMode::Type scrollIndicatorMode

Specifies if and how a scroll indicator should be shown.

The default value is ScrollIndicatorMode::Default, which means that the framework decides if and how a scroll indicator is shown.

Since:

BlackBerry 10.0.0

bb::cascades::ScrollRole::Type scrollRole

Indicates this control's scroll role on the page.

Scroll role is an abstract concept that indicates to the framework which scrollable control can be considered as main/root scrollable and therefore connected to various appropriate features such as automatically hiding the action bar. Typical characteristics for a main scrollable is that it covers a big part of the screen, that it doesn't have any siblings and that it doesn't have any other scrollable controls as ancestors. The action bar might not hide automatically when user scrolls list if there is not much content left to scroll list down. Controls with scrollRole set to bb::cascades::ScrollRole::None are ignored and can't become a main scrollable control of the page. All scrollable controls with scrollRole set to bb::cascades::ScrollRole::Main are considered as main scrollable controls of the page. Scrollable control with scrollRole set to bb::cascades::ScrollRole::Default might be considered as the main scrollable control of the page if it satisfies default requirements.

The default value is bb::cascades::ScrollRole::Default.

See also:

Page::actionBarAutoHideBehavior

Since:

BlackBerry 10.1.0

bb::cascades::SnapMode::Type snapMode

Specifies if and how the scroll position should snap to items in the list.

If set to SnapMode::LeadingEdge, the ListView makes sure that, in a top-to-bottom layout, the first visible item is always aligned to the top of the ListView when the list is not in motion (that is, when the user is not touching and dragging the list). In a bottom-to-top layout, the bottom of the last visible item is aligned to the bottom of the ListView, and so on.

The illustration shows how the user can drag the list to a point where the top item is not aligned with the top of the visible area. If snapMode is set to SnapMode::LeadingEdge, ListView continues the scrolling after the user lifts their finger, until an item is aligned with the top of the visible area.

If the list is currently scrolled all the way to the beginning, or all the way to the end, ListView will not snap away from that position, regardless of what snap mode is currently set on this property.

The default value is SnapMode::Default, which lets the framework decide the snap mode.

Since:

BlackBerry 10.0.0

bb::cascades::ListViewStickToEdgePolicy::Type stickToEdgePolicy

Specifies how the list should stick to its edges when the list or its content changes size.

Changes in the DataModel, changing item size, list size or padding can trigger an instantaneous change in scroll position without the user interacting with the list. This property can be used to enable specific behavior in those cases when the scroll position is at the beginning or end.

The default value is ListViewStickToEdgePolicy::Default, which lets the framework decide.

See also:

ListViewStickToEdgePolicy

Since:

BlackBerry 10.1.0

bb::cascades::AbstractA11yObject accessibility[read-only]

Defines the control's accessibility object.

Since:

BlackBerry 10.2.0

bb::cascades::A11yMode::Type accessibilityMode

The accessibility mode for the control.

This property defines how the control and its subtree will be exposed to assistive technologies. The default value is Default which means that the framework automates accessibility mode based on accessible information and context. Typically accessibility information is assumed to be available, unless any parent is configured with accessibilityMode = Collapsed.

When accessibility information is available, the accessibility property will be used to define the accessibility properties.

See also:

accessibility

Since:

BlackBerry 10.2.0

QDeclarativeListProperty< QObject > attachedObjects[read-only]

A hierarchical list of the UIObject's attached objects.

Since:

BlackBerry 10.0.0

QDeclarativeListProperty keyListeners[read-only]

A list of ActionSet object that are displayed in the control's context menu.

A list of key listeners attached to this control.

A list of shortcuts that can be triggered via user actions.

These action sets are displayed in the Context Menu for this control. When the context menu is opened, the first ActionSet object in the list is displayed initially, and the user can cycle through them in the order that they are added to the control.

See also:

ActionSet

Since:

BlackBerry 10.0.0

The order in which they are added will determine which shortcut will be triggered in case of an overlap. Note that predefined shortcuts have precedence over shortcuts defined via QString in case of a collision

See also:

AbstractShortcut

Since:

BlackBerry 10.1.0

The order in which key listeners are added does not change their behavior

See also:

KeyListener

Since:

BlackBerry 10.1.0

float bottomMargin

The bottom margin for the control.

Margins are positive values that specify the space around a control.

How the margin is actually used depends on how the control is laid out within it's parent container. When the control is laid out in a StackLayout, the margin is considered between the siblings in the layout direction. In that case the distance between two children in the layout direction will be the largest margin of the two adjacent margins in the layout direction.

Since:

BlackBerry 10.0.0

bool bottomMarginSet[read-only]

Indicates whether the bottomMargin of a control is set.

If true the bottom Margin has been set on a control, if false the bottomMargin is not set. By default, bottomMargin is false, meaning that the control will use control-specific default

Since:

BlackBerry 10.0.0

float bottomPadding

The bottom padding for the control.

The default bottom padding is 0.

Bottom padding only works for the following controls, for all other controls bottom padding is undefined:

Negative padding values are supported in the ListView control, for all other controls negative padding is undefined.

Since:

BlackBerry 10.0.0

bool builtInShortcutsEnabled

Enables or disables all Control's built-in shortcuts.

This property is used when all Control's built-in shortcuts should be enabled or disabled. Cotrol's built-in shortcuts are shortcuts like Navigation shortcuts in ScrollView and ListView.

Since:

BlackBerry 10.2.0

bb::cascades::ContextMenuHandler contextMenuHandler

The handler for interacting with the Context menu for this Control.

Setting this handler allows you to listen on events from the Context menu. For example the ContextMenuHandler::showing() signal is emitted when the Context menu is about to show, allowing you to update the content of your context actions just-in-time.

See also:

#contextActions, ContextMenuHandler::showing()

The default value is @0, indicating no ContextMenuHandler is set.

Since:

BlackBerry 10.0.0

bool enabled

Indicates whether the control is enabled.

When a control is disabled, it does not respond to user input. The disabled control continues to receive events, but does not process them. Changing the enabled state may also affect the appearance of the control.

If true the control is enabled, if false it's disabled.

Since:

BlackBerry 10.0.0

bb::cascades::FocusAutoShow::Type focusAutoShow

Indicates whether a control should automatically be made visible when it receives focus.

The default focusAutoShow value is Default.

Since:

BlackBerry 10.0.0

bool focused[read-only]

Indicates whether the control is focused.

If true the control is focused, if false it's not focused.

Since:

BlackBerry 10.0.0

bb::cascades::FocusPolicy::Type focusPolicy

Indicates whether this control is focusable or not and what kind of user input focus can be received (touch and/or key).

The default focusPolicy value is None. A disabled Control can not have focus.

Since:

BlackBerry 10.0.0

bb::cascades::FocusRetentionPolicy::Types focusRetentionPolicyFlags

The focus retention policy that determines the conditions under which a control loses focus.

Normally, a control loses focus whenever a user touches outside of the control or on another control, or when scrolling a ListView (may differ from device to device). However, it may be convenient at times to retain focus. This property makes it possible to specify the conditions under which the control should lose focus and when it shouldn't. The property only affects focus changes initiated by user interaction, not when programmatically changing focus (i.e. by calling requestFocus() on a control).

Here's an example of how to set the focus retention policy in QML:

TextArea {
    focusRetentionPolicyFlags: FocusRetentionPolicy.LoseToNonFocusable |
            FocusRetentionPolicy.LoseOnScroll
    text: "Loses Focus"        
}

Since:

BlackBerry 10.0.0

bb::cascades::HorizontalAlignment::Type horizontalAlignment

Specifies the HorizontalAlignment for the control.

The default alignment is HorizontalAlignment::Left.

Since:

BlackBerry 10.0.0

bool implicitLayoutAnimationsEnabled

Enables or disables implicit animations when layout-related properties for a Control are changed.

This property affects implicit animations on the following properties for a control.

positioning in a layout, including x and y coordinates and horizontal and vertical alignment
preferred height and width
maximum and minimum height and width
margins and padding

The default is true meaning that implicit animations are enabled.

For VisualNode properties, you can customize implicit animations by using ImplicitAnimationController. These properties include translation, rotation, scaling, pivoting, and opacity.

Since:

BlackBerry 10.0.0

bb::cascades::InputRouteProperties inputRoute[read-only]

Defines this control's role in the propagation of input events.

QML usage:

Container {
    inputRoute.primaryKeyTarget: true

    Label {
        id: myLabel
        text: "Press a"
    }

    shortcuts: [
        Shortcut {
            key: "a"
            onTriggered: {
                myLabel.text = "Shortcut triggered!"
            }
        }
    ]
}

C++ usage:

Container *pContainer = new Container();
pContainer->inputRoute()->setPrimaryKeyTarget(true);
// Shortcuts on pContainer can now trigger.

C++ usage (with builder):

Container *pContainer = Container::create()
    .primaryKeyTarget(true)
    .add(Label::create()
            .text("My container will get key events!"));

Since:

BlackBerry 10.1.0

bb::cascades::LayoutProperties layoutProperties

The layout properties for the control.

The layoutProperties property specifies how the parent container should position and size the control. The layoutProperties object must match the Layout type of the container. For example, if the parent container uses a stack layout, the layoutProperties should be a StackLayoutProperties object.

By default, a control's layoutProperties is 0. If the layoutProperties for a control is not explicitly set, the parent container uses the default layout properties for the type of layout that it's using.

Since:

BlackBerry 10.0.0

float leftMargin

The left margin for the control.

Margins are positive values that specify the space around a control.

How the margin is actually used depends on how the control is laid out within its parent container. When the control is laid out in a StackLayout, the margin is considered between the siblings in the layout direction. In that case the distance between two children in the layout direction will be the largest margin of the two adjacent margins in the layout direction.

The default value depends on the actual control. For the Container class the value is 0.0.

Since:

BlackBerry 10.0.0

bool leftMarginSet[read-only]

Indicates whether the leftMargin of a control is set.

If true the left margin has been set on a control, if false the leftMargin is not set. By default, leftMargin is false, meaning that the control will use control-specific default

Since:

BlackBerry 10.0.0

float leftPadding

The left padding for the control.

The default left padding is 0.

Left padding only works for the following controls, for all other controls left padding is undefined:

Negative padding values are supported in the ListView control, for all other controls negative padding is undefined.

Since:

BlackBerry 10.0.0

bool locallyFocused

Indicates whether the control has local focus.

Each focus scope keeps track of a local focus. The local focus can be used to set which control should get focus when navigating to the focus scope. If the focus scope contains the actual focus when setting local focus to true, actual will be requested by this control.

Since:

BlackBerry 10.3.1

bb::cascades::Spacings margin[read-only]

Full margins for the control.

Margins are positive values that specify the space around a control.

How the margin is actually used depends on how the control is laid out within its parent, both Containers, ListViews and ScrollViews (and other controls that have children) can use the information to position their children.

For example when the control is laid out in a StackLayout, the margin is considered both for the distance from the side of the parent and between the siblings in the layout direction. In such a case the distance between two children in the layout direction will be the largest margin of the two adjacent children in the layout direction.

For DockLayout the margin values will affect only the position from the side of the parent to the child.

The Margin group property is not created until it's needed, default value for the margins of a control are undefined which means that the containing parent will decide. In the margins group property this is specified by the float values defaulting to NAN.

This is a new API that will replace the current version using topMargin et.c. but until the support is fully implemented in all Containing Controls, the old way is not deprecated. I the current version the difference between using the margin group property and separate margin properties (topMargin et.c.) is that the group property can be used both for the space between siblings in a StackLayout and StackListLayout but that the Layouts in a container also use it to position the children from the inside of the container. Lessening the need for extra layers of containers with padding.

Since:

BlackBerry 10.3.0

float maxHeight

The maximum height for the control.

The max height is a positive value used by the layout system to position the control.

The default maxHeight is infinitely large (no limit). The control can determine the effective maxHeight of a control by combining the maxHeight with the size of contents of the control.

Since:

BlackBerry 10.0.0

float maxWidth

The maximum width for the control.

The max width is a positive value used by the layout system to position the control.

The default maxWidth is infinitely large (no limit). The control can determine the effective maxWidth of a control by combining the maxWidth with the size of contents of the control.

Since:

BlackBerry 10.0.0

float minHeight

The minimum height for the control.

The min height is a positive value used by the layout system to position the control.

The default minHeight for a control is 0.0. The control can determine the effective minHeight of a control by combining the minHeight with the size of contents of the control.

Since:

BlackBerry 10.0.0

float minWidth

The minimum width for the control.

The min width is a positive value used by the layout system to position the control.

The default minWidth for a control is 0.0. The control can determine the effective minWidth of a control by combining the minWidth with the size of contents of the control.

Since:

BlackBerry 10.0.0

QString objectName

This property is overridden from QObject.

See also:

QObject::objectName().

Since:

BlackBerry 10.0.0

float opacity

The opacity of the visual node.

A value between 0.0 (transparent) and 1.0 (opaque). This is the local opacity of the visual node, i.e. not taking the ancestor opacities into account. The default opacity is 1.0 (opaque).

Since:

BlackBerry 10.0.0

bb::cascades::OverlapTouchPolicy::Type overlapTouchPolicy

Determines whether the visual node will prevent underlying (spatially overlapped) nodes from partaking in touch event propagation.

If overlap touch policy is OverlapTouchPolicy::Deny, overlapped nodes will be excluded from touch propagation at an early stage during the processing of touch input. This means a scene with many layers of visual nodes with overlap touch policy set to OverlapTouchPolicy::Allow, may affect touch performance negatively.

Note:

The policy has no effect if propagation mode is TouchPropagationMode::None for the same visual node.

The default policy is OverlapTouchPolicy::Deny.

Since:

BlackBerry 10.0.0

QObject parent[read-only]

A read-only property that represents this object's parent.

The parent of an object is specified using QObject::setParent(QObject*). The purpose of the property is to expose the object's parent to QML.

This property is read-only to prevent modifications from QML, where typically the parent is declaratively set. In C++ code, the parent can be explicitly set using QObject::setParent(QObject*), or implicitly set by adding it to a visual container.

The default value of this property is 0.

Since:

BlackBerry 10.0.0

float pivotX

The position of pivot point of the visual node along the x-axis.

The pivot is used as the anchoring point when rotating and scaling the visual node. It is defined by the components pivotX, pivotY and pivotZ and is relative to the center of the visual node. The default position of the pivot point is (0.0, 0.0, 0.0), which means it is at the center of the visual node.

Since:

BlackBerry 10.0.0

float pivotY

The position of pivot point of the visual node along the y-axis.

Since:

BlackBerry 10.0.0

float preferredHeight

The preferred height of the control.

The preferred height is a positive value used by the Layout of the parent Container to position the control. If the preferred height for a control is not set, the parent container ignores this value and uses the control-specific default height. See the API reference for a specific control for more details about its default height. You can check whether the preferredHeight of a control is set by calling isPreferredHeightSet().

However, just because the preferred height has been set on a control, does not mean it is being used. The preferred height is ignored by the parent container if it is smaller than the minimum size allowed for that control.

Since:

BlackBerry 10.0.0

bool preferredHeightSet[read-only]

Indicates whether the preferredHeight of a control is set.

If true the preferred height has been set on a control, if false the preferred height is not set. By default, preferredHeightSet is false, meaning that the parent container ignores the preferred height and uses the control-specific default instead.

Since:

BlackBerry 10.0.0

float preferredWidth

The preferred width of the control.

The preferred width is a positive value used by the Layout of the parent Container to position the control. If the preferred width for a control is not set (or was set but has since been reset), the parent container ignores this value and uses the control-specific default width. See the API reference for a specific control for more details about its default width. You can check whether the preferredWidth of a control is set by calling isPreferredWidthSet().

However, just because the preferred width has been set on a control, does not mean it is being used. The preferred width is ignored by the parent container if it is smaller than the minimum size allowed for that control.

Since:

BlackBerry 10.0.0

bool preferredWidthSet[read-only]

Indicates whether the preferredWidth of a control is set.

If true the preferred width has been set on a control, if false the preferred width is not set. By default, preferredWidthSet is false, meaning that the parent container ignores the preferred width and uses the control-specific default instead.

Since:

BlackBerry 10.0.0

float rightMargin

The right margin for the control.

Margins are positive values that specify the space around a control.

The default value depends on the actual control. For the Container class the value is 0.0.

Since:

BlackBerry 10.0.0

bool rightMarginSet[read-only]

Indicates whether the rightMargin of a control is set.

If true the right margin has been set on a control, if false the rightMargin is not set. By default, rightMargin is false, meaning that the control will use control-specific default

Since:

BlackBerry 10.0.0

float rightPadding

The right padding for the control.

The default right padding is 0.

Right padding only works for the following controls, for all other controls right padding is undefined:

Negative padding values are supported in the ListView control, for all other controls negative padding is undefined.

Since:

BlackBerry 10.0.0

float rotationZ

The rotation of the visual node around the z-axis in degrees.

The visual node is rotated around the z-axis, centered around a pivot point defined by the components pivotX, pivotY and pivotZ. The default rotation is 0.0 degrees.

Since:

BlackBerry 10.0.0

float scaleX

The scale factor of the visual node along the x-axis.

The visual node is scaled along the x-axis, centered around a pivot point defined by the components pivotX, pivotY and pivotZ. The default scale factor is 1.0 (not scaled).

Since:

BlackBerry 10.0.0

float scaleY

The scale factor of the visual node along the y-axis.

The visual node is scaled along the y-axis, centered around a pivot point defined by the components pivotX, pivotY and pivotZ. The default scale factor is 1.0 (not scaled).

Since:

BlackBerry 10.0.0

float topMargin

The top margin for the control.

Margins are positive values that specify the space around a control.

The default value depends on the actual control. For the Container class the value is 0.0.

Since:

BlackBerry 10.0.0

bool topMarginSet[read-only]

Indicates whether the topMargin of a control is set.

If true the top Margin has been set on a control, if false the topMargin is not set. By default, topMargin is false, meaning that the control will use control-specific default

Since:

BlackBerry 10.0.0

float topPadding

The top padding for the control.

The default top padding is 0.

Top padding only works for the following controls, for all other controls top padding is undefined:

Negative padding values are supported in the ListView control, for all other controls negative padding is undefined.

Since:

BlackBerry 10.0.0

bb::cascades::TouchPropagationMode::Type touchPropagationMode

The touch propagation mode for the visual node.

This property controls how the visual node and its subtree partakes in touch event propagation. There are three possible modes, as defined by TouchPropagationMode::Type:

TouchPropagationMode::Full means that touch events will be fully propagated to the visual node and it's subtree.
TouchPropagationMode::None means no touch events will be propagated to the visual node or its subtree. The subtree is practically invisible to the touch system.
TouchPropagationMode::PassThrough means touch events will not be handled by the visual node itself, but its subtree will get touch events as usual.

TouchPropagationMode::None can be used as an optimization if you have complex, non-interactive content, that overlaps interactive controls.

The default propagation mode is TouchPropagationMode::Full.

Since:

BlackBerry 10.0.0

float translationX

The translation of the visual node along the x-axis.

The translationX and translationY correspond to pixels as long as the translationZ is 0.0.

The translation is mostly useful for animations as it doesn't affect the actual laid out position of the visual node. This translation is added after the node has been laid out so it doesn't affect layout in any way.

See also:

Layout for more details.

Since:

BlackBerry 10.0.0

float translationY

The translation of the visual node along the y-axis.

The translationX and translationY correspond to pixels as long as the translationZ is 0.0.

See also:

Layout for more details.

Since:

BlackBerry 10.0.0

bb::cascades::UIConfig ui[read-only]

An object that gives access to unit conversion routines.

QML use:

        // Size using design units
        Container {
            preferredWidth: ui.du(12)
            preferredHeight: ui.du(5)
        }

        // Size using design units, snap to whole pixels
        Container {
            preferredWidth: ui.sdu(13.5)
            preferredHeight: ui.sdu(7.5)
        }

        // Size using absolute pixel values
        Container {
            preferredWidth: ui.px(150)
            preferredHeight: ui.px(50)
        }

C++ use:

Container *container1 = Container::create().background(Color::Red);
UIConfig *ui = container1->ui();
container1->setPreferredWidth(ui->du(12));
container1->setPreferredHeight(ui->du(5));

Container *container2 = Container::create().background(Color::Green);
container2->setPreferredWidth(ui->sdu(13.5));
container2->setPreferredHeight(ui->sdu(7.5));

Container *container3 = Container::create().background(Color::Blue);
container3->setPreferredWidth(ui->px(150));
container3->setPreferredHeight(ui->sdu(50));

Since:

Blackberry 10.3.0

bb::cascades::VerticalAlignment::Type verticalAlignment

Specifies the VerticalAlignment for the control.

The default alignment is VerticalAlignment::Top.

Since:

BlackBerry 10.0.0

bool visible

Whether the visual node is laid out or not.

If the visible property is set to false, the visual node is neither laid out nor rendered. The default visible value is true.

Important: Setting the visible value to false is not the same as setting opacity to 0.0f (transparent). While a transparent node is still laid out taking up room in the scene, a node that is not visible, will neither be rendered nor laid out inside the scene. It will behave as if it was removed from the scene without actually been unlinked from the scene graph. No touch events will be sent to the node if the visible value is false. This a convenient way of removing nodes to optimize the performance of the scene without is actually unlinking them. It is highly recommended to use this property to hide visual nodes whenever possible.

Since:

BlackBerry 10.0.0

Public Static Attributes

const QVariantList AllItems ()

A parameter sent by the selectionChanged() signal in response to the selectAll() and clearSelection() functions.

Since:

BlackBerry 10.0.0

Public Functions

ListView (
Container *parent)

Constructs a ListView with a parent.

If parent is not 0, the ownership of the constructed ListView is transfered to the parent.

Parameters
parent	The parent container or 0. The parent is optional and will default to 0 if not specified.

Since:

BlackBerry 10.0.0

ListView (
bb::cascades::DataModel dataModel,
Container parent )

Constructs a ListView with an optional parent using a specified DataModel.

If parent is not 0, the ownership of the constructed ListView is transfered to the parent.

Parameters
dataModel	The DataModel this ListView will use for its dataModel property.
parent	The parent container or 0. parent is optional and will default to 0 if not specified.

Since:

BlackBerry 10.0.0

virtual~ListView ()

Destructor.

Q_SLOT void clearSelection ()

Makes all items deselected.

This function does not cause signals to be emitted for individual items. Instead, a single selectionChanged() is emitted with ListView::AllItems and false as parameters.

Since:

BlackBerry 10.0.0

DataModel * dataModel ()

Gets the DataModel assigned to this ListView.

Return:

The DataModel assigned to this ListView.

See also:

setDataModel(), resetDataModel()

Since:

BlackBerry 10.0.0

bb::cascades::FlickMode::Type flickMode ()

Gets the flickMode used by the ListView.

Return:

The flickMode currently used by the ListView.

See also:

setFlickMode(), resetFlickMode()

Since:

BlackBerry 10.0.0

bool isBufferedScrollingEnabled ()

Gets the bufferedScrollingEnabled property for the ListView.

Return:

The bufferedScrollingEnabled flag.

Since:

BlackBerry 10.0.0

Q_INVOKABLE bool isSelected (
const QVariantList &indexPath)

Checks if a specific item is currently selected.

Parameters
indexPath	Specifies an item in the DataModel connected to this ListView. See index paths for more information.

Return:

true if the specified item is selected, false otherwise.

Since:

BlackBerry 10.0.0

bb::cascades::ListLayout * layout ()

Returns the layout for the ListView.

If the layout has not been set to anything else, the default StackListLayout will be returned.

Return:

The layout of the ListView, or 0 if there's no layout associated with the ListView.

Since:

BlackBerry 10.0.0

bb::cascades::VisualNode * leadingVisual ()

Gets the leadingVisual property for the ListView.

Ownership of the leading visual will not be transferred from the ListView.

Return:

The leading visual.

Since:

BlackBerry 10.0.0

float leadingVisualSnapThreshold ()

Gets the leadingVisualSnapThreshold property for the ListView.

Return:

The leading visual snap threshold.

Since:

BlackBerry 10.0.0

ListItemProvider * listItemProvider ()

Gets the ListItemProvider assigned to this ListView.

Return:

The ListItemProvider assigned to this ListView.

Since:

BlackBerry 10.0.0

ListItemTypeMapper * listItemTypeMapper ()

Gets the ListItemTypeMapper assigned to this ListView.

Return:

The ListItemTypeMapper assigned to this ListView.

Since:

BlackBerry 10.0.0

bb::cascades::MultiSelectActionItem * multiSelectAction ()

Returns the multiSelectAction to show in the context menu for the list items.

Return:

The multiSelectActionn or 0 if it is not set.

Since:

BlackBerry 10.0.0

bb::cascades::MultiSelectHandler * multiSelectHandler ()

Returns the multiSelectHandler set in this action.

Return:

The multiSelectHandler. This is never 0, since multiSelectHandler is a grouped property.

Since:

BlackBerry 10.0.0

Q_SLOT RearrangeHandler * rearrangeHandler ()

Retrieves the rearrange handler attached to the ListView.

The rearrange handler is used for 2-way communication between the application and the ListView during rearrange mode.

Since:

BlackBerry 10.3.0

Q_SLOT void resetBufferedScrollingEnabled ()

Resets the bufferedScrollingEnabled property to its default value of false.

Since:

BlackBerry 10.0.0

Q_SLOT void resetDataModel ()

Resets the DataModel reference in this ListView, effectively leaving the ListView without an assigned DataModel.

See also:

setDataModel(), dataModel()

Since:

BlackBerry 10.0.0

Q_SLOT void resetFlickMode ()

Resets the flickMode for the ListView to the default value (FlickMode::Default).

See also:

setFlickMode(), flickMode()

Since:

BlackBerry 10.0.0

Q_SLOT void resetLayout ()

Resets the layout to the default layout.

Since:

BlackBerry 10.0.0

Q_SLOT void resetLeadingVisual ()

Resets the leadingVisual property to its default value of 0.

See also:

leadingVisual(), setLeadingVisual()

Since:

BlackBerry 10.0.0

Q_SLOT void resetLeadingVisualSnapThreshold ()

Resets the leadingVisualSnapThreshold property to its default value of 0.2f.

Since:

BlackBerry 10.0.0

Q_SLOT void resetListItemProvider ()

Resets the ListItemProvider reference for this ListView, effectively leaving this ListView without an assigned ListItemProvider.

Since:

BlackBerry 10.0.0

Q_SLOT void resetListItemTypeMapper ()

Resets ListView::listItemTypeMapper, effectively leaving this ListView without an assigned ListItemTypeMapper.

Since:

BlackBerry 10.0.0

Q_SLOT void resetMultiSelectAction ()

Resets the multiSelectAction to 0.

This means no multiSelectAction will be displayed in the context menu.

Since:

BlackBerry 10.0.0

Q_SLOT void resetRootIndexPath ()

Resets the rootIndexPath to its default value.

This causes the ListView to reference the top level of its DataModel.

Since:

BlackBerry 10.0.0

Q_SLOT void resetScrollIndicatorMode ()

Resets the property ListView::scrollIndicatorMode to its default value, which is ScrollIndicatorMode::Default.

Since:

BlackBerry 10.0.0

Q_SLOT void resetScrollRole ()

Resets a control's scrollRole property.

Default value is ScrollRole::Default.

Since:

BlackBerry 10.1.0

Q_SLOT void resetSnapMode ()

Resets the snapMode for the ListView to the default value (SnapMode::Default).

See also:

setSnapMode(), snapMode()

Since:

BlackBerry 10.0.0

Q_SLOT void resetStickToEdgePolicy ()

Resets the stickToEdgePolicy used by this ListView to the default value (ListViewStickToEdgePolicy::Default).

Since:

BlackBerry 10.1.0

QVariantList rootIndexPath ()

Gets the rootIndexPath used by the ListView when referencing data in the DataModel.

Return:

The rootIndexPath used by this ListView.

Since:

BlackBerry 10.0.0

Q_SLOT void scroll (
floatoffset,
bb::cascades::ScrollAnimation::TypescrollAnimation )

Scrolls the list with the specified pixel offset.

Specifying a positive offset value will scroll the list forward in scroll space regardless of item sort order. For example, in a vertical list positive offsets will always move scroll position from top to bottom, even if item sort order is set to bottom-to-top.

IMPORTANT: This function is intended to be used for short scrolling distances, preferably not targeting positions or items outside the current view. For longer scrolling operations it is recommended to use either scrollToItem() or scrollTo().

Parameters
offset	The positive or negative pixel offset to scroll the list.
scrollAnimation	The type of animation to be used when scrolling.

Since:

BlackBerry 10.0.0

bb::cascades::ScrollIndicatorMode::Type scrollIndicatorMode ()

Returns the current value of the property ListView::scrollIndicatorMode.

Return:

The scroll indicator mode currently used by this ListView.

Since:

BlackBerry 10.0.0

bb::cascades::ScrollRole::Type scrollRole ()

Gets the current ListView scrollRole.

Return:

The ListView scrollRole.

Since:

BlackBerry 10.1.0

Q_INVOKABLE QVariantList scrollStops ()

Get the scrollStops currently specified for the ListView.

Note that the index paths retrieved by this method might differ from the list earlier passed to setScrollStops.

Return:

The scrollStops index paths as a QVariantList of QVariantList objects.

See also:

setScrollStops()

Since:

BlackBerry 10.0.0

Q_SLOT void scrollToItem (
const QVariantList &indexPath,
bb::cascades::ScrollAnimation::TypescrollAnimation )

Scrolls to an item so that the item is placed in the top of the visible area of this ListView.

When this function is called on a device with a trackpad or similar input, and the ListView is focused or has a focused descendant, scrollToItem will try setting focus on the item being scrolled to at the end of the programmatic scroll.

Parameters
indexPath	Specifies which item to jump to. See index paths for more information.
scrollAnimation	Specifies which animation type to use when scrolling.

See also:

scrollToPosition()

Since:

BlackBerry 10.0.0

Q_SLOT void scrollToPosition (
bb::cascades::ScrollPosition::Typeposition,
bb::cascades::ScrollAnimation::TypescrollAnimation )

Scrolls to a predefined position in this ListView.

Parameters
position	Specifies which position to scroll to.
scrollAnimation	Specifies which animation type to use when scrolling.

See also:

scrollToItem()

Since:

BlackBerry 10.0.0

Q_SLOT void select (
const QVariantList &indexPath,
boolselect )

Selects or deselects the specified item.

If the selection state of an item changes, the signal selectionChanged() is emitted.

Parameters
indexPath	Specifies an item in the DataModel connected to this ListView. See index paths for more information.
select	The value to set for the selected state of the specified item.

Since:

BlackBerry 10.0.0

Q_SLOT void selectAll ()

Makes all items selected.

Does not cause signals to be emitted for individual items. Instead a single selectionChanged() is emitted with ListView::AllItems and true as parameters.

Since:

BlackBerry 10.0.0

Q_INVOKABLE QVariantList selected ()

Gets the index path of the selected item.

Return:

Index path of the first found selected item, or an empty QVariantList if no item is currently selected in this ListView.

Since:

BlackBerry 10.0.0

Q_INVOKABLE QVariantList selectionList ()

Gets a list of all selected items.

Return:

Returns a list of index paths for all the selected items. The returned list is of the type QVariantList so that it can be used in QML. Index paths are also QVariantList objects, so they can be used in QML. The returned object is a QVariantList containing other QVariantList objects (one such object for each selected item). The selection list is cleared when the MultiSelectHandler becomes inactive.

Since:

BlackBerry 10.0.0

Q_SLOT void setBufferedScrollingEnabled (
boolbufferedScrollingEnabled)

Sets the bufferedScrollingEnabled property to be used by this ListView.

Parameters
bufferedScrollingEnabled	The new value for the buffered scrolling property.

Since:

BlackBerry 10.0.0

Q_SLOT void setDataModel (
bb::cascades::DataModel *pDataModel)

Assigns a DataModel to this ListView.

This ListView will use the DataModel to populate itself with list items. If pDataModel has no parent, this ListView takes ownership of it and sets itself as parent to it (which means that ListView deletes it when ListView is deleted). Any previously set DataModel is unaffected by this call, its parent won't change, and it won't be deleted as a result of calling setDataModel().

Parameters
pDataModel	The DataModel to assign to this ListView.

See also:

dataModel(), resetDataModel()

Since:

BlackBerry 10.0.0

Q_SLOT void setFlickMode (
bb::cascades::FlickMode::Typemode)

Sets the flickMode to be used by the ListView.

Parameters
mode	The new flickMode to use.

See also:

flickMode(), resetFlickMode()

Since:

BlackBerry 10.0.0

Q_SLOT void setLayout (
bb::cascades::ListLayout *layout)

Sets a layout on the ListView.

Once completed, ownership of the layout is assigned to the ListView.

Parameters
layout	The layout to be set on the ListView.

Since:

BlackBerry 10.0.0

Q_SLOT void setLeadingVisual (
bb::cascades::VisualNode *pLeadingVisual)

Sets the leadingVisual property to be used by this ListView.

If pLeadingVisual has no parent, this ListView takes ownership of it and sets itself as parent to it (which means that ListView deletes it when ListView is deleted). Any previously set leading visual is unaffected by this call; its parent won't change and it won't be deleted as a result of calling setLeadingVisual().

Parameters
pLeadingVisual	The new leadingVisual.

See also:

leadingVisual(), resetLeadingVisual()

Since:

BlackBerry 10.0.0

Q_SLOT void setLeadingVisualSnapThreshold (
floatleadingVisualSnapThreshold)

Sets the leadingVisualSnapThreshold property to be used by this ListView.

Parameters
leadingVisualSnapThreshold	The new leadingVisualSnapThreshold.

Since:

BlackBerry 10.0.0

Q_SLOT void setListItemProvider (
bb::cascades::ListItemProvider *pItemProvider)

Assigns a ListItemProvider to this ListView.

This ListView will use ListItemProvider when it needs to create or update its list items. If pItemProvider has no parent, ListView takes ownership of it and sets itself as parent of it (which means that ListView deletes it when ListView is deleted). Any previously set ListItemProvider is unaffected by this call, its parent won't change, and it won't be deleted as a result of calling setListItemProvider().

Parameters
pItemProvider	The ListItemProvider to assign to this ListView.

Since:

BlackBerry 10.0.0

void setListItemTypeMapper (
ListItemTypeMapper *pItemTypeMapper)

Assigns a ListItemTypeMapper to this ListView.

If this ListView has a ListItemTypeMapper, it calls ListItemTypeMapper::itemType() instead of DataModel::itemType() whenever the type of an item is needed.

ListView does not take ownership of the supplied ListItemTypeMapper. Instead, the caller of this function is responsible for deleting the ListItemTypeMapper when it is no longer needed. This can be accomplished by implementing the ListItemTypeMapper as a QObject, and setting this ListView as parent.

Parameters
pItemTypeMapper	The ListItemTypeMapper to assign to this ListView.

Since:

BlackBerry 10.0.0

Q_SLOT void setMultiSelectAction (
bb::cascades::MultiSelectActionItem *multiSelectAction)

Sets the multiSelectAction to show in the context menu for the list items.

The ListView will take the ownership of the multi-select action, so actions cannot be shared. If the action already has a parent or if multiSelectAction is 0, nothing will happen.

Parameters
multiSelectAction	The multiSelectAction to set.

Since:

BlackBerry 10.0.0

Q_SLOT void setRootIndexPath (
const QVariantList &rootIndexPath)

Sets the rootIndexPath for the ListView when it references data in the DataModel.

The default value is an empty QVariantList, which causes this ListView to reference the top level of the DataModel.

Parameters
rootIndexPath	The rootIndexPath to use. See index paths for more information.

See also:

rootIndexPath(), resetRootIndexPath()

Since:

BlackBerry 10.0.0

Q_SLOT void setScrollIndicatorMode (
bb::cascades::ScrollIndicatorMode::Typemode)

Sets a value for the property ListView::scrollIndicatorMode.

Parameters
mode	The new value for the property.

Since:

BlackBerry 10.0.0

Q_SLOT void setScrollRole (
bb::cascades::ScrollRole::TypescrollRole)

Sets the ListView scrollRole.

Signal scrollRoleChanged() is emitted if value is changed.

Parameters
scrollRole	Specifies a control's ScrollRole value.

Since:

BlackBerry 10.1.0

Q_INVOKABLE void setScrollStops (
const QVariantList &indexPaths)

Sets the scrollStops index paths for the list.

Scrolling in the list will stop at the positions of the items located at the given index paths.

When items are added or removed in the list, the server will internally compensate by modifying the index paths to match the original items. As a result, the original list of index paths might differ from the actual one used on the server. In order to make changes in the list of stop items, it is recommended to first aquire it by using scrollStops() and make any modifications accordingly, rather than keeping the list that was originally passed to this function.

Here's a C++ example of setting two scroll stops on index path 0,2 and 2,2:

 QVariantList stopIndexPaths, firstStop, secondStop;
 firstStop << 0 << 2;
 secondStop << 2 << 2;
 stopIndexPaths.push_back(firstStop);
 stopIndexPaths.push_back(secondStop);

 mListView->setScrollStops(stopIndexPaths);

Here's how to set the same scroll stops in QML:

 setScrollStops([[0, 2], [2, 2]]);

The list will not make any compensation when signal DataModel::itemsChanged is received. In this case the client itself needs to provide an updated list of index paths.

Parameters
indexPaths	The list of index paths specifying the items to use as scroll stop points. This list is a nested QVariantList, i.e. each element of the list is in itself a QVariantList representing the index paths. Passing an empty list will remove all stop points. See index paths for more information.

See also:

scrollStops()

Since:

BlackBerry 10.0.0

Q_SLOT void setSnapMode (
bb::cascades::SnapMode::Typemode)

Sets the snapMode to be used by the ListView.

Parameters
mode	The new snapMode to use.

See also:

snapMode(), resetSnapMode()

Since:

BlackBerry 10.0.0

Q_SLOT void setStickToEdgePolicy (
bb::cascades::ListViewStickToEdgePolicy::Typepolicy)

Sets the stickToEdgePolicy to be used by this ListView.

Parameters
policy	The new stickToEdgePolicy policy to use.

Since:

BlackBerry 10.1.0

bb::cascades::SnapMode::Type snapMode ()

Gets the snapMode used by the ListView.

Return:

The snapMode currently used by the ListView.

See also:

setSnapMode(), resetSnapMode()

Since:

BlackBerry 10.0.0

bb::cascades::ListViewStickToEdgePolicy::Type stickToEdgePolicy ()

Gets the stickToEdgePolicy used by this ListView.

Return:

The stickToEdgePolicy currently used by this ListView.

Since:

BlackBerry 10.1.0

Q_SLOT void toggleSelection (
const QVariantList &indexPath)

Toggles selection on an item.

If the item is selected, it becomes deselected. If the item is deselected, it becomes selected.

After the selection is toggled, the signal selectionChanged() is emitted.

Parameters
indexPath	Specifies an item in the DataModel connected to this ListView. See index paths for more information.

Since:

BlackBerry 10.0.0

bb::cascades::AbstractA11yObject * accessibility ()

Returns the accessibility object.

Return:

The accessibility object.

bb::cascades::A11yMode::Type accessibilityMode ()

Return the current value of the accessibilityMode property.

Return:

The A11yMode of the control.

Since:

BlackBerry 10.2.0

ActionSet * actionSetAt (
intindex)

Returns an ActionSet at a specified index.

Ownership of the ActionSet object remains with the control.

See also:

Control::contextActions

Parameters
index	The index of the ActionSet.

Return:

The requested ActionSet if the index was valid, 0 otherwise.

Since:

BlackBerry 10.0.0

int actionSetCount ()

Returns the number of ActionSet objects.

See also:

Control::contextActions

Return:

The number of ActionSet objects.

Since:

BlackBerry 10.0.0

void addActionSet (
bb::cascades::ActionSet *actionSet)

Adds an ActionSet to the control.

The control takes ownership of the ActionSet object, since ActionSet objects should not typically be shared. If the ActionSet is 0 or it already belongs to the control, the action set is not added. Once completed, the actionSetAdded() signal is emitted.

See also:

Control::contextActions

Parameters
actionSet	The ActionSet to add to the Control.

Since:

BlackBerry 10.0.0

void addAnimation (
AbstractAnimation *animation)

Adds an animation to the visual node.

Parameters
animation	The animation to add. The ownership of the added animation will be transferred to the visual node. If the added animation was previously added to another visual node, it will be removed from that node and added to (and owned by) this node.

See also:

removeAnimation(), removeAllAnimation(), animationCount(), animationAt()

Since:

BlackBerry 10.0.0

Q_INVOKABLE void addEffect (
bb::cascades::AbstractEffect *effect)

Adds an effect to the visual node.

Parameters
effect	The effect to add. The ownership of the added effect will be transferred to the visual node. If the effect was previously assigned to a different node, ownership is transferred to the new node.

See also:

removeEffect()

Since:

BlackBerry 10.3.1

void addEventHandler (
AbstractEventHandler *eventHandler)

Adds an event handler to the visual node.

Parameters
eventHandler	The event handler to add. The ownership of the added event handler will be transferred to the visual node. If the added event handler was previously added to another visual node, it will be removed from that node and added to (and owned by) this node.

See also:

removeEventHandler(), removeAllEventHandlers(), bb::cascades::EventHandler

Since:

BlackBerry 10.3.0

void addGestureHandler (
GestureHandler *gestureHandler)

Adds a gesture handler to the visual node.

For example usage, refer to documentation of bb::cascades::GestureHandler.

Parameters
gestureHandler	The gesture handler to add. The ownership of the added gesture handler will be transferred to the visual node. If the added gesture handler was previously added to another visual node, it will be removed from that node and added to (and owned by) this node.

Since:

BlackBerry 10.0.0

Q_INVOKABLE void addKeyListener (
bb::cascades::KeyListener *keyListener)

Adds a key listener to the Control.

The Control will always take ownership as a key listener should never be shared. If the key listener already belongs to the Control or the key listener is 0, nothing will happen.

Parameters
keyListener	The KeyListener to add to the Control.

Since:

BlackBerry 10.1.0

Q_INVOKABLE void addShortcut (
bb::cascades::AbstractShortcut *shortcut)

Adds a shortcut to the Control.

The Control will always take ownership as shortcuts should never be shared. If the shortcut already belongs to the Control or the shortcut is 0, nothing will happen. The order in which shortcuts are added will determine which shortcut will be triggered in case of an overlap.

Parameters
shortcut	The AbstractShortcut to add to the Control.

Since:

BlackBerry 10.1.0

void addTouchBehavior (
TouchBehavior *touchBehavior)

Adds a touch behavior to the visual node.

Multiple behaviors can be added, they will get evaluated in parallel.

For example usage, refer to documentation of bb::cascades::TouchBehavior.

Parameters
touchBehavior	The touch behavior to add. The ownership of the added touch behavior will be transferred to the visual node. If the added touch behavior was previously added to another visual node, it will be removed from that node and added to (and owned by) this node.

See also:

removeTochBehavior(), removeAllTouchBehaviors(), bb::cascades::TouchBehavior

Since:

BlackBerry 10.0.0

AbstractAnimation * animationAt (
intindex)

Returns an animation added at a specified index.

This function, together with animationCount(), is used for iterating over all animations:

 for (int i = 0; i < animationCount(); ++i) {
     AbstractAnimation* animation = animationAt(i);
     ...
 }

See also:

animationCount()

Parameters
index	The index of the animation to retrieve. It must in the range of [ 0, animationCount() [, otherwise the function will return 0;

Return:

The animation at the specified index; 0 if the index was out of range. The ownership is not changed by this call.

Since:

BlackBerry 10.0.0

int animationCount ()

Returns the number of animations added to the visual node.

This function, together with animationAt(), is used for iterating over all animations:

 for (int i = 0; i < animationCount(); ++i) {
     AbstractAnimation* animation = animationAt(i);
     ...
 }

See also:

animationAt()

Return:

The number of animations added to the visual node.

Since:

BlackBerry 10.0.0

float bottomMargin ()

Returns the bottomMargin for the control.

Return:

The bottom margin for the control.

Since:

BlackBerry 10.0.0

float bottomPadding ()

Returns the bottom padding on the control.

Return:

The bottom padding.

Since:

BlackBerry 10.0.0

Q_INVOKABLE bool builtInShortcutsEnabled ()

Returns an builtInShortcutsEnabled property value.

Return:

true if builtInShortcutsEnabled property is set to true and false otherwise

Since:

BlackBerry 10.2.0

bb::cascades::ContextMenuHandler * contextMenuHandler ()

Return:

The ContextMenuHandler that was set or 0 if no handler was set.

Since:

BlackBerry 10.0.0

Q_INVOKABLE void disableAllShortcuts ()

Disables all shortcuts attached to the Control.

Shortcuts that are attached afterward will use the default enabled state.

Since:

BlackBerry 10.1.0

Q_INVOKABLE void enableAllShortcuts ()

Enables all shortcuts attached to the Control.

Since:

BlackBerry 10.1.0

virtual bool event (
QEvent *event)

Overloaded to implement the event mechanism in Cascades.

Warning!

If this function is overridden, it must be called by the derived class for events to work properly in Cascades.

Parameters
event	The received event.

Return:

True if the received event was recognized and processed, false otherwise.

Since:

BlackBerry 10.0.0

bb::cascades::FocusAutoShow::Type focusAutoShow ()

Returns the focusAutoShow property of the control.

Return:

The focusAutoShow state of the control

Since:

BlackBerry 10.0.0

bb::cascades::FocusPolicy::Type focusPolicy ()

Returns the focusPolicy property of the control.

Return:

The focusPolicy state of the control as a FocusPolicy

Since:

BlackBerry 10.0.0

bb::cascades::FocusRetentionPolicy::Types focusRetentionPolicyFlags ()

Gets the focus retention policy.

The policy describes under which condtions the control will lose focus

Return:

The focus retention policy for this control.

Since:

BlackBerry 10.0.0

bb::cascades::HorizontalAlignment::Type horizontalAlignment ()

Returns the horizontal alignment for the control.

Return:

The horizontal alignment for the control.

Since:

BlackBerry 10.0.0

bool implicitLayoutAnimationsEnabled ()

Return the current value of the implicitLayoutAnimationsEnabled property.

Return:

If true layout changes will implicitely trigger animations, if false the animations are disabled.

Since:

BlackBerry 10.0.0

bb::cascades::InputRouteProperties * inputRoute ()

Returns the input route properties object.

Return:

The input route properties object.

Since:

BlackBerry 10.1.0

bool isBottomMarginSet ()

Indicates whether the bottomMargin of the control is set.

Return:

true if the bottom margin is set, false otherwise.

Since:

BlackBerry 10.0.0

bool isEnabled ()

Returns the enabled state of the control.

Return:

true if the control is enabled, false otherwise.

Since:

BlackBerry 10.0.0

bool isFocused ()

Returns the focused state of the control.

Return:

true if the control is focused, false otherwise.

Since:

BlackBerry 10.0.0

bool isLeftMarginSet ()

Indicates whether the leftMargin of the control is set.

Return:

true if the left margin is set, false otherwise.

Since:

BlackBerry 10.0.0

bool isLocallyFocused ()

Returns the locallyFocused state of the control.

Return:

true if the controls locallyFocused property is set, false otherwise.

Since:

BlackBerry 10.3.1

bool isPreferredHeightSet ()

Indicates whether the preferredHeight of the control is set.

Return:

true if the preferred height is set, false otherwise.

Since:

BlackBerry 10.0.0

bool isPreferredWidthSet ()

Indicates whether the preferredWidth of the control is set.

Return:

true if the preferred width is set, false otherwise.

Since:

BlackBerry 10.0.0

bool isRightMarginSet ()

Indicates whether the rightMargin of the control is set.

Return:

true if the right margin is set, false otherwise.

Since:

BlackBerry 10.0.0

bool isTopMarginSet ()

Indicates whether the topMargin of the control is set.

Return:

true if the top margin is set, false otherwise.

Since:

BlackBerry 10.0.0

bool isVisible ()

Checks whether the visual node is visible or not.

If the visible property is set to false, the visual node is neither laid out nor rendered. The default visible value is true.

Since:

BlackBerry 10.0.0

Return:

true if the visual node is visible, false otherwise.

Since:

BlackBerry 10.0.0

Q_INVOKABLE bb::cascades::KeyListener * keyListenerAt (
intindex)

Returns a key listener at the specified index.

Ownership of the key listener remains with the Control.

Parameters
index	The index of the key listener.

Return:

The requested key listener if the index was valid, 0 otherwise.

Since:

BlackBerry 10.1.0

Q_INVOKABLE int keyListenerCount ()

Returns the number of key listeners.

Return:

The number of key listeners.

Since:

BlackBerry 10.1.0

bb::cascades::LayoutProperties * layoutProperties ()

Returns the LayoutProperties object for the control.

Ownership of the LayoutProperties object remains unchanged.

Return:

The layout properties for the control.

Since:

BlackBerry 10.0.0

float leftMargin ()

Returns the leftMargin for the control.

Return:

The left margin for the control.

Since:

BlackBerry 10.0.0

float leftPadding ()

Returns the left padding on the control.

Return:

The left padding.

Since:

BlackBerry 10.0.0

Q_SLOT void loseFocus ()

Called when the control should lose its focus.

If succeeded, the focusedChanged() signal is emitted with false as its parameter.

Since:

BlackBerry 10.0.0

bb::cascades::Spacings * margin ()

Returns the margin group property for the control.

Return:

The margin property for the control.

Since:

BlackBerry 10.3.0

float maxHeight ()

Returns the maxHeight of the control.

Return:

The maximum height of the control.

Since:

BlackBerry 10.0.0

float maxWidth ()

Returns the maxWidth of the control.

Return:

The maximum width of the control.

Since:

BlackBerry 10.0.0

float minHeight ()

Returns the minHeight of the control.

Return:

The minimum height of the control.

Since:

BlackBerry 10.0.0

float minWidth ()

Returns the minWidth of the control.

Return:

The minimum width of the control.

Since:

BlackBerry 10.0.0

float opacity ()

Returns the opacity of the visual node.

A value between 0.0 (transparent) and 1.0 (opaque). This is the local opacity of the visual node, i.e. not taking the ancestor opacities into account. The default opacity is 1.0 (opaque).

Since:

BlackBerry 10.0.0

Return:

A value between between 0.0 (transparent) and 1.0 (opaque).

Since:

BlackBerry 10.0.0

bb::cascades::OverlapTouchPolicy::Type overlapTouchPolicy ()

Returns the overlap touch policy for the visual node.

Note:

The policy has no effect if propagation mode is TouchPropagationMode::None for the same visual node.

The default policy is OverlapTouchPolicy::Deny.

Since:

BlackBerry 10.0.0

Return:

The overlap touch policy for the visual node.

Since:

BlackBerry 10.0.0

float pivotX ()

Returns the position of pivot point of the visual node along the x-axis.

Since:

BlackBerry 10.0.0

Return:

The position of pivot point along the x-axis, relative to the center of the visual node.

Since:

BlackBerry 10.0.0

float pivotY ()

Returns the position of pivot point of the visual node along the y-axis.

Since:

BlackBerry 10.0.0

Return:

The position of pivot point along the y-axis, relative to the center of the visual node.

Since:

BlackBerry 10.0.0

float preferredHeight ()

Returns the preferredHeight of the control.

To check whether the preferred height is set for a control, call isPreferredHeightSet().

Return:

The preferred height of a control as a positive number, or 0 if the preferred width is not set.

Since:

BlackBerry 10.0.0

float preferredWidth ()

Returns the preferredWidth of the control.

To check whether the preferred width is set for the control, call isPreferredWidthSet().

Return:

The preferred width of a control as a positive number, or 0 if the preferred width is not set.

Since:

BlackBerry 10.0.0

bool removeActionSet (
bb::cascades::ActionSet *actionSet)

Removes an ActionSet from the control.

Once the ActionSet is removed, the control no longer references it, but it is still owned by the control. It is up to the application to either delete the removed ActionSet, transfer its ownership (by setting its parent) to another object or leave it as a child of the control (in which case it will be deleted with the control).

Once completed, the actionSetRemoved() signal is emitted.

See also:

Control::contextActions

Parameters
actionSet	The actionSet to remove.

Return:

true if the ActionSet was owned by the Control, false otherwise.

Since:

BlackBerry 10.0.0

void removeAllActionSets ()

Removes all ActionSet objects from the control and deletes them.

Once completed, the actionSetRemoved() signal is emitted with 0 as its parameter.

See also:

Control::contextActions

Since:

BlackBerry 10.0.0

void removeAllAnimations ()

Convenience function for removing and deleting all animations added to the visual node.

All animations added to the visual node will be removed and deleted.

Since:

BlackBerry 10.0.0

void removeAllEventHandlers ()

Removes and deletes all event handlers currently added to this visual node.

See also:

removeEventHandler(), addEventHandler()

Since:

BlackBerry 10.3.0

void removeAllGestureHandlers ()

Removes and deletes all gesture handlers currently added to this visual node.

Since:

BlackBerry 10.0.0

Q_INVOKABLE void removeAllKeyListeners ()

Removes all of a Control's key listeners and frees up their memory.

Since:

BlackBerry 10.1.0

Q_INVOKABLE void removeAllShortcuts ()

Removes all of a control's shortcuts and frees up their memory.

Since:

BlackBerry 10.1.0

void removeAllTouchBehaviors ()

Removes and deletes all touch behaviors currently added to this visual node.

Since:

BlackBerry 10.0.0

bool removeAnimation (
AbstractAnimation *animation)

Removes an animation from the visual node.

Once the animation is removed, the visual node no longer references it, but it is still owned by the visual node. It is up to the application to either delete the removed animation, transfer its ownership (by setting its parent) to another object or leave it as a child of the visual node (in which case it will be deleted with the visual node).

Here is an example on how to remove and delete all animations added to the visual node:

 for (int i = 0; i < animationCount(); ++i) {
     AbstractAnimation* animation = animationAt(i);
     removeAnimation(animation);
     delete animation;
 }

See also:

removeAllAnimation(), animationCount(), animationAt(), addAnimation()

Parameters
animation	The animation to remove.

Return:

Returns False of the animation to remove wasn't added to the visual node or if the animation was 0, true otherwise.

Since:

BlackBerry 10.0.0

Q_INVOKABLE void removeEffect (
bb::cascades::AbstractEffect *effect)

Removes an effect from the visual node.

Parameters
effect	The effect to remove. The ownership of the effect will remain with the node until the effect is either deleted or set as an effect on another node.

See also:

addEffect()

Since:

BlackBerry 10.3.1

bool removeEventHandler (
AbstractEventHandler *eventHandler)

Removes a event handler from the visual node.

Once the event handler is removed, the visual node no longer references it, but it is still owned by the visual node. It is up to the application to either delete the removed event handler, transfer its ownership (by setting its parent) to another object or leave it as a child of the visual node (in which case it will be deleted with the visual node).

Parameters
eventHandler	The event handler to remove.

Return:

false if the event handler to remove wasn't removed from the visual node or if the event handler was 0, true otherwise.

Since:

BlackBerry 10.3.0

bool removeGestureHandler (
GestureHandler *gestureHandler)

Removes a gesture handler from the visual node.

Once the gesture handler is removed, the visual node no longer references it, but it is still owned by the visual node. It is up to the application to either delete the removed gesture handler, transfer its ownership (by setting its parent) to another object or leave it as a child of the visual node (in which case it will be deleted with the visual node).

Parameters
gestureHandler	The gesture handler to remove.

Return:

false if the gesture handler to remove wasn't removed from the visual node or if the gesture handler was 0, true otherwise.

Since:

BlackBerry 10.0.0

Q_INVOKABLE bool removeKeyListener (
bb::cascades::KeyListener *keyListener)

Removes a key listener from the Control.

Once the key listener is removed, the Control no longer references it, but it is still owned by the Control. It is up to the application to either delete the removed key listener, transfer its ownership (by setting its parent) to another object, or leave it as a child of the Control (in which case it will be deleted with the Control).

Parameters
keyListener	The KeyListener to remove.

Return:

true if the key listener was owned by the Control, false otherwise.

Since:

BlackBerry 10.1.0

Q_INVOKABLE bool removeShortcut (
bb::cascades::AbstractShortcut *shortcut)

Removes a shortcut from the Control.

Once the shortcut is removed, the Control no longer references it, but it is still owned by the Control. It is up to the application to either delete the removed shortcut, transfer its ownership (by setting its parent) to another object, or leave it as a child of the Control (in which case it will be deleted with the Control).

Parameters
shortcut	The AbstractShortcut to remove.

Return:

true if the shortcut was owned by the Control, false otherwise.

Since:

BlackBerry 10.1.0

bool removeTouchBehavior (
TouchBehavior *touchBehavior)

Removes a touch behavior from the visual node.

Once the touch behavior is removed, the visual node no longer references it, but it is still owned by the visual node. It is up to the application to either delete the removed touch behavior, transfer its ownership (by setting its parent) to another object or leave it as a child of the visual node (in which case it will be deleted with the visual node).

Parameters
touchBehavior	The touch behavior to remove.

Return:

Returns False if the touch behavior to remove wasn't removed from the visual node or if the touch behavior was 0, true otherwise.

See also:

removeAllTouchBehaviors()

Since:

BlackBerry 10.0.0

Q_SLOT void requestFocus ()

Requests focus to this control.

When requesting focus for a control, you must ensure that the control is currently a part of the scene.

A common use case for requesting focus is when a new Page is loaded into the scene. For example, on a page that requires text input from the user, you might want to request focus on a TextField as soon as the page loads so that the keyboard is automatically displayed. In this scenario, the natural assumption might be to request focus within the page's BaseObject::creationCompleted() signal, which is emitted once the object's construction is complete. However, this approach is incorrect. Even though the object has been created, it has not yet been added to the UI tree, so the call would fail.

Here are two different methods that you can use for requesting focus. The first method involves listening for changes to the Application::scene property. Here's a .qml file called RequestFocusPage.qml, which contains a TextField that you want to request focus for as soon as the page loads. The page contains a variant property that is bound to the application's scene property. When you declare a variable in QML, a value-change signal is implicitly created as well. So, whenever this page gets added to the scene, the onAppSceneChanged() signal handler is called where it's safe to request focus for the control.

import bb.cascades 1.2

Page {
    property variant appScene: Application.scene
    Container {
        TextArea {
            id: theTextArea
            text: "Give me focus!"
        }
    }
    onAppSceneChanged: {
        // This triggers focus if the application scene is set to
        // this QML Page.
        theTextArea.requestFocus();
    }
}

The second method involves using a ComponentDefinition to load the pages. Here's another version called RequestFocusPage2.qml. It contains a Boolean property called readyForFocus which is initialized to false. When the value changes, the onreadyForFocusChanged() signal handler is called and focus is requested.

import bb.cascades 1.2

Page {
    property bool readyForFocus: false
    Container {
        TextArea {
            id: theTextArea
            text: "I want some focus too!"
        }
    }
    onReadyForFocusChanged: {
        if (readyForFocus) {
            // This triggers focus if the Page is created using a
            // ComponentDefinition.
            theTextArea.requestFocus();
        }
    }
}

Here's how you can create the Page and set the readyForFocus property from a ComponentDefinition in a NavigationPane:

import bb.cascades 1.2

NavigationPane {
    id: nav
    RequestFocusPage {
        actions: ActionItem {
            ActionBar.placement: ActionBarPlacement.OnBar
            title: "Navigate"
            onTriggered: {
                var page = refocusPage.createObject();
                nav.push(page);

                // Here it is ok to trigger the focus request since the page is added to
                // the UI tree as it is pushed to the NavigationPane.
                page.readyForFocus = true;
            }
        }
    }
    attachedObjects: ComponentDefinition {
        id: refocusPage
        source: "RequestFocusPage2.qml"
    }
    onPopTransitionEnded: {
        page.destroy()
    }
}

If succeeded, the focusedChanged() signal is emitted with true as its parameter.

Since:

BlackBerry 10.0.0

Q_SLOT void resetAccessibilityMode ()

Resets the accessibilityMode property to its default value of Default.

Since:

BlackBerry 10.2.0

Q_SLOT void resetBottomMargin ()

Resets the bottomMargin.

Since:

BlackBerry 10.0.0

Q_SLOT void resetBottomPadding ()

Resets the bottom padding to its default.

The default bottom padding is 0.

After the padding is reset, the bottomPaddingChanged() signal is emitted.

Since:

BlackBerry 10.0.0

Q_INVOKABLE void resetBuiltInShortcutsEnabled ()

Resets an builtInShortcutsEnabled property to default value.

Default value is true.

Since:

BlackBerry 10.2.0

Q_SLOT void resetContextMenuHandler ()

Resets the contextMenuHandler property to the default value of 0.

Removes the ContextMenuHandler from this control by resetting it to 0.

Since:

BlackBerry 10.0.0

Q_SLOT void resetEnabled ()

Resets the enabled state of the control to true.

Since:

BlackBerry 10.0.0

Q_SLOT void resetFocusAutoShow ()

Resets the focusAutoShow to its default value.

Since:

BlackBerry 10.0.0

Q_SLOT void resetFocusPolicy ()

Resets the focusPolicy to its default value of FOCUSPOLICY_NONE.

Since:

BlackBerry 10.0.0

Q_SLOT void resetFocusRetentionPolicyFlags ()

Reset the focus retention policy to default value.

Since:

BlackBerry 10.0.0

Q_SLOT void resetHorizontalAlignment ()

Resets the horizontal alignment to its default.

The default alignment is HorizontalAlignment::Left.

After the horizontal alignment is reset, the horizontalAlignmentChanged() signal is emitted.

Since:

BlackBerry 10.0.0

Q_SLOT void resetImplicitLayoutAnimationsEnabled ()

Resets the implicitLayoutAnimationsEnabled property to its default value.

Since:

BlackBerry 10.0.0

Q_SLOT void resetLayoutProperties ()

Resets the layoutProperties for the control to 0 (automatic selection of LayoutProperties).

Since:

BlackBerry 10.0.0

Q_SLOT void resetLeftMargin ()

Resets the leftMargin.

Since:

BlackBerry 10.0.0

Q_SLOT void resetLeftPadding ()

Resets the left padding to its default.

The default left padding is 0.

After the padding is reset, the leftPaddingChanged() signal is emitted.

Since:

BlackBerry 10.0.0

Q_SLOT void resetLocallyFocused ()

Resets the locallyFocused to its default value.

Since:

BlackBerry 10.3.1

Q_SLOT void resetMaxHeight ()

Resets the maxHeight of the control.

Since:

BlackBerry 10.0.0

Q_SLOT void resetMaxWidth ()

Resets the maxWidth of the control.

Since:

BlackBerry 10.0.0

Q_SLOT void resetMinHeight ()

Resets the minHeight of the control.

Since:

BlackBerry 10.0.0

Q_SLOT void resetMinWidth ()

Resets the minWidth of the control.

Since:

BlackBerry 10.0.0

Q_SLOT void resetOpacity ()

Resets the opacity of the visual node to 1.0 (opaque).

A value between 0.0 (transparent) and 1.0 (opaque). This is the local opacity of the visual node, i.e. not taking the ancestor opacities into account. The default opacity is 1.0 (opaque).

Since:

BlackBerry 10.0.0

Since:

BlackBerry 10.0.0

Q_SLOT void resetOverlapTouchPolicy ()

Resets the overlap touch policy for the visual node to OverlapTouchPolicy::Deny.

Note:

The policy has no effect if propagation mode is TouchPropagationMode::None for the same visual node.

The default policy is OverlapTouchPolicy::Deny.

Since:

BlackBerry 10.0.0

Since:

BlackBerry 10.0.0

Q_SLOT void resetPivot ()

Convenience function for resetting the position of pivot point to 0.0 (center of node) along all axes.

Since:

BlackBerry 10.0.0

See also:

resetPivotX(), resetPivotY()

Since:

BlackBerry 10.0.0

Q_SLOT void resetPivotX ()

Resets the position of pivot point of the visual node along the x-axis to 0.0 (center of node).

Since:

BlackBerry 10.0.0

See also:

resetPivot()

Since:

BlackBerry 10.0.0

Q_SLOT void resetPivotY ()

Resets the position of pivot point of the visual node along the y-axis to 0.0 (center of node).

Since:

BlackBerry 10.0.0

See also:

resetPivot()

Since:

BlackBerry 10.0.0

Q_SLOT void resetPreferredHeight ()

Resets the preferredHeight to its default value of 0.

See also:

resetPreferredSize()

Since:

BlackBerry 10.0.0

Q_SLOT void resetPreferredSize ()

Resets the preferred width and height of the control.

A convenience function for resetting both the preferred width and height. It is equivalent to calling both resetPreferredWidth() and resetPreferredHeight().

Since:

BlackBerry 10.0.0

Q_SLOT void resetPreferredWidth ()

Resets the preferredWidth to its default value of 0.

See also:

resetPreferredSize()

Since:

BlackBerry 10.0.0

Q_SLOT void resetRightMargin ()

Resets the rightMargin.

Since:

BlackBerry 10.0.0

Q_SLOT void resetRightPadding ()

Resets the right padding to its default.

The default right padding is 0.

After the padding is reset, the rightPaddingChanged() signal is emitted.

Since:

BlackBerry 10.0.0

Q_SLOT void resetRotationZ ()

Resets the rotation of the visual node around the z-axis to 0.0 degrees.

The visual node is rotated around the z-axis, centered around a pivot point defined by the components pivotX, pivotY and pivotZ. The default rotation is 0.0 degrees.

Since:

BlackBerry 10.0.0

See also:

resetRotation()

Since:

BlackBerry 10.0.0

Q_SLOT void resetScale ()

Resets the scale factor for all axis to 1.0 (no scaling).

See also:

resetScaleX(), resetScaleY()

Since:

BlackBerry 10.0.0

Q_SLOT void resetScaleX ()

Resets the scale factor of the visual node along the x-axis to 1.0 (no scaling).

The visual node is scaled along the x-axis, centered around a pivot point defined by the components pivotX, pivotY and pivotZ. The default scale factor is 1.0 (not scaled).

Since:

BlackBerry 10.0.0

See also:

resetScale()

Since:

BlackBerry 10.0.0

Q_SLOT void resetScaleY ()

Resets the scale factor of the visual node along the y-axis to 1.0 (no scaling).

The visual node is scaled along the y-axis, centered around a pivot point defined by the components pivotX, pivotY and pivotZ. The default scale factor is 1.0 (not scaled).

Since:

BlackBerry 10.0.0

See also:

resetScale()

Since:

BlackBerry 10.0.0

Q_SLOT void resetTopMargin ()

Resets the topMargin.

Since:

BlackBerry 10.0.0

Q_SLOT void resetTopPadding ()

Resets the top padding to its default.

The default top padding is 0.

After the padding is reset, the topPaddingChanged() signal is emitted.

Since:

BlackBerry 10.0.0

Q_SLOT void resetTouchPropagationMode ()

Resets the touch propagation mode for the visual node to TouchPropagationMode::Full.

This property controls how the visual node and its subtree partakes in touch event propagation. There are three possible modes, as defined by TouchPropagationMode::Type:

TouchPropagationMode::Full means that touch events will be fully propagated to the visual node and it's subtree.
TouchPropagationMode::None means no touch events will be propagated to the visual node or its subtree. The subtree is practically invisible to the touch system.
TouchPropagationMode::PassThrough means touch events will not be handled by the visual node itself, but its subtree will get touch events as usual.

TouchPropagationMode::None can be used as an optimization if you have complex, non-interactive content, that overlaps interactive controls.

The default propagation mode is TouchPropagationMode::Full.

Since:

BlackBerry 10.0.0

Since:

BlackBerry 10.0.0

Q_SLOT void resetTranslation ()

Convenience function for resetting the translation along all axes.

The translationX and translationY correspond to pixels as long as the translationZ is 0.0.

See also:

Layout for more details.

Since:

BlackBerry 10.0.0

Since:

BlackBerry 10.0.0

Q_SLOT void resetTranslationX ()

Resets the translation of the visual node to 0.0 along the x-axis.

The translationX and translationY correspond to pixels as long as the translationZ is 0.0.

See also:

Layout for more details.

Since:

BlackBerry 10.0.0

See also:

resetTranslation()

Since:

BlackBerry 10.0.0

Q_SLOT void resetTranslationY ()

Resets the translation of the visual node to 0.0 along the y-axis.

The translationX and translationY correspond to pixels as long as the translationZ is 0.0.

See also:

Layout for more details.

Since:

BlackBerry 10.0.0

See also:

resetTranslation()

Since:

BlackBerry 10.0.0

Q_SLOT void resetVerticalAlignment ()

Resets the vertical alignment to its default.

The default alignment is VerticalAlignment::Top.

After the vertical alignment is reset, the verticalAlignmentChanged() signal is emitted.

Since:

BlackBerry 10.0.0

Q_SLOT void resetVisible ()

Resets the visual node to be visible.

If the visible property is set to false, the visual node is neither laid out nor rendered. The default visible value is true.

Since:

BlackBerry 10.0.0

Since:

BlackBerry 10.0.0

float rightMargin ()

Returns the rightMargin for the control.

Return:

The right margin for the control.

Since:

BlackBerry 10.0.0

float rightPadding ()

Returns the right padding on the control.

Return:

The right padding.

Since:

BlackBerry 10.0.0

float rotationZ ()

Returns the rotation of the visual node around the z-axis.

The visual node is rotated around the z-axis, centered around a pivot point defined by the components pivotX, pivotY and pivotZ. The default rotation is 0.0 degrees.

Since:

BlackBerry 10.0.0

Return:

The rotation around the z-axis in degrees.

Since:

BlackBerry 10.0.0

float scaleX ()

Returns the scale factor of the visual node along the x-axis.

The visual node is scaled along the x-axis, centered around a pivot point defined by the components pivotX, pivotY and pivotZ. The default scale factor is 1.0 (not scaled).

Since:

BlackBerry 10.0.0

Return:

The scale factor along the x-axis.

Since:

BlackBerry 10.0.0

float scaleY ()

Returns the scale factor of the visual node along the y-axis.

The visual node is scaled along the y-axis, centered around a pivot point defined by the components pivotX, pivotY and pivotZ. The default scale factor is 1.0 (not scaled).

Since:

BlackBerry 10.0.0

Return:

The scale factor along the y-axis.

Since:

BlackBerry 10.0.0

Q_SLOT void setAccessibilityMode (
bb::cascades::A11yMode::TypeaccessibilityMode)

Controls how the control is exposed to assistive technologies.

Parameters
accessibilityMode	The A11yMode to set on the control

Since:

BlackBerry 10.2.0

Q_SLOT void setBottomMargin (
floatbottomMargin)

Sets the bottomMargin for the control.

Parameters
bottomMargin	The bottom margin for control; must be greater than or equal to 0.0.

Since:

BlackBerry 10.0.0

Q_SLOT void setBottomPadding (
floatbottomPadding)

Sets the bottom padding for the control.

After the padding is set, the bottomPaddingChanged() signal is emitted.

Parameters
bottomPadding	The new left padding.

Since:

BlackBerry 10.0.0

Q_INVOKABLE void setBuiltInShortcutEnabled (
bb::cascades::SystemShortcuts::Typetype,
boolenabled )

Sets the enabled state of the built-in shortcut attached to the Control at a system level.

Built-in Shortcuts that are attached afterward will use the specified enabled state.

Note:

Selected Built-In shortcut can be enabled or disabled only if Control::builtInShortcutsEnabled property is set to true.

Parameters
type	The system shortcut type
enabled	If true the shortcut is enabled, and if false the shortcut is disabled.

Since:

BlackBerry 10.2.0

Q_SLOT void setBuiltInShortcutsEnabled (
boolenabled)

Sets the enabled state of all built-in shortcuts attached to the Control at a system level.

Built-in Shortcuts that are attached afterward will use the specified enabled state.

Parameters
enabled	If true all built-in shortcuts are enabled, and if false all built-in shortcut are disabled.

Since:

BlackBerry 10.2.0

void setContextMenuHandler (
bb::cascades::ContextMenuHandler *contextMenuHandler)

Sets the ContextMenuHandler for this Control.

The control takes ownership of the ContextMenuHandler object. Once completed, the contextMenuHandlerChanged() signal is emitted. The replaced context menu handler (if one was set) remains owned by the control.

Parameters
contextMenuHandler	The ContextMenuHandler to set or 0 to remove currently set ContextMenuHandler.

Since:

BlackBerry 10.0.0

Q_SLOT void setEnabled (
boolenabled)

Sets the enabled state of the control.

Parameters
enabled	If true the control is enabled and if false the control is disabled.

Since:

BlackBerry 10.0.0

Q_SLOT void setFocusAutoShow (
const bb::cascades::FocusAutoShow::TypefocusAutoShow)

Sets the focusAutoShow of the control.

Parameters
focusAutoShow	The focusAutoShow state of the Control.

Since:

BlackBerry 10.0.0

Q_SLOT void setFocusPolicy (
const bb::cascades::FocusPolicy::TypefocusPolicy)

Sets the focusPolicy of the control.

Parameters
focusPolicy	The focusPolicy state of the Control as a FocusPolicy.

See also:

FocusPolicy

Since:

BlackBerry 10.0.0

Q_SLOT void setFocusRetentionPolicyFlags (
bb::cascades::FocusRetentionPolicy::Typespolicy)

Sets the focus retention policy.

The policy describes under which condtions the control will lose focus.

Parameters
policy	The new policy.

Since:

BlackBerry 10.0.0

Q_SLOT void setHorizontalAlignment (
bb::cascades::HorizontalAlignment::TypehorizontalAlignment)

Sets the horizontal alignment for the control.

After the horizontal alignment is set, the horizontalAlignmentChanged() signal is emitted.

Parameters
horizontalAlignment	The horizontal alignment for the control.

Since:

BlackBerry 10.0.0

Q_SLOT void setImplicitLayoutAnimationsEnabled (
boolenable)

Controls whether layout changes trigger automatic animations or not.

Parameters
enable	If true trigger animations, if false do not

Since:

BlackBerry 10.0.0

Q_SLOT void setLayoutProperties (
bb::cascades::LayoutProperties *layoutProperties)

Sets the layoutProperties for the control.

The control takes ownership of the LayoutProperties object if no other control owns it already. If the LayoutProperties object already has an owner, the properties are applied to the control, but ownership of the LayoutProperties object remains unchanged. If the control already owns a LayoutProperties object, the existing settings are replaced by the specified LayoutProperties object and the container retains ownership of both.

Parameters
layoutProperties	The new layout properties for the control.

Since:

BlackBerry 10.0.0

Q_SLOT void setLeftMargin (
floatleftMargin)

Sets the leftMargin for the control.

Parameters
leftMargin	The left margin for control; must be greater than or equal to 0.0.

Since:

BlackBerry 10.0.0

Q_SLOT void setLeftPadding (
floatleftPadding)

Sets the left padding for the control.

After the padding is set, the leftPaddingChanged() signal is emitted.

Parameters
leftPadding	The new left padding.

Since:

BlackBerry 10.0.0

Q_SLOT void setLocallyFocused (
boollocallyFocused)

Sets the locallyFocused of the control.

Parameters
locallyFocused	The locallyFocused state of the Control.

Since:

BlackBerry 10.3.1

Q_SLOT void setMaxHeight (
floatmaxHeight)

Sets the maxHeight of the control.

Parameters
maxHeight	The new maximum height of the control; must be greater than or equal to 0.0.

Since:

BlackBerry 10.0.0

Q_SLOT void setMaxWidth (
floatmaxWidth)

Sets the maxWidth of the control.

Parameters
maxWidth	The new maximum width of the control; must be greater than or equal to 0.0.

Since:

BlackBerry 10.0.0

Q_SLOT void setMinHeight (
floatminHeight)

Sets the minHeight of the control.

Parameters
minHeight	The new minimum height of the control; must be greater than or equal to 0.0.

Since:

BlackBerry 10.0.0

Q_SLOT void setMinWidth (
floatminWidth)

Sets the minWidth of the control.

Parameters
minWidth	The new minimum width of the control; must be greater than or equal to 0.0.

Since:

BlackBerry 10.0.0

void setObjectName (
const QString &name)

Sets the objectName property.

Parameters
name	The new name for the object.

Since:

BlackBerry 10.0.0

Q_SLOT void setOpacity (
floatopacity)

Sets the opacity of the visual node.

A value between 0.0 (transparent) and 1.0 (opaque). This is the local opacity of the visual node, i.e. not taking the ancestor opacities into account. The default opacity is 1.0 (opaque).

Since:

BlackBerry 10.0.0

Parameters
opacity	A value between between 0.0 (transparent) and 1.0 (opaque). If the value is outside the range it will be clamped to [0.0, 1.0].

Since:

BlackBerry 10.0.0

Q_SLOT void setOverlapTouchPolicy (
bb::cascades::OverlapTouchPolicy::Typepolicy)

Sets the overlap touch policy for the visual node.

Note:

The policy has no effect if propagation mode is TouchPropagationMode::None for the same visual node.

The default policy is OverlapTouchPolicy::Deny.

Since:

BlackBerry 10.0.0

Parameters
policy	The new overlap touch policy for the visual node.

Since:

BlackBerry 10.0.0

Q_SLOT void setPivot (
floatpivotX,
floatpivotY )

Convenience function for setting the position of pivot point of the visual node along the x- and y-axes.

Since:

BlackBerry 10.0.0

See also:

setPivotX(), setPivotY()

Parameters
pivotX	The position of pivot point along the x-axis, relative to the center of the visual node.
pivotY	The position of pivot point along the y-axis, relative to the center of the visual node.

Since:

BlackBerry 10.0.0

Q_SLOT void setPivotX (
floatpivotX)

Sets the position of pivot point of the visual node along the x-axis.

Since:

BlackBerry 10.0.0

See also:

setPivot(float, float), setPivot(float, float, float)

Parameters
pivotX	The position of pivot point along the x-axis, relative to the center of the visual node.

Since:

BlackBerry 10.0.0

Q_SLOT void setPivotY (
floatpivotY)

Sets the position of pivot point of the visual node along the y-axis.

Since:

BlackBerry 10.0.0

See also:

setPivot(float, float), setPivot(float, float, float)

Parameters
pivotY	The position of pivot point along the y-axis, relative to the center of the visual node.

Since:

BlackBerry 10.0.0

Q_SLOT void setPreferredHeight (
floatpreferredHeight)

Sets the preferredHeight of the control.

Parameters
preferredHeight	The preferred height of the control as a positive, non-zero number.

See also:

setPreferredSize()

Since:

BlackBerry 10.0.0

Q_SLOT void setPreferredSize (
floatpreferredWidth,
floatpreferredHeight )

Sets the preferred width and height of the control.

A convenience function for setting both preferred width and height. It is equivalent to calling both setPreferredWidth() and setPreferredHeight().

Parameters
preferredWidth	The preferred width of the control as a positive, non-zero number.
preferredHeight	The preferred height of the control as a positive, non-zero number.

Since:

BlackBerry 10.0.0

Q_SLOT void setPreferredWidth (
floatpreferredWidth)

Sets the preferredWidth of the control.

Parameters
preferredWidth	The preferred width of the control as a positive, non-zero number.

See also:

setPreferredSize()

Since:

BlackBerry 10.0.0

Q_SLOT void setRightMargin (
floatrightMargin)

Sets the rightMargin for the control.

Parameters
rightMargin	The right margin for control; must be greater than or equal to 0.0.

Since:

BlackBerry 10.0.0

Q_SLOT void setRightPadding (
floatrightPadding)

Sets the right padding for the control.

After the padding is set, the rightPaddingChanged() signal is emitted.

Parameters
rightPadding	The new left padding.

Since:

BlackBerry 10.0.0

Q_SLOT void setRotationZ (
floatrotationZ)

Sets the rotation of the visual node around the z-axis.

The visual node is rotated around the z-axis, centered around a pivot point defined by the components pivotX, pivotY and pivotZ. The default rotation is 0.0 degrees.

Since:

BlackBerry 10.0.0

Parameters
rotationZ	The rotation around the z-axis in degrees, anchored at (pivotX and pivotY).

See also:

setPivotX(), setPivotY()

Since:

BlackBerry 10.0.0

Q_SLOT void setScale (
floatscaleX,
floatscaleY )

Convenience function for setting the scale factor for each axes.

Parameters
scaleX	The scale factor along the x-axis, anchored at pivotX.
scaleY	The scale factor along the y-axis, anchored at pivotY.

Since:

BlackBerry 10.0.0

Q_SLOT void setScale (
floatscaleXY)

Convenience function for setting the same scale factor for all axes.

Parameters
scaleXY	The scale factor to set for all axes.

Since:

BlackBerry 10.0.0

Q_SLOT void setScaleX (
floatscaleX)

Sets the scale factor of the visual node along the x-axis.

The visual node is scaled along the x-axis, centered around a pivot point defined by the components pivotX, pivotY and pivotZ. The default scale factor is 1.0 (not scaled).

Since:

BlackBerry 10.0.0

See also:

setScale(), setPivotX()

Parameters
scaleX	The scale factor along the x-axis, anchored at pivotX.

Since:

BlackBerry 10.0.0

Q_SLOT void setScaleY (
floatscaleY)

Sets the scale factor of the visual node along the y-axis.

The visual node is scaled along the y-axis, centered around a pivot point defined by the components pivotX, pivotY and pivotZ. The default scale factor is 1.0 (not scaled).

Since:

BlackBerry 10.0.0

See also:

setScale()

Parameters
scaleY	The scale factor along the y-axis, anchored at pivotY.

See also:

setPivotY()

Since:

BlackBerry 10.0.0

Q_SLOT void setTopMargin (
floattopMargin)

Sets the topMargin for the control.

Parameters
topMargin	The top margin for control; must be greater than or equal to 0.0.

Since:

BlackBerry 10.0.0

Q_SLOT void setTopPadding (
floattopPadding)

Sets the top padding for the control.

After the padding is set, the topPaddingChanged() signal is emitted.

Parameters
topPadding	The new left padding.

Since:

BlackBerry 10.0.0

Q_SLOT void setTouchPropagationMode (
bb::cascades::TouchPropagationMode::Typemode)

Sets the touch propagation mode for the visual node.

This property controls how the visual node and its subtree partakes in touch event propagation. There are three possible modes, as defined by TouchPropagationMode::Type:

TouchPropagationMode::Full means that touch events will be fully propagated to the visual node and it's subtree.
TouchPropagationMode::None means no touch events will be propagated to the visual node or its subtree. The subtree is practically invisible to the touch system.
TouchPropagationMode::PassThrough means touch events will not be handled by the visual node itself, but its subtree will get touch events as usual.

TouchPropagationMode::None can be used as an optimization if you have complex, non-interactive content, that overlaps interactive controls.

The default propagation mode is TouchPropagationMode::Full.

Since:

BlackBerry 10.0.0

Parameters
mode	The new touch propagation mode for the visual node.

Since:

BlackBerry 10.0.0

Q_SLOT void setTranslation (
floattranslationX,
floattranslationY )

Convenience function for setting the translation along all axes.

The translationX and translationY correspond to pixels as long as the translationZ is 0.0.

See also:

Layout for more details.

Since:

BlackBerry 10.0.0

See also:

setTranslationX(), setTranslationY()

Parameters
translationX	The translation along the the x-axis (pointing towards right).
translationY	The translation along the the y-axis (pointing downwards).

Since:

BlackBerry 10.0.0

Q_SLOT void setTranslationX (
floattranslationX)

Sets the translation of the visual node along the x-axis.

The translationX and translationY correspond to pixels as long as the translationZ is 0.0.

See also:

Layout for more details.

Since:

BlackBerry 10.0.0

See also:

setTranslation(float, float), setTranslation(float, float, float)

Parameters
translationX	The translation along the the x-axis (pointing towards right).

Since:

BlackBerry 10.0.0

Q_SLOT void setTranslationY (
floattranslationY)

Sets the translation of the visual node along the y-axis.

The translationX and translationY correspond to pixels as long as the translationZ is 0.0.

See also:

Layout for more details.

Since:

BlackBerry 10.0.0

See also:

setTranslation(float, float), setTranslation(float, float, float)

Parameters
translationY	The translation along the the y-axis (pointing downwards).

Since:

BlackBerry 10.0.0

Q_SLOT void setVerticalAlignment (
bb::cascades::VerticalAlignment::TypeverticalAlignment)

Sets the vertical alignment for the control.

After the vertical alignment is set, the verticalAlignmentChanged() signal is emitted.

Parameters
verticalAlignment	The vertical alignment for the control.

Since:

BlackBerry 10.0.0

Q_SLOT void setVisible (
boolvisible)

Sets whether the visual should be visible or not.

If the visible property is set to false, the visual node is neither laid out nor rendered. The default visible value is true.

Since:

BlackBerry 10.0.0

Parameters
visible	True to make the visual node visible, false otherwise.

Since:

BlackBerry 10.0.0

Q_INVOKABLE bb::cascades::AbstractShortcut * shortcutAt (
intindex)

Returns a shortcut at the specified index.

Ownership of the shortcut remains with the Control.

Parameters
index	The index of the shortcut.

Return:

The requested shortcut if the index was valid, 0 otherwise.

Since:

BlackBerry 10.1.0

Q_INVOKABLE int shortcutCount ()

Returns the number of shortcuts.

Return:

The number of shortcuts.

Since:

BlackBerry 10.1.0

virtual Q_INVOKABLE QString toDebugString ()

Returns a debug string representing this object.

Return:

A debug string for the object.

Since:

BlackBerry 10.0.0

float topMargin ()

Returns the topMargin for the control.

Return:

The top margin for the control.

Since:

BlackBerry 10.0.0

float topPadding ()

Returns the top padding on the control.

Return:

The top padding.

Since:

BlackBerry 10.0.0

TouchPropagationMode::Type touchPropagationMode ()

Returns the touch propagation mode for the visual node.

This property controls how the visual node and its subtree partakes in touch event propagation. There are three possible modes, as defined by TouchPropagationMode::Type:

TouchPropagationMode::Full means that touch events will be fully propagated to the visual node and it's subtree.
TouchPropagationMode::None means no touch events will be propagated to the visual node or its subtree. The subtree is practically invisible to the touch system.
TouchPropagationMode::PassThrough means touch events will not be handled by the visual node itself, but its subtree will get touch events as usual.

TouchPropagationMode::None can be used as an optimization if you have complex, non-interactive content, that overlaps interactive controls.

The default propagation mode is TouchPropagationMode::Full.

Since:

BlackBerry 10.0.0

Return:

The touch propagation mode for the visual node.

Since:

BlackBerry 10.0.0

float translationX ()

Returns the translation of the visual node along the x-axis.

The translationX and translationY correspond to pixels as long as the translationZ is 0.0.

See also:

Layout for more details.

Since:

BlackBerry 10.0.0

Return:

The translation along the the x-axis (pointing towards right).

Since:

BlackBerry 10.0.0

float translationY ()

Returns the translation of the visual node along the y-axis.

The translationX and translationY correspond to pixels as long as the translationZ is 0.0.

See also:

Layout for more details.

Since:

BlackBerry 10.0.0

Return:

The translation along the the y-axis (pointing downwards).

Since:

BlackBerry 10.0.0

Q_INVOKABLE bb::cascades::UIConfig * ui ()

Returns the UIConfig for this ui object.

The UIConfig can be used to perform unit conversions from design units (du) and snapped design units (sdu) to pixels.

Ownership remains with Cascades.

C++ use:

Container *container1 = Container::create().background(Color::Red);
UIConfig *ui = container1->ui();
container1->setPreferredWidth(ui->du(12));
container1->setPreferredHeight(ui->du(5));

Container *container2 = Container::create().background(Color::Green);
container2->setPreferredWidth(ui->sdu(13.5));
container2->setPreferredHeight(ui->sdu(7.5));

Container *container3 = Container::create().background(Color::Blue);
container3->setPreferredWidth(ui->px(150));
container3->setPreferredHeight(ui->sdu(50));

Return:

The UIConfig for this ui object.

Since:

BlackBerry 10.3.0

bb::cascades::VerticalAlignment::Type verticalAlignment ()

Returns the vertical alignment for the control.

Return:

The vertical alignment for the control.

Since:

BlackBerry 10.0.0

Static Public Functions

Builder create ()

Creates and returns a builder for constructing a ListView.

This creator takes no ListLayout parameter. This is the equivalent to using the ListView constructor, which takes a ListLayout parameter and passes a StackListLayout with LayoutOrientation::TopToBottom.

Return:

A builder for constructing a ListView.

Since:

BlackBerry 10.0.0

Protected Functions

(Only has inherited protected functions)

BaseObject (
QObject *parent)

Constructs an instance of BaseObject's subclass.

Parameters
parent	An optional parent, defaults to 0.

Since:

BlackBerry 10.0.0

virtual void connectNotify (
const char *signal)

Overloaded to implement the event mechanism in Cascades.

If this function is overridden, it must be called by the derived class for events to work properly in Cascades.

Parameters
signal	The connected signal.

Since:

BlackBerry 10.0.0

virtual void disconnectNotify (
const char *signal)

Overloaded to implement the event mechanism in Cascades.

If this function is overridden, it must be called by the derived class for events to work properly in Cascades.

Parameters
signal	The disconnected signal.

Since:

BlackBerry 10.0.0

Signals

void activationChanged (
QVariantListindexPath,
boolactive )

Emitted when the activation state has changed for a list item.

A list item is typically active while the user is pressing the item. Once released, the item is no longer active.

If the item implements the ListItemListener interface, ListView also calls ListItemListener::active() whenever the active state of the item is changed.

Parameters
indexPath	The index path to the item. See index paths for more information.
active	true if the new state is active, false otherwise.

Since:

BlackBerry 10.0.0

void bufferedScrollingEnabledChanged (
boolbEnabled)

Emitted when the bufferedScrollingEnabled property has changed.

Parameters
bEnabled	The new buffered scrolling value.

Since:

BlackBerry 10.0.0

void dataModelChanged (
bb::cascades::DataModel *dataModel)

Emitted when ListView::dataModel has changed.

Parameters
dataModel	The new DataModel.

Since:

BlackBerry 10.0.0

void flickModeChanged (
bb::cascades::FlickMode::TypenewFlickMode)

Emitted when ListView::flickMode has changed.

Note:

Due to a work around for a Qt Core issue with accessing enums from QML, the argument of this signal doesn't follow the usual naming convention for signals. Typically, signal arguments are named to match the associated property's name. In this case, you must use the object's property to access the current property value instead of the signal argument to avoid runtime errors (use flickMode instead of newFlickMode).

Parameters
newFlickMode	The new flick mode.

Since:

BlackBerry 10.0.0

void layoutChanged (
bb::cascades::ListLayout *layout)

Emitted when a new layout is set on the ListView.

Parameters
layout	The new layout.

Since:

BlackBerry 10.0.0

void leadingVisualChanged (
bb::cascades::VisualNode *pLeadingVisual)

Emitted when the leadingVisual for the ListView has changed.

Parameters
pLeadingVisual	The new leadingVisual.

Since:

BlackBerry 10.0.0

void leadingVisualSnapThresholdChanged (
floatleadingVisualSnapThreshold)

Emitted when the leadingVisualSnapThreshold has changed.

Parameters
leadingVisualSnapThreshold	The new leadingVisualSnapThreshold.

Since:

BlackBerry 10.0.0

void listItemProviderChanged (
bb::cascades::ListItemProvider *listItemProvider)

Emitted when ListView::listItemProvider has changed.

Parameters
listItemProvider	The new ListItemProvider.

Since:

BlackBerry 10.0.0

void multiSelectActionChanged (
bb::cascades::MultiSelectActionItem *multiSelectAction)

Emitted when multiSelectAction has changed.

Parameters
multiSelectAction	The new multiSelectAction or 0 if it is not set.

Since:

BlackBerry 10.0.0

void rootIndexPathChanged (
QVariantListrootIndexPath)

Emitted when ListView::rootIndexPath has changed.

Parameters
rootIndexPath	The new rootIndexPath. See index paths for more information.

Since:

BlackBerry 10.0.0

void scrollIndicatorModeChanged (
bb::cascades::ScrollIndicatorMode::TypenewScrollIndicatorMode)

Emitted when ListView::scrollIndicatorMode has changed.

Note:

Parameters
newScrollIndicatorMode	The new value of the scrollIndicatorMode property.

Since:

BlackBerry 10.0.0

void scrollRoleChanged (
bb::cascades::ScrollRole::TypenewScrollRole)

Emitted when ListView::scrollRole has changed.

Parameters
newScrollRole	new scrollRole value.

Since:

BlackBerry 10.1.0

void selectionChanged (
QVariantListindexPath,
boolselected )

Emitted when the selection state has changed for a list item.

An item which opens the context menu is for example selected. The context menu is opened by long pressing the item. Multiple items can be selected when the multiSelectHandler is active. It is also possible to select and deselect items programmatically using, for example, select(), toggleSelection(), selectAll() and clearSelection().

If the item implements the ListItemListener interface, ListView also calls ListItemListener::select() whenever the selection state of the item is changed.

See also:

Signal triggered() if you want to be notified when the user taps on a list item with the intention to trigger an action.

selectionChangeStarted() and selectionChangeEnded(), useful for getting notifications before and after selection is changed.

Parameters
indexPath	The index path to the item. See index paths for more information.
selected	true if the new state is selected, false otherwise.

Since:

BlackBerry 10.0.0

void selectionChangeEnded ()

Emitted after one or more items have been selected.

This signal always follows when one or more items have been selected. Typically, any generic processing tasks that apply to a selection change as a whole, can be carried out when receiving this signal in order to maintain performance. For instance, extracting the list of selected items by calling selectionList(), is recommended to be carried out when this signal is received rather than every time the selectionChanged() signal is received.

See also:

selectionChangeStarted()

selectionChanged()

Since:

BlackBerry 10.3.1

void selectionChangeStarted ()

Emitted before one or more items are about to be selected.

This signal is emitted right before any item selection(s) take place. It is followed by one or more selectionChanged() signals and then a finishing selectionChangeEnded().

See also:

selectionChangeEnded()

selectionChanged()

Since:

BlackBerry 10.3.1

void snapModeChanged (
bb::cascades::SnapMode::TypenewSnapMode)

Emitted when ListView::snapMode has changed.

Note:

Parameters
newSnapMode	The new snap mode.

Since:

BlackBerry 10.0.0

void stickToEdgePolicyChanged (
bb::cascades::ListViewStickToEdgePolicy::TypenewStickToEdgePolicy)

Emitted when ListView::stickToEdgePolicy has changed.

Note:

Parameters
newStickToEdgePolicy	The new stick to edge policy.

Since:

BlackBerry 10.1.0

void triggered (
QVariantListindexPath)

Emitted when a list item is triggered by the user.

Typically, this signal is emitted when an item is tapped by the user with the intention to execute some action associated with it. This signal is, for example, not emitted when items are tapped during multiple selection, where the intention is to select the tapped item and not trigger an action associated with it.

Parameters
indexPath	The index path to the triggered item. See index paths for more information.

Since:

BlackBerry 10.0.0

void accessibilityModeChanged (
bb::cascades::A11yMode::TypenewAccessibilityMode)

Emitted when the accessibilityMode property on the control changes.

Note:

Due to a work around for a Qt Core issue with accessing enums from QML, the argument of this signal doesn't follow naming convention for signals in which the signal arguments are typically named to match the associated property's name. Use the object's accessibilityMode property to access the current property value instead of the signal argument to avoid runtime errors.

Parameters
newAccessibilityMode	The new value.

Since:

BlackBerry 10.2.0

void actionSetAdded (
bb::cascades::ActionSet *actionSet)

Emitted when an ActionSet has been added to the Control.

Parameters
actionSet	The ActionSet that has been added.

Since:

BlackBerry 10.0.0

void actionSetRemoved (
bb::cascades::ActionSet *actionSet)

Emitted when an ActionSet has been removed from the control.

Parameters
actionSet	The ActionSet that has been removed. 0 if emitted by removeAllActionSets().

Since:

BlackBerry 10.0.0

void bottomMarginChanged (
floatbottomMargin)

Emitted when the bottomMargin of the control changes.

Parameters
bottomMargin	The new bottom margin for the control.

Since:

BlackBerry 10.0.0

void bottomMarginSetChanged (
boolisSet)

Emitted when the bottomMarginSet of the control changes.

Parameters
isSet	information whether the preferred Width is now set.

Since:

BlackBerry 10.0.0

void bottomPaddingChanged (
floatbottomPadding)

Emitted when the bottomPadding property changes.

Parameters
bottomPadding	The new bottom padding.

Since:

BlackBerry 10.0.0

void builtInShortcutsEnabledChanged (
boolbuiltInShortcutsEnabled)

Emitted when the builtInShortcutsEnabled property changes.

Parameters
builtInShortcutsEnabled	The new value.

Since:

BlackBerry 10.2.0

void contextMenuHandlerChanged (
bb::cascades::ContextMenuHandler *contextMenuHandler)

Emitted when a ContextMenuHandler has been set for the Control.

Parameters
contextMenuHandler	The ContextMenuHandler that has been set, or 0 if it was reset.

Since:

BlackBerry 10.0.0

void creationCompleted ()

Emitted when this object is instantiated as a result of loading a QML document and creating the root node (only after the root component that caused this instantiation has completed construction), or when the object is being constructed from its builder class.

This signal indicates that the construction and initialization of the object has been completed, the properties are initialized, and any QML binding values have been assigned to the object.

This signal is not emitted when the object is constructed from C++ using the constructor. If the object is constructed using its builder class, the signal is emitted when the the builder class returns the fully constructed object.

This signal can be used when there is an activity that needs to be performed, such as a property state integrity verification after the object is instantiated from a QML document or a builder, but before control is returned to the application.

See also:

QmlDocument

Since:

BlackBerry 10.0.0

void enabledChanged (
boolenabled)

Emitted when the enabled property on the control changes.

Parameters
enabled	If true the control is enabled, if false the control is disabled.

Since:

BlackBerry 10.0.0

void focusAutoShowChanged (
bb::cascades::FocusAutoShow::TypenewFocusAutoShow)

Emitted when the focusAutoShow of the control changes.

Parameters
newFocusAutoShow	The new focusAutoShow state of the control.

Since:

BlackBerry 10.0.0

void focusedChanged (
boolfocused)

Emitted when the focused property on the control changes.

Parameters
focused	If true the control is focused, if false the control is not focused.

Since:

BlackBerry 10.0.0

void focusPolicyChanged (
bb::cascades::FocusPolicy::TypenewFocusPolicy)

Emitted when the focusPolicy of the control changes.

Parameters
newFocusPolicy	The new focusPolicy state of the control.

Since:

BlackBerry 10.0.0

void focusRetentionPolicyFlagsChanged (
bb::cascades::FocusRetentionPolicy::Typespolicy)

Emitted when the focusRetentionPolicyFlags property on the control changes.

Parameters
policy	The new focusRetentionPolicy.

Since:

BlackBerry 10.0.0

void horizontalAlignmentChanged (
bb::cascades::HorizontalAlignment::TypenewHorizontalAlignment)

Emitted when the horizontalAlignment property changes.

Note:

Due to a work around for a Qt Core issue with accessing enums from QML the argument of this signal doesn't follow naming convention for signals in which the signal arguments are typically named to match the associated property's name. Use the object's property to access current property value instead of the signal argument to avoid runtime errors (i.e. use horizontalAlignment instead of newHorizontalAlignment).

Parameters
newHorizontalAlignment	The new horizontal alignment for the control.

Since:

BlackBerry 10.0.0

void implicitLayoutAnimationsEnabledChanged (
boolimplicitLayoutAnimationsEnabled)

Emitted when the implicitLayoutAnimationsEnabled property on the control changes.

Parameters
implicitLayoutAnimationsEnabled	The new value.

Since:

BlackBerry 10.0.0

void layoutPropertiesChanged (
bb::cascades::LayoutProperties *layoutProperties)

Emitted when the layoutProperties of the control changes.

Parameters
layoutProperties	The new layout properties for the control.

Since:

BlackBerry 10.0.0

void leftMarginChanged (
floatleftMargin)

Emitted when the leftMargin of the control changes.

Parameters
leftMargin	The new left margin for the control.

Since:

BlackBerry 10.0.0

void leftMarginSetChanged (
boolisSet)

Emitted when the leftMarginSet of the control changes.

Parameters
isSet	information whether the preferred Width is now set.

Since:

BlackBerry 10.0.0

void leftPaddingChanged (
floatleftPadding)

Emitted when the leftPadding property changes.

Parameters
leftPadding	The new left padding.

Since:

BlackBerry 10.0.0

void locallyFocusedChanged (
boolnewLocallyFocused)

Emitted when the locallyFocused of the control changes.

Parameters
newLocallyFocused	The new locallyFocused state of the control.

Since:

BlackBerry 10.3.1

void maxHeightChanged (
floatmaxHeight)

Emitted when the maxHeight of the control changes.

Parameters
maxHeight	The new maximum height for the control.

Since:

BlackBerry 10.0.0

void maxWidthChanged (
floatmaxWidth)

Emitted when the maxWidth of the control changes.

Parameters
maxWidth	The new maximum width for the control.

Since:

BlackBerry 10.0.0

void minHeightChanged (
floatminHeight)

Emitted when the minHeight of the control changes.

Parameters
minHeight	The new minimum height for the control.

Since:

BlackBerry 10.0.0

void minWidthChanged (
floatminWidth)

Emitted when the minWidth of the control changes.

Parameters
minWidth	The new minimum width for the control.

Since:

BlackBerry 10.0.0

void objectNameChanged (
const QString &objectName)

This signal is emitted when the objectName property is changed.

See also:

QObject, BaseObject::objectName.

Since:

BlackBerry 10.0.0

void opacityChanged (
floatopacity)

Emitted after the opacity of the visual node has changed.

A value between 0.0 (transparent) and 1.0 (opaque). This is the local opacity of the visual node, i.e. not taking the ancestor opacities into account. The default opacity is 1.0 (opaque).

Since:

BlackBerry 10.0.0

Parameters
opacity	The new opacity set on the visual node.

See also:

opacityChanging

Since:

BlackBerry 10.0.0

void opacityChanging (
floatopacity)

Emitted while the opacity of the visual node is changing.

A value between 0.0 (transparent) and 1.0 (opaque). This is the local opacity of the visual node, i.e. not taking the ancestor opacities into account. The default opacity is 1.0 (opaque).

Since:

BlackBerry 10.0.0

Parameters
opacity	The new opacity set on the visual node.

See also:

opacityChanged

Since:

BlackBerry 10.0.0

void overlapTouchPolicyChanged (
bb::cascades::OverlapTouchPolicy::TypenewOverlapTouchPolicy)

Emitted when the overlap touch policy of the visual node is changed.

Note:

The policy has no effect if propagation mode is TouchPropagationMode::None for the same visual node.

The default policy is OverlapTouchPolicy::Deny.

Since:

BlackBerry 10.0.0

Parameters
newOverlapTouchPolicy	The new overlap touch policy.

Note:

Due to a work around for a Qt Core issue with accessing enums from QML the argument of this signal doesn't follow naming convention for signals in which the signal arguments are typically named to match the associated property's name. Use the object's property to access current property value instead of the signal argument to avoid runtime errors (i.e. use overlapTouchPolicy instead of newOverlapTouchPolicy).

Since:

BlackBerry 10.0.0

void pivotXChanged (
floatpivotX)

Emitted after pivotX of the visual node has changed.

Since:

BlackBerry 10.0.0

Parameters
pivotX	The new position of pivot point along the x-axis, relative to the center of the visual node.

Since:

BlackBerry 10.0.0

void pivotYChanged (
floatpivotY)

Emitted after pivotY of the visual node has changed.

Since:

BlackBerry 10.0.0

Parameters
pivotY	The new position of pivot point along the y-axis, relative to the center of the visual node.

Since:

BlackBerry 10.0.0

void preferredHeightChanged (
floatpreferredHeight)

Emitted when the preferredHeight of the control changes.

Parameters
preferredHeight	The new preferred height; will always be positive.

Since:

BlackBerry 10.0.0

void preferredHeightSetChanged (
boolisSet)

Emitted when the preferredHeightSet of the control changes.

Parameters
isSet	information whether the preferred height is now set.

Since:

BlackBerry 10.0.0

void preferredWidthChanged (
floatpreferredWidth)

Emitted when the preferredWidth of the control changes.

Parameters
preferredWidth	The new preferred width; will always be positive.

Since:

BlackBerry 10.0.0

void preferredWidthSetChanged (
boolisSet)

Emitted when the preferredWidthSet of the control changes.

Parameters
isSet	information whether the preferred width is now set.

Since:

BlackBerry 10.0.0

void rightMarginChanged (
floatrightMargin)

Emitted when the rightMargin of the control changes.

Parameters
rightMargin	The new right margin for the control.

Since:

BlackBerry 10.0.0

void rightMarginSetChanged (
boolisSet)

Emitted when the rightMarginSet of the control changes.

Parameters
isSet	information whether the preferred Width is now set.

Since:

BlackBerry 10.0.0

void rightPaddingChanged (
floatrightPadding)

Emitted when the rightPadding property changes.

Parameters
rightPadding	The new right padding.

Since:

BlackBerry 10.0.0

void rotationZChanged (
floatrotationZ)

Emitted after rotationZ of the visual node has changed.

The visual node is rotated around the z-axis, centered around a pivot point defined by the components pivotX, pivotY and pivotZ. The default rotation is 0.0 degrees.

Since:

BlackBerry 10.0.0

Parameters
rotationZ	The new rotation around the z-axis in degrees.

See also:

rotationZChanged()

Since:

BlackBerry 10.0.0

void rotationZChanging (
floatrotationZ)

Emitted while rotationZ of the visual node is changing.

The visual node is rotated around the z-axis, centered around a pivot point defined by the components pivotX, pivotY and pivotZ. The default rotation is 0.0 degrees.

Since:

BlackBerry 10.0.0

Parameters
rotationZ	The new rotation around the z-axis in degrees.

See also:

rotationZChanging()

Since:

BlackBerry 10.0.0

void scaleXChanged (
floatscaleX)

Emitted after scaleX of the visual node has changed.

The visual node is scaled along the x-axis, centered around a pivot point defined by the components pivotX, pivotY and pivotZ. The default scale factor is 1.0 (not scaled).

Since:

BlackBerry 10.0.0

Parameters
scaleX	The new scale factor along the x-axis.

See also:

scaleXChanging()

Since:

BlackBerry 10.0.0

void scaleXChanging (
floatscaleX)

Emitted while scaleX of the visual node is changing.

The visual node is scaled along the x-axis, centered around a pivot point defined by the components pivotX, pivotY and pivotZ. The default scale factor is 1.0 (not scaled).

Since:

BlackBerry 10.0.0

Parameters
scaleX	The new scale factor along the x-axis.

See also:

scaleXChanged()

Since:

BlackBerry 10.0.0

void scaleYChanged (
floatscaleY)

Emitted after scaleY of the visual node has changed.

The visual node is scaled along the y-axis, centered around a pivot point defined by the components pivotX, pivotY and pivotZ. The default scale factor is 1.0 (not scaled).

Since:

BlackBerry 10.0.0

Parameters
scaleY	The new scale factor along the y-axis.

See also:

scaleYChanging()

Since:

BlackBerry 10.0.0

void scaleYChanging (
floatscaleY)

Emitted while scaleY of the visual node is changing.

The visual node is scaled along the y-axis, centered around a pivot point defined by the components pivotX, pivotY and pivotZ. The default scale factor is 1.0 (not scaled).

Since:

BlackBerry 10.0.0

Parameters
scaleY	The new scale factor along the y-axis.

See also:

scaleYChanged()

Since:

BlackBerry 10.0.0

void topMarginChanged (
floattopMargin)

Emitted when the topMargin of the control changes.

Parameters
topMargin	The new top margin for the control.

Since:

BlackBerry 10.0.0

void topMarginSetChanged (
boolisSet)

Emitted when the topMarginSet of the control changes.

Parameters
isSet	information whether the preferred Width is now set.

Since:

BlackBerry 10.0.0

void topPaddingChanged (
floattopPadding)

Emitted when the topPadding property changes.

Parameters
topPadding	The new top padding.

Since:

BlackBerry 10.0.0

void touch (
bb::cascades::TouchEvent *event)

Emitted when a touch event is received.

Adding touch behaviors is a way to influence under what circumstances the node receives events.

Parameters
event	Pointer to the touch event.

Since:

BlackBerry 10.0.0

void touchCapture (
bb::cascades::TouchEvent *event)

Emitted when a touch event is directed towards a child of this node.

Adding touch behaviors is a way to influence under what circumstances the node receives events.

Parameters
event	- Pointer to the touch event.

Since:

BlackBerry 10.0.0

void touchEnter (
bb::cascades::TouchEnterEvent *event)

Emitted when touch enters the enter/exit area of this node.

touchEnter is not emitted when touch down happens on the enter/exit area, but only when touch moves into the area from outside.

Enter/exit areas

An enter/exit area is defined by

the node where the listener is connected,
its subtree and
overlapping nodes that are not part of the subtree

combined with the properties

touchPropagationMode and
overlapTouchPolicy

touchPropagationMode

None means a node and its subtree does not count towards the enter/exit area.
PassThrough means a node does not count towards any enter/exit area, but its subtree does.
Full means a node and its subtree counts towards the enter/exit area.

overlapTouchPolicy

Deny means a node that overlaps an enter/exit area (and is not part of the enter/exit subtree) subtracts from the enter/exit area.
Allow means a node that overlaps an enter/exit area (and is not part of the enter/exit subtree) doesn't affect the enter/exit area.

Parameters
event	- Pointer to the touch enter event.

See also:

touchExit

Since:

BlackBerry 10.0.0

void touchExit (
bb::cascades::TouchExitEvent *event)

Emitted when touch leaves the enter/exit area of this node.

touchExit is not emitted when touch up happens on the enter/exit area, but only when touch moves out from the area.

See touchEnter for more information.

Parameters
event	- Pointer to the touch exit event.

See also:

touchEnter

Since:

BlackBerry 10.0.0

void touchPropagationModeChanged (
bb::cascades::TouchPropagationMode::TypenewTouchPropagationMode)

Emitted when the touch propagation mode of the visual node is changed.

This property controls how the visual node and its subtree partakes in touch event propagation. There are three possible modes, as defined by TouchPropagationMode::Type:

TouchPropagationMode::Full means that touch events will be fully propagated to the visual node and it's subtree.
TouchPropagationMode::None means no touch events will be propagated to the visual node or its subtree. The subtree is practically invisible to the touch system.
TouchPropagationMode::PassThrough means touch events will not be handled by the visual node itself, but its subtree will get touch events as usual.

TouchPropagationMode::None can be used as an optimization if you have complex, non-interactive content, that overlaps interactive controls.

The default propagation mode is TouchPropagationMode::Full.

Since:

BlackBerry 10.0.0

Parameters
newTouchPropagationMode	The new touch propagation mode for the visual node.

Note:

Due to a work around for a Qt Core issue with accessing enums from QML the argument of this signal doesn't follow naming convention for signals in which the signal arguments are typically named to match the associated property's name. Use the object's property to access current property value instead of the signal argument to avoid runtime errors (i.e. use touchPropagationMode instead of newTouchPropagationMode).

Since:

BlackBerry 10.0.0

void translationXChanged (
floattranslationX)

Emitted after translationX of the visual node has changed.

The translationX and translationY correspond to pixels as long as the translationZ is 0.0.

See also:

Layout for more details.

Since:

BlackBerry 10.0.0

Parameters
translationX	The translation along the the x-axis (pointing towards right)

See also:

translationXChanging()

Since:

BlackBerry 10.0.0

void translationXChanging (
floattranslationX)

Emitted while translationX of the visual node is changing.

The translationX and translationY correspond to pixels as long as the translationZ is 0.0.

See also:

Layout for more details.

Since:

BlackBerry 10.0.0

Parameters
translationX	The new translation along the the x-axis (pointing towards right)

See also:

translationXChanged()

Since:

BlackBerry 10.0.0

void translationYChanged (
floattranslationY)

Emitted after translationY of the visual node has changed.

The translationX and translationY correspond to pixels as long as the translationZ is 0.0.

See also:

Layout for more details.

Since:

BlackBerry 10.0.0

Parameters
translationY	The new translation along the the y-axis (pointing downwards).

See also:

translationYChanging()

Since:

BlackBerry 10.0.0

void translationYChanging (
floattranslationY)

Emitted while translationY of the visual node is changing.

The translationX and translationY correspond to pixels as long as the translationZ is 0.0.

See also:

Layout for more details.

Since:

BlackBerry 10.0.0

Parameters
translationY	The new translation along the the y-axis (pointing downwards).

See also:

translationYChanged()

Since:

BlackBerry 10.0.0

void verticalAlignmentChanged (
bb::cascades::VerticalAlignment::TypenewVerticalAlignment)

Emitted when the verticalAlignment property changes.

Note:

Due to a work around for a Qt Core issue with accessing enums from QML the argument of this signal doesn't follow naming convention for signals in which the signal arguments are typically named to match the associated property's name. Use the object's property to access current property value instead of the signal argument to avoid runtime errors (i.e. use verticalAlignment instead of newVerticalAlignment).

Parameters
newVerticalAlignment	The new vertical alignment for the control.

Since:

BlackBerry 10.0.0

void visibleChanged (
boolvisible)

Emitted when the visible property of the visual node is changed.

If the visible property is set to false, the visual node is neither laid out nor rendered. The default visible value is true.

Since:

BlackBerry 10.0.0

Parameters
visible	The new visible property set on the visual node.

Since:

BlackBerry 10.0.0

ListView

Creating a list

List visuals in QML

List visuals in C++

The default list visuals

Index paths

Multi selection

Sizing

Overview

Inheritance

QML properties

QML signals

Properties Index

Public Static Attributes Index

Public Functions Index

Static Public Functions Index

Protected Functions Index

Signals Index

Properties

bool bufferedScrollingEnabled

bb::cascades::DataModel dataModel

bb::cascades::FlickMode::Type flickMode

bb::cascades::ListLayout layout

bb::cascades::VisualNode leadingVisual

float leadingVisualSnapThreshold

bb::cascades::ListItemProvider listItemProvider

bb::cascades::MultiSelectActionItem multiSelectAction

bb::cascades::MultiSelectHandler multiSelectHandler[read-only]

bb::cascades::RearrangeHandler rearrangeHandler[read-only]

QVariantList rootIndexPath

bb::cascades::ScrollIndicatorMode::Type scrollIndicatorMode

bb::cascades::ScrollRole::Type scrollRole

bb::cascades::SnapMode::Type snapMode

bb::cascades::ListViewStickToEdgePolicy::Type stickToEdgePolicy

bb::cascades::AbstractA11yObject accessibility[read-only]

bb::cascades::A11yMode::Type accessibilityMode

QDeclarativeListProperty< QObject > attachedObjects[read-only]

QDeclarativeListProperty keyListeners[read-only]

float bottomMargin

bool bottomMarginSet[read-only]

float bottomPadding

bool builtInShortcutsEnabled

bb::cascades::ContextMenuHandler contextMenuHandler

bool enabled

bb::cascades::FocusAutoShow::Type focusAutoShow

bool focused[read-only]

bb::cascades::FocusPolicy::Type focusPolicy

bb::cascades::FocusRetentionPolicy::Types focusRetentionPolicyFlags

bb::cascades::HorizontalAlignment::Type horizontalAlignment

bool implicitLayoutAnimationsEnabled

bb::cascades::InputRouteProperties inputRoute[read-only]

bb::cascades::LayoutProperties layoutProperties

float leftMargin

bool leftMarginSet[read-only]

float leftPadding

bool locallyFocused

bb::cascades::Spacings margin[read-only]

float maxHeight

float maxWidth

float minHeight

float minWidth

bb::cascades::Navigation navigation[read-only]

QString objectName

float opacity

bb::cascades::OverlapTouchPolicy::Type overlapTouchPolicy

QObject parent[read-only]

float pivotX

float pivotY

float preferredHeight

bool preferredHeightSet[read-only]

float preferredWidth

bool preferredWidthSet[read-only]

float rightMargin

bool rightMarginSet[read-only]

float rightPadding

float rotationZ

float scaleX

float scaleY

float topMargin

bool topMarginSet[read-only]

ListView (
Container *parent)

ListView (
bb::cascades::DataModel dataModel,
Container parent )

Q_INVOKABLE bool isSelected (
const QVariantList &indexPath)

Q_SLOT void scroll (
floatoffset,
bb::cascades::ScrollAnimation::TypescrollAnimation )

Q_SLOT void scrollToItem (
const QVariantList &indexPath,
bb::cascades::ScrollAnimation::TypescrollAnimation )

Q_SLOT void scrollToPosition (
bb::cascades::ScrollPosition::Typeposition,
bb::cascades::ScrollAnimation::TypescrollAnimation )

Q_SLOT void select (
const QVariantList &indexPath,
boolselect )

Q_SLOT void setBufferedScrollingEnabled (
boolbufferedScrollingEnabled)

Q_SLOT void setDataModel (
bb::cascades::DataModel *pDataModel)

Q_SLOT void setFlickMode (
bb::cascades::FlickMode::Typemode)

Q_SLOT void setLayout (
bb::cascades::ListLayout *layout)

Q_SLOT void setLeadingVisual (
bb::cascades::VisualNode *pLeadingVisual)

Q_SLOT void setLeadingVisualSnapThreshold (
floatleadingVisualSnapThreshold)

Q_SLOT void setListItemProvider (
bb::cascades::ListItemProvider *pItemProvider)

void setListItemTypeMapper (
ListItemTypeMapper *pItemTypeMapper)

Q_SLOT void setMultiSelectAction (
bb::cascades::MultiSelectActionItem *multiSelectAction)

Q_SLOT void setRootIndexPath (
const QVariantList &rootIndexPath)

Q_SLOT void setScrollIndicatorMode (
bb::cascades::ScrollIndicatorMode::Typemode)

Q_SLOT void setScrollRole (
bb::cascades::ScrollRole::TypescrollRole)

Q_INVOKABLE void setScrollStops (
const QVariantList &indexPaths)

Q_SLOT void setSnapMode (
bb::cascades::SnapMode::Typemode)

Q_SLOT void setStickToEdgePolicy (
bb::cascades::ListViewStickToEdgePolicy::Typepolicy)

Q_SLOT void toggleSelection (
const QVariantList &indexPath)