MapView

Since: BlackBerry 10.0.0

#include <bb/cascades/maps/MapView>

To link against this class, add the following line to your .pro file: LIBS += -lbbcascadesmaps

A graphics user interface (GUI) control that displays a map along with user-defined geographic elements, which can be points of interest or other location-aware elements.

All data shown on the map is provided through the client provided MapData object. A client provided MapData instance is controlled by the client. Thus, when the MapView is destroyed, the MapData instance still exists, and it is up to the client to free that memory. If the client wants to link the MapView and MapData objects together, then they can do so by making the MapData a child of the MapView.

If a MapData object is not provided by the client, then one is automatically created. In this case, the MapData instance is setup as a child of the MapView.

MapView will automatically pick an appropriate RenderEngine instance based on the available plug-ins. MapView will automatically switch to a different RenderEngine if the current engine cannot fully render the current view (usually due to lack of mapping data). If a RenderEngine is explicitly set by the client application, then dynamic RenderEngine switching is not performed.


Overview

QML properties

altitude: double
altitudeMode: bb::platform::geo::AltitudeMode::Type
captionContent: bb::cascades::Container
focusedId: QString
followedId: QString
heading: double
inlineTrafficAvailable: bool [read-only]
inlineTrafficEnabled: bool
inlineTrafficSupported: bool [read-only]
latitude: double
longitude: double
mapData: bb::cascades::maps::MapData
tilt: int
accessibility: bb::cascades::AbstractA11yObject [read-only]Inherited
accessibilityMode: bb::cascades::A11yMode::TypeInherited
animations: QDeclarativeListProperty< bb::cascades::AbstractAnimation > [read-only]Inherited
attachedObjects: QDeclarativeListProperty< QObject > [read-only]Inherited
bottomMargin: floatInherited
bottomMarginSet: bool [read-only]Inherited
bottomPadding: floatInherited
builtInShortcutsEnabled: boolInherited
contextActions: QDeclarativeListProperty< bb::cascades::ActionSet > [read-only]Inherited
contextMenuHandler: bb::cascades::ContextMenuHandlerInherited
enabled: boolInherited
focusAutoShow: bb::cascades::FocusAutoShow::TypeInherited
focused: bool [read-only]Inherited
focusPolicy: bb::cascades::FocusPolicy::TypeInherited
focusRetentionPolicyFlags: bb::cascades::FocusRetentionPolicy::TypesInherited
gestureHandlers: QDeclarativeListProperty< bb::cascades::GestureHandler > [read-only]Inherited
horizontalAlignment: bb::cascades::HorizontalAlignment::TypeInherited
implicitLayoutAnimationsEnabled: boolInherited
inputRoute: bb::cascades::InputRouteProperties [read-only]Inherited
keyListeners: QDeclarativeListProperty< bb::cascades::KeyListener > [read-only]Inherited
layoutProperties: bb::cascades::LayoutPropertiesInherited
leftMargin: floatInherited
leftMarginSet: bool [read-only]Inherited
leftPadding: floatInherited
maxHeight: floatInherited
maxWidth: floatInherited
minHeight: floatInherited
minWidth: floatInherited
objectName: QStringInherited
opacity: floatInherited
overlapTouchPolicy: bb::cascades::OverlapTouchPolicy::TypeInherited
parent: QObject [read-only]Inherited
pivotX: floatInherited
pivotY: floatInherited
preferredHeight: floatInherited
preferredHeightSet: bool [read-only]Inherited
preferredWidth: floatInherited
preferredWidthSet: bool [read-only]Inherited
rightMargin: floatInherited
rightMarginSet: bool [read-only]Inherited
rightPadding: floatInherited
rotationZ: floatInherited
scaleX: floatInherited
scaleY: floatInherited
shortcuts: QDeclarativeListProperty< bb::cascades::AbstractShortcut > [read-only]Inherited
topMargin: floatInherited
topMarginSet: bool [read-only]Inherited
topPadding: floatInherited
touchBehaviors: QDeclarativeListProperty< bb::cascades::TouchBehavior > [read-only]Inherited
touchPropagationMode: bb::cascades::TouchPropagationMode::TypeInherited
translationX: floatInherited
translationY: floatInherited
verticalAlignment: bb::cascades::VerticalAlignment::TypeInherited
visible: boolInherited

QML signals

onAltitudeChanged: {}
onAltitudeModeChanged: {}
onCaptionButtonClicked: {}
onCaptionContentChanged: {}
onCaptionLabelTapped: {}
onFocusedIdChanged: {}
onFollowedIdChanged: {}
onHeadingChanged: {}
onInlineTrafficAvailableChanged: {}
onInlineTrafficEnabledChanged: {}
onInlineTrafficSupportedChanged: {}
onLatitudeChanged: {}
onLocationLongPressed: {}
onLocationTapped: {}
onLongitudeChanged: {}
onMapDataChanged: {}
onMapLongPressed: {}
onRequestRender: {}
onTiltChanged: {}
onAccessibilityModeChangedInherited: {}
onActionSetAddedInherited: {}
onActionSetRemovedInherited: {}
onBottomMarginChangedInherited: {}
onBottomMarginSetChangedInherited: {}
onBottomPaddingChangedInherited: {}
onBuiltInShortcutsEnabledChangedInherited: {}
onContextMenuHandlerChangedInherited: {}
onCreationCompletedInherited: {}
onEnabledChangedInherited: {}
onFocusAutoShowChangedInherited: {}
onFocusedChangedInherited: {}
onFocusPolicyChangedInherited: {}
onFocusRetentionPolicyFlagsChangedInherited: {}
onHorizontalAlignmentChangedInherited: {}
onImplicitLayoutAnimationsEnabledChangedInherited: {}
onLayoutPropertiesChangedInherited: {}
onLeftMarginChangedInherited: {}
onLeftMarginSetChangedInherited: {}
onLeftPaddingChangedInherited: {}
onMaxHeightChangedInherited: {}
onMaxWidthChangedInherited: {}
onMinHeightChangedInherited: {}
onMinWidthChangedInherited: {}
onObjectNameChangedInherited: {}
onOpacityChangedInherited: {}
onOpacityChangingInherited: {}
onOverlapTouchPolicyChangedInherited: {}
onPivotXChangedInherited: {}
onPivotYChangedInherited: {}
onPreferredHeightChangedInherited: {}
onPreferredHeightSetChangedInherited: {}
onPreferredWidthChangedInherited: {}
onPreferredWidthSetChangedInherited: {}
onRightMarginChangedInherited: {}
onRightMarginSetChangedInherited: {}
onRightPaddingChangedInherited: {}
onRotationZChangedInherited: {}
onRotationZChangingInherited: {}
onScaleXChangedInherited: {}
onScaleXChangingInherited: {}
onScaleYChangedInherited: {}
onScaleYChangingInherited: {}
onTopMarginChangedInherited: {}
onTopMarginSetChangedInherited: {}
onTopPaddingChangedInherited: {}
onTouchInherited: {}
onTouchCaptureInherited: {}
onTouchEnterInherited: {}
onTouchExitInherited: {}
onTouchPropagationModeChangedInherited: {}
onTranslationXChangedInherited: {}
onTranslationXChangingInherited: {}
onTranslationYChangedInherited: {}
onTranslationYChangingInherited: {}
onVerticalAlignmentChangedInherited: {}
onVisibleChangedInherited: {}

Properties Index

doublealtitude
bb::platform::geo::AltitudeMode::TypealtitudeMode
bb::cascades::ContainercaptionContent
QStringfocusedId
QStringfollowedId
doubleheading
boolinlineTrafficAvailable [read-only]
boolinlineTrafficEnabled
boolinlineTrafficSupported [read-only]
doublelatitude
doublelongitude
bb::cascades::maps::MapDatamapData
inttilt
bb::cascades::AbstractA11yObjectaccessibility [read-only]Inherited
bb::cascades::A11yMode::TypeaccessibilityModeInherited
QDeclarativeListProperty< bb::cascades::AbstractAnimation >animations [read-only]Inherited
QDeclarativeListProperty< QObject >attachedObjects [read-only]Inherited
floatbottomMarginInherited
boolbottomMarginSet [read-only]Inherited
floatbottomPaddingInherited
boolbuiltInShortcutsEnabledInherited
QDeclarativeListProperty< bb::cascades::ActionSet >contextActions [read-only]Inherited
bb::cascades::ContextMenuHandlercontextMenuHandlerInherited
boolenabledInherited
bb::cascades::FocusAutoShow::TypefocusAutoShowInherited
boolfocused [read-only]Inherited
bb::cascades::FocusPolicy::TypefocusPolicyInherited
bb::cascades::FocusRetentionPolicy::TypesfocusRetentionPolicyFlagsInherited
QDeclarativeListProperty< bb::cascades::GestureHandler >gestureHandlers [read-only]Inherited
bb::cascades::HorizontalAlignment::TypehorizontalAlignmentInherited
boolimplicitLayoutAnimationsEnabledInherited
bb::cascades::InputRoutePropertiesinputRoute [read-only]Inherited
QDeclarativeListProperty< bb::cascades::KeyListener >keyListeners [read-only]Inherited
bb::cascades::LayoutPropertieslayoutPropertiesInherited
floatleftMarginInherited
boolleftMarginSet [read-only]Inherited
floatleftPaddingInherited
floatmaxHeightInherited
floatmaxWidthInherited
floatminHeightInherited
floatminWidthInherited
QStringobjectNameInherited
floatopacityInherited
bb::cascades::OverlapTouchPolicy::TypeoverlapTouchPolicyInherited
QObjectparent [read-only]Inherited
floatpivotXInherited
floatpivotYInherited
floatpreferredHeightInherited
boolpreferredHeightSet [read-only]Inherited
floatpreferredWidthInherited
boolpreferredWidthSet [read-only]Inherited
floatrightMarginInherited
boolrightMarginSet [read-only]Inherited
floatrightPaddingInherited
floatrotationZInherited
floatscaleXInherited
floatscaleYInherited
QDeclarativeListProperty< bb::cascades::AbstractShortcut >shortcuts [read-only]Inherited
floattopMarginInherited
booltopMarginSet [read-only]Inherited
floattopPaddingInherited
QDeclarativeListProperty< bb::cascades::TouchBehavior >touchBehaviors [read-only]Inherited
bb::cascades::TouchPropagationMode::TypetouchPropagationModeInherited
floattranslationXInherited
floattranslationYInherited
bb::cascades::VerticalAlignment::TypeverticalAlignmentInherited
boolvisibleInherited

Public Functions Index

MapView (bb::cascades::Container *parent=0)
virtual ~MapView ()
doublealtitude () const
bb::platform::geo::AltitudeMode::TypealtitudeMode () const
bb::platform::geo::BoundingBoxboundingBox () const
bb::cascades::Container *captionContent () const
QStringfocusedId () const
QStringfollowedId () const
bb::ImageDatagenerateStaticMapImage ()
Q_INVOKABLE QStringgeoUri () const
doubleheading () const
bb::platform::geo::BoundingBoxinnerViewBoundary () const
boolisInlineTrafficAvailable () const
boolisInlineTrafficEnabled () const
boolisInlineTrafficSupported () const
doublelatitude () const
doublelongitude () const
bb::cascades::maps::MapData *mapData ()
const bb::cascades::maps::MapData *mapData () const
bb::platform::geo::BoundingBoxouterViewBoundary () const
Q_SLOT voidresetAltitude ()
Q_SLOT voidresetAltitudeMode ()
Q_SLOT voidresetCaptionContent ()
Q_SLOT voidresetFocusedId ()
Q_SLOT voidresetFollowedId ()
Q_SLOT voidresetHeading ()
voidresetInlineTrafficEnabled ()
Q_SLOT voidresetLatitude ()
Q_SLOT voidresetLongitude ()
voidresetMapData ()
Q_SLOT voidresetTilt ()
Q_SLOT voidresetViewBoundaries ()
Q_SLOT voidsetAltitude (double newAlt)
Q_SLOT voidsetAltitudeMode (bb::platform::geo::AltitudeMode::Type newAlt)
Q_SLOT voidsetCaptionContent (bb::cascades::Container *captionContent)
Q_INVOKABLE voidsetCaptionGoButtonVisible (bool showButton)
Q_SLOT voidsetFocusedId (const QString &newFocusedId)
Q_SLOT voidsetFollowedId (const QString &newFollowedId, float horizontalOffset=0.0, float verticalOffset=0.0)
Q_SLOT voidsetHeading (double newHeading)
voidsetInlineTrafficEnabled (bool enabled)
Q_SLOT voidsetLatitude (double newLat)
Q_SLOT boolsetLocation (const bb::platform::geo::Point &loc)
Q_SLOT boolsetLocation (const bb::platform::geo::BoundingBox &area)
Q_SLOT voidsetLocationOnFocused ()
Q_SLOT voidsetLocationOnVisible ()
boolsetLocationWindowAbsolute (int x, int y)
boolsetLocationWindowAbsolute (const QPoint &pixelLocation)
boolsetLocationWindowDelta (int deltaX, int deltaY)
boolsetLocationWindowDelta (const QPoint &deltaPixelLocation)
Q_SLOT voidsetLongitude (double newLon)
Q_SLOT voidsetMapData (bb::cascades::maps::MapData *data)
voidsetRenderEngine (bb::cascades::maps::RenderEngine *newEngine)
Q_SLOT boolsetRenderEngine (const QString &pluginName)
Q_SLOT voidsetTilt (int newTilt)
boolsetViewBoundaries (const bb::platform::geo::BoundingBox &innerBoundary, const bb::platform::geo::BoundingBox &outerBoundary)
inttilt () const
Q_INVOKABLE QStringurl () const
bb::cascades::maps::ViewPropertiesviewProperties () const
bb::platform::geo::PointwindowToWorld (const QPoint &windowCoordinates) const
QPointworldToWindow (const bb::platform::geo::Point &worldCoordinates) const
bb::cascades::AbstractA11yObject *accessibility () const Inherited
bb::cascades::A11yMode::TypeaccessibilityMode () const Inherited
ActionSet *actionSetAt (int index) const Inherited
intactionSetCount () const Inherited
voidaddActionSet (bb::cascades::ActionSet *actionSet)Inherited
voidaddAnimation (AbstractAnimation *animation)Inherited
voidaddGestureHandler (GestureHandler *gestureHandler)Inherited
Q_INVOKABLE voidaddKeyListener (bb::cascades::KeyListener *keyListener)Inherited
Q_INVOKABLE voidaddShortcut (bb::cascades::AbstractShortcut *shortcut)Inherited
voidaddTouchBehavior (TouchBehavior *touchBehavior)Inherited
AbstractAnimation *animationAt (int index) const Inherited
intanimationCount () const Inherited
floatbottomMargin () const Inherited
floatbottomPadding () const Inherited
Q_INVOKABLE boolbuiltInShortcutsEnabled () const Inherited
bb::cascades::ContextMenuHandler *contextMenuHandler () const Inherited
Q_INVOKABLE voiddisableAllShortcuts ()Inherited
Q_INVOKABLE voidenableAllShortcuts ()Inherited
virtual boolevent (QEvent *event)Inherited
bb::cascades::FocusAutoShow::TypefocusAutoShow () const Inherited
bb::cascades::FocusPolicy::TypefocusPolicy () const Inherited
bb::cascades::FocusRetentionPolicy::TypesfocusRetentionPolicyFlags ()Inherited
bb::cascades::HorizontalAlignment::TypehorizontalAlignment () const Inherited
boolimplicitLayoutAnimationsEnabled () const Inherited
bb::cascades::InputRouteProperties *inputRoute () const Inherited
boolisBottomMarginSet () const Inherited
boolisEnabled () const Inherited
boolisFocused () const Inherited
boolisLeftMarginSet () const Inherited
boolisPreferredHeightSet () const Inherited
boolisPreferredWidthSet () const Inherited
boolisRightMarginSet () const Inherited
boolisTopMarginSet () const Inherited
boolisVisible () const Inherited
Q_INVOKABLE bb::cascades::KeyListener *keyListenerAt (int index) const Inherited
Q_INVOKABLE intkeyListenerCount () const Inherited
bb::cascades::LayoutProperties *layoutProperties () const Inherited
floatleftMargin () const Inherited
floatleftPadding () const Inherited
Q_SLOT voidloseFocus ()Inherited
floatmaxHeight () const Inherited
floatmaxWidth () const Inherited
floatminHeight () const Inherited
floatminWidth () const Inherited
floatopacity () const Inherited
bb::cascades::OverlapTouchPolicy::TypeoverlapTouchPolicy () const Inherited
floatpivotX () const Inherited
floatpivotY () const Inherited
floatpreferredHeight () const Inherited
floatpreferredWidth () const Inherited
boolremoveActionSet (bb::cascades::ActionSet *actionSet)Inherited
voidremoveAllActionSets ()Inherited
voidremoveAllAnimations ()Inherited
voidremoveAllGestureHandlers ()Inherited
Q_INVOKABLE voidremoveAllKeyListeners ()Inherited
Q_INVOKABLE voidremoveAllShortcuts ()Inherited
voidremoveAllTouchBehaviors ()Inherited
boolremoveAnimation (AbstractAnimation *animation)Inherited
boolremoveGestureHandler (GestureHandler *gestureHandler)Inherited
Q_INVOKABLE boolremoveKeyListener (bb::cascades::KeyListener *keyListener)Inherited
Q_INVOKABLE boolremoveShortcut (bb::cascades::AbstractShortcut *shortcut)Inherited
boolremoveTouchBehavior (TouchBehavior *touchBehavior)Inherited
Q_SLOT voidrequestFocus ()Inherited
Q_SLOT voidresetAccessibilityMode ()Inherited
Q_SLOT voidresetBottomMargin ()Inherited
Q_SLOT voidresetBottomPadding ()Inherited
Q_INVOKABLE voidresetBuiltInShortcutsEnabled ()Inherited
Q_SLOT voidresetContextMenuHandler ()Inherited
Q_SLOT voidresetEnabled ()Inherited
Q_SLOT voidresetFocusAutoShow ()Inherited
Q_SLOT voidresetFocusPolicy ()Inherited
Q_SLOT voidresetFocusRetentionPolicyFlags ()Inherited
Q_SLOT voidresetHorizontalAlignment ()Inherited
Q_SLOT voidresetImplicitLayoutAnimationsEnabled ()Inherited
Q_SLOT voidresetLayoutProperties ()Inherited
Q_SLOT voidresetLeftMargin ()Inherited
Q_SLOT voidresetLeftPadding ()Inherited
Q_SLOT voidresetMaxHeight ()Inherited
Q_SLOT voidresetMaxWidth ()Inherited
Q_SLOT voidresetMinHeight ()Inherited
Q_SLOT voidresetMinWidth ()Inherited
Q_SLOT voidresetOpacity ()Inherited
Q_SLOT voidresetOverlapTouchPolicy ()Inherited
Q_SLOT voidresetPivot ()Inherited
Q_SLOT voidresetPivotX ()Inherited
Q_SLOT voidresetPivotY ()Inherited
Q_SLOT voidresetPreferredHeight ()Inherited
Q_SLOT voidresetPreferredSize ()Inherited
Q_SLOT voidresetPreferredWidth ()Inherited
Q_SLOT voidresetRightMargin ()Inherited
Q_SLOT voidresetRightPadding ()Inherited
Q_SLOT voidresetRotationZ ()Inherited
Q_SLOT voidresetScale ()Inherited
Q_SLOT voidresetScaleX ()Inherited
Q_SLOT voidresetScaleY ()Inherited
Q_SLOT voidresetTopMargin ()Inherited
Q_SLOT voidresetTopPadding ()Inherited
Q_SLOT voidresetTouchPropagationMode ()Inherited
Q_SLOT voidresetTranslation ()Inherited
Q_SLOT voidresetTranslationX ()Inherited
Q_SLOT voidresetTranslationY ()Inherited
Q_SLOT voidresetVerticalAlignment ()Inherited
Q_SLOT voidresetVisible ()Inherited
floatrightMargin () const Inherited
floatrightPadding () const Inherited
floatrotationZ () const Inherited
floatscaleX () const Inherited
floatscaleY () const Inherited
Q_SLOT voidsetAccessibilityMode (bb::cascades::A11yMode::Type accessibilityMode)Inherited
Q_SLOT voidsetBottomMargin (float bottomMargin)Inherited
Q_SLOT voidsetBottomPadding (float bottomPadding)Inherited
Q_INVOKABLE voidsetBuiltInShortcutEnabled (bb::cascades::SystemShortcuts::Type type, bool enabled)Inherited
Q_SLOT voidsetBuiltInShortcutsEnabled (bool enabled)Inherited
voidsetContextMenuHandler (bb::cascades::ContextMenuHandler *contextMenuHandler)Inherited
Q_SLOT voidsetEnabled (bool enabled)Inherited
Q_SLOT voidsetFocusAutoShow (const bb::cascades::FocusAutoShow::Type focusAutoShow)Inherited
Q_SLOT voidsetFocusPolicy (const bb::cascades::FocusPolicy::Type focusPolicy)Inherited
Q_SLOT voidsetFocusRetentionPolicyFlags (bb::cascades::FocusRetentionPolicy::Types policy)Inherited
Q_SLOT voidsetHorizontalAlignment (bb::cascades::HorizontalAlignment::Type horizontalAlignment)Inherited
Q_SLOT voidsetImplicitLayoutAnimationsEnabled (bool enable)Inherited
Q_SLOT voidsetLayoutProperties (bb::cascades::LayoutProperties *layoutProperties)Inherited
Q_SLOT voidsetLeftMargin (float leftMargin)Inherited
Q_SLOT voidsetLeftPadding (float leftPadding)Inherited
Q_SLOT voidsetMaxHeight (float maxHeight)Inherited
Q_SLOT voidsetMaxWidth (float maxWidth)Inherited
Q_SLOT voidsetMinHeight (float minHeight)Inherited
Q_SLOT voidsetMinWidth (float minWidth)Inherited
voidsetObjectName (const QString &name)Inherited
Q_SLOT voidsetOpacity (float opacity)Inherited
Q_SLOT voidsetOverlapTouchPolicy (bb::cascades::OverlapTouchPolicy::Type policy)Inherited
Q_SLOT voidsetPivot (float pivotX, float pivotY)Inherited
Q_SLOT voidsetPivotX (float pivotX)Inherited
Q_SLOT voidsetPivotY (float pivotY)Inherited
Q_SLOT voidsetPreferredHeight (float preferredHeight)Inherited
Q_SLOT voidsetPreferredSize (float preferredWidth, float preferredHeight)Inherited
Q_SLOT voidsetPreferredWidth (float preferredWidth)Inherited
Q_SLOT voidsetRightMargin (float rightMargin)Inherited
Q_SLOT voidsetRightPadding (float rightPadding)Inherited
Q_SLOT voidsetRotationZ (float rotationZ)Inherited
Q_SLOT voidsetScale (float scaleX, float scaleY)Inherited
Q_SLOT voidsetScale (float scaleXY)Inherited
Q_SLOT voidsetScaleX (float scaleX)Inherited
Q_SLOT voidsetScaleY (float scaleY)Inherited
Q_SLOT voidsetTopMargin (float topMargin)Inherited
Q_SLOT voidsetTopPadding (float topPadding)Inherited
Q_SLOT voidsetTouchPropagationMode (bb::cascades::TouchPropagationMode::Type mode)Inherited
Q_SLOT voidsetTranslation (float translationX, float translationY)Inherited
Q_SLOT voidsetTranslationX (float translationX)Inherited
Q_SLOT voidsetTranslationY (float translationY)Inherited
Q_SLOT voidsetVerticalAlignment (bb::cascades::VerticalAlignment::Type verticalAlignment)Inherited
Q_SLOT voidsetVisible (bool visible)Inherited
Q_INVOKABLE bb::cascades::AbstractShortcut *shortcutAt (int index) const Inherited
Q_INVOKABLE intshortcutCount () const Inherited
bb::cascades::Spacings *softMargin ()Inherited
virtual Q_INVOKABLE QStringtoDebugString () const Inherited
floattopMargin () const Inherited
floattopPadding () const Inherited
TouchPropagationMode::TypetouchPropagationMode () const Inherited
floattranslationX () const Inherited
floattranslationY () const Inherited
bb::cascades::VerticalAlignment::TypeverticalAlignment () const Inherited

Protected Functions Index

Only has inherited protected functions

BaseObject (QObject *parent=0)Inherited
virtual voidconnectNotify (const char *signal)Inherited
CustomControl (Container *parent=0)Inherited
virtual voiddisconnectNotify (const char *signal)Inherited
bb::cascades::VisualNode *root () const Inherited
voidsetAccessibility (bb::cascades::AbstractA11yObject *accessibility)Inherited
voidsetRoot (VisualNode *root)Inherited

Signals Index

voidaltitudeChanged (double newAlt)
voidaltitudeModeChanged (bb::platform::geo::AltitudeMode::Type mode)
voidcaptionButtonClicked () const
voidcaptionContentChanged (bb::cascades::Container *newContent)
voidcaptionLabelTapped (bb::cascades::TapEvent *tapEvent) const
voidfocusedIdChanged (const QString &idWithFocus)
voidfollowedIdChanged (const QString &idOfFollowed)
voidheadingChanged (double newHeading)
voidinlineTrafficAvailableChanged (bool available)
voidinlineTrafficEnabledChanged (bool enabled)
voidinlineTrafficSupportedChanged (bool supported)
voidlatitudeChanged (double newLat)
voidlocationLongPressed (const QString &id) const
voidlocationTapped (const QString &id) const
voidlongitudeChanged (double newLon)
voidmapDataChanged (bb::cascades::maps::MapData *mapData)
voidmapLongPressed (const bb::platform::geo::Point &coordinates) const
voidrequestRender ()
voidtiltChanged (int newTilt)
voidaccessibilityModeChanged (bb::cascades::A11yMode::Type newAccessibilityMode)Inherited
voidactionSetAdded (bb::cascades::ActionSet *actionSet)Inherited
voidactionSetRemoved (bb::cascades::ActionSet *actionSet)Inherited
voidbottomMarginChanged (float bottomMargin)Inherited
voidbottomMarginSetChanged (bool isSet)Inherited
voidbottomPaddingChanged (float bottomPadding)Inherited
voidbuiltInShortcutsEnabledChanged (bool builtInShortcutsEnabled)Inherited
voidcontextMenuHandlerChanged (bb::cascades::ContextMenuHandler *contextMenuHandler)Inherited
voidcreationCompleted ()Inherited
voidenabledChanged (bool enabled)Inherited
voidfocusAutoShowChanged (bb::cascades::FocusAutoShow::Type newFocusAutoShow)Inherited
voidfocusedChanged (bool focused)Inherited
voidfocusPolicyChanged (bb::cascades::FocusPolicy::Type newFocusPolicy)Inherited
voidfocusRetentionPolicyFlagsChanged (bb::cascades::FocusRetentionPolicy::Types policy)Inherited
voidhorizontalAlignmentChanged (bb::cascades::HorizontalAlignment::Type newHorizontalAlignment)Inherited
voidimplicitLayoutAnimationsEnabledChanged (bool implicitLayoutAnimationsEnabled)Inherited
voidlayoutPropertiesChanged (bb::cascades::LayoutProperties *layoutProperties)Inherited
voidleftMarginChanged (float leftMargin)Inherited
voidleftMarginSetChanged (bool isSet)Inherited
voidleftPaddingChanged (float leftPadding)Inherited
voidmaxHeightChanged (float maxHeight)Inherited
voidmaxWidthChanged (float maxWidth)Inherited
voidminHeightChanged (float minHeight)Inherited
voidminWidthChanged (float minWidth)Inherited
voidobjectNameChanged (const QString &objectName)Inherited
voidopacityChanged (float opacity)Inherited
voidopacityChanging (float opacity)Inherited
voidoverlapTouchPolicyChanged (bb::cascades::OverlapTouchPolicy::Type newOverlapTouchPolicy)Inherited
voidpivotXChanged (float pivotX)Inherited
voidpivotYChanged (float pivotY)Inherited
voidpreferredHeightChanged (float preferredHeight)Inherited
voidpreferredHeightSetChanged (bool isSet)Inherited
voidpreferredWidthChanged (float preferredWidth)Inherited
voidpreferredWidthSetChanged (bool isSet)Inherited
voidrightMarginChanged (float rightMargin)Inherited
voidrightMarginSetChanged (bool isSet)Inherited
voidrightPaddingChanged (float rightPadding)Inherited
voidrotationZChanged (float rotationZ)Inherited
voidrotationZChanging (float rotationZ)Inherited
voidscaleXChanged (float scaleX)Inherited
voidscaleXChanging (float scaleX)Inherited
voidscaleYChanged (float scaleY)Inherited
voidscaleYChanging (float scaleY)Inherited
voidtopMarginChanged (float topMargin)Inherited
voidtopMarginSetChanged (bool isSet)Inherited
voidtopPaddingChanged (float topPadding)Inherited
voidtouch (bb::cascades::TouchEvent *event)Inherited
voidtouchCapture (bb::cascades::TouchEvent *event)Inherited
voidtouchEnter (bb::cascades::TouchEnterEvent *event)Inherited
voidtouchExit (bb::cascades::TouchExitEvent *event)Inherited
voidtouchPropagationModeChanged (bb::cascades::TouchPropagationMode::Type newTouchPropagationMode)Inherited
voidtranslationXChanged (float translationX)Inherited
voidtranslationXChanging (float translationX)Inherited
voidtranslationYChanged (float translationY)Inherited
voidtranslationYChanging (float translationY)Inherited
voidverticalAlignmentChanged (bb::cascades::VerticalAlignment::Type newVerticalAlignment)Inherited
voidvisibleChanged (bool visible)Inherited

Properties

double altitude

Gets the viewport's altitude in meters.

Default value is 0 meters.

A point in geographic space that is represented by latitude and longitude coordinates in degrees and an altitude coordinate in meters.

Validity

A Point is considered valid when its three main attributes (altitude, latitude and longitude) are set. If a Point is invalid, its attributes are undefined.

Since:

BlackBerry 10.0.0

Since:

BlackBerry 10.0.0

bb::platform::geo::AltitudeMode::Type altitudeMode

Indicates how the viewport's altitude property should be interpreted.

Default value is AltitudeMode::RelativeToGround

The altitude measurement can be relative to the ground (default) or the sea level.

Since:

BlackBerry 10.0.0

Since:

BlackBerry 10.0.0

bb::cascades::Container captionContent

The location caption's content.

Since:

BlackBerry 10.2.0

QString focusedId

The geographic element that is currently in focus.

This is a convenience property for MapData's focused element.

Default value is an empty string.

Since:

BlackBerry 10.0.0

QString followedId

The geographic element that is currently being followed.

Default value is an empty string.

Since:

BlackBerry 10.0.0

double heading

Gets the heading of the viewport in compass degrees.

Values are based on a compass, with 0 equaling North, 90 equaling East, and so on. Default value is 0 (North).

Since:

BlackBerry 10.0.0

bool inlineTrafficAvailable[read-only]

Indicates whether inline traffic is available within the current map view.

Only applicable when inline traffic is enabled.

Since:

BlackBerry 10.2.0

bool inlineTrafficEnabled

Enables or disables the inclusion of traffic conditions within the map.

Since:

BlackBerry 10.2.0

bool inlineTrafficSupported[read-only]

Indicates whether inline traffic is supported with the currently selected RenderEngine.

Since:

BlackBerry 10.2.0

double latitude

The latitude of the viewport in coordinate degrees (-90 to +90).

Default value is 0.

Since:

BlackBerry 10.0.0

double longitude

The longitude of the viewport in coordinate degrees (-180 to +180).

Default value is 0.

Since:

BlackBerry 10.0.0

bb::cascades::maps::MapData mapData

The MapData for the MapView.

See also:

setMapData( bb::cascades::MapData* )

Since:

BlackBerry 10.2.0

int tilt

The viewport's tilt in angle degrees, where 0 is straight down.

Values are based on a camera pointing straight down (equaling 0) to pointing tangential to the earth's surface (equaling 90).

Since:

BlackBerry 10.0.0

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

Defines the control's accessibility object.

Accessibility objects are used by assistive technologies for people with disabilities or special needs (for example, visual impairment).

QML usage:
Label {
    id: nameLabel
    text: "Your name:"
}
TextArea {
    accessibility {
        labelledBy: nameLabel
    }
}
Button {
    text: "Submit"
    accessibility {
        description: "Submit your name to the lottery"
    }
}
C++ usage:
Label *label = Label::create().text("Your name:");
TextArea *textArea = TextArea::create();
Button *button = Button::create().text("Submit");

textArea->accessibility()->addLabel(label);
button->accessibility()->setDescription("Submit your name to the lottery");
Since:

BlackBerry 10.2.0

bb::cascades::A11yMode::Type accessibilityModeInherited

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< bb::cascades::AbstractAnimation > animationsInherited[read-only]

List of the animations attached to the visual node.

This node will be used as the implicit target for the animations in this list.

Since:

BlackBerry 10.0.0

QDeclarativeListProperty< QObject > attachedObjectsInherited[read-only]

A hierarchical list of the UIObject's attached objects.

This QDeclarativeListProperty can contain any QObject. When a QObject is added to property, the UIObject takes ownership of the attached object.

This feature is typically used from QML to specify business logic object or any other shared objects for the subnodes of this UIObject. In C++ the same functionality can be achived by setting a parent of a QObject to be attached to the QObject which is going to own it.

QML usage example (MyObject is a custom class registered for QML using the qmlRegisterType() function):

Container {
    Label { text: "Title: " + myObject.title } 
    Label { text: "Subject: " + myObject.subject }
    attachedObjects: [
        MyObject { id: myObject
            title: "Hello World"
            subject: "Nice Day"
        }
    ]
}

Since:

BlackBerry 10.0.0

float bottomMarginInherited

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 bottomMarginSetInherited[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 bottomPaddingInherited

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 builtInShortcutsEnabledInherited

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

QDeclarativeListProperty< bb::cascades::ActionSet > contextActionsInherited[read-only]

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

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

bb::cascades::ContextMenuHandler contextMenuHandlerInherited

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.

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

BlackBerry 10.0.0

bool enabledInherited

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 focusAutoShowInherited

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 focusedInherited[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 focusPolicyInherited

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 focusRetentionPolicyFlagsInherited

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

QDeclarativeListProperty< bb::cascades::GestureHandler > gestureHandlersInherited[read-only]

List of the gesture handlers added on the visual node.

Since:

BlackBerry 10.0.0

bb::cascades::HorizontalAlignment::Type horizontalAlignmentInherited

Specifies the HorizontalAlignment for the control.

The default alignment is HorizontalAlignment::Left.

Since:

BlackBerry 10.0.0

bool implicitLayoutAnimationsEnabledInherited

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 inputRouteInherited[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

QDeclarativeListProperty< bb::cascades::KeyListener > keyListenersInherited[read-only]

A list of key listeners attached to this control.

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

See also:

KeyListener

Since:

BlackBerry 10.1.0

bb::cascades::LayoutProperties layoutPropertiesInherited

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 leftMarginInherited

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 leftMarginSetInherited[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 leftPaddingInherited

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

float maxHeightInherited

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 maxWidthInherited

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 minHeightInherited

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 minWidthInherited

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 objectNameInherited

This property is overridden from QObject.

As the objectName property is overridden from the QObject class, this signal will not be emitted if setObjectName() function is called directly on QObject.

The default value of this property is QString::null.

See also:

QObject::objectName().

Since:

BlackBerry 10.0.0

float opacityInherited

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 overlapTouchPolicyInherited

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 parentInherited[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 pivotXInherited

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 pivotYInherited

The position of pivot point of the visual node along the y-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 preferredHeightInherited

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 preferredHeightSetInherited[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 preferredWidthInherited

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 preferredWidthSetInherited[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 rightMarginInherited

The right 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.

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

Since:

BlackBerry 10.0.0

bool rightMarginSetInherited[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 rightPaddingInherited

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 rotationZInherited

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 scaleXInherited

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 scaleYInherited

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

QDeclarativeListProperty< bb::cascades::AbstractShortcut > shortcutsInherited[read-only]

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

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

Since:

BlackBerry 10.1.0

float topMarginInherited

The top 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.

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

Since:

BlackBerry 10.0.0

bool topMarginSetInherited[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 topPaddingInherited

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

QDeclarativeListProperty< bb::cascades::TouchBehavior > touchBehaviorsInherited[read-only]

List of the touch behaviors added on the visual node.

Since:

BlackBerry 10.0.0

bb::cascades::TouchPropagationMode::Type touchPropagationModeInherited

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::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 translationXInherited

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 translationYInherited

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.

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

bb::cascades::VerticalAlignment::Type verticalAlignmentInherited

Specifies the VerticalAlignment for the control.

The default alignment is VerticalAlignment::Top.

Since:

BlackBerry 10.0.0

bool visibleInherited

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 Functions

MapView (

Default Constructor.

Parameters
parent

The parent object to this object.

Since:

BlackBerry 10.0.0

virtual~MapView ()

Destructor.

Since:

BlackBerry 10.0.0

double altitude ()

Retrieves the altitude in meters.

Since:

BlackBerry 10.0.0

bb::platform::geo::AltitudeMode::Type altitudeMode ()

Retrieves the altitude mode.

Since:

BlackBerry 10.0.0

bb::platform::geo::BoundingBox boundingBox ()

The axis-aligned bounding box of this control's view.

Return:

The bounding box containing the current view.

Since:

BlackBerry 10.0.0

bb::cascades::Container * captionContent ()

Retrieves the caption's content.

Note: Ownership of the container is not transferred as part of this operation: MapView is still the parent of the Container.

Return:

The current content for the caption bubble, or NULL if the caption bubble is disabled.

Since:

BlackBerry 10.2.0

QString focusedId ()

Retrieves the ID of the element that currently has focus (selected).

Return:

The ID of the element in focus. A null string is returned if nothing is in focus.

Since:

BlackBerry 10.0.0

QString followedId ()

Retrieves the ID of the element that is currently being followed.

Return:

The ID of the element being followed, or null string is returned if nothing is being followed.

Since:

BlackBerry 10.0.0

bb::ImageData generateStaticMapImage ()

Generates an image of the current map view.

Return:

An image of the currently viewed map.

Since:

BlackBerry 10.0.0

Q_INVOKABLE QString geoUri ()

Gets a Geo URI representing the current focused location (if available), otherwise representing the current map view.

The Geo URI (Uniform Resource Identifier) is a URI scheme as defined by the Internet Engineering Task Force's RFC 5870

Return:

A string representing the current view in GeoURI format.

Since:

BlackBerry 10.0.0

double heading ()

Retrieves the heading in degrees.

Since:

BlackBerry 10.0.0

bb::platform::geo::BoundingBox innerViewBoundary ()

Retrieves the inner view boundary.

Return:

The inner view boundary.

Since:

BlackBerry 10.2.0

bool isInlineTrafficAvailable ()

Determines if inline traffic data is available for the current map view.

Return:

true if inline traffic data is available within the current map view, false otherwise.

Since:

BlackBerry 10.2.0

bool isInlineTrafficEnabled ()

Determines if inline traffic mapping is enabled.

Return:

true if enabled, false otherwise.

Since:

BlackBerry 10.2.0

bool isInlineTrafficSupported ()

Determines if the current RenderEngine implementation supports the inclusion of inline traffic mapping.

Return:

true if supported, false otherwise.

Since:

BlackBerry 10.2.0

double latitude ()

Retrieves the latitude in degrees.

Since:

BlackBerry 10.0.0

double longitude ()

Retrieves the longitude in degrees.

Since:

BlackBerry 10.0.0

bb::cascades::maps::MapData * mapData ()

Retrieves the data on the map.

Since:

BlackBerry 10.0.0

const bb::cascades::maps::MapData * mapData ()

Retrieves the data on the map.

Since:

BlackBerry 10.0.0

bb::platform::geo::BoundingBox outerViewBoundary ()

Retrieves the outer view boundary.

Return:

The outer view boundary.

Since:

BlackBerry 10.2.0

Q_SLOT void resetAltitude ()

Resets the altitude to the default value of 4000 meters.

Since:

BlackBerry 10.0.0

Q_SLOT void resetAltitudeMode ()

Resets the altitude mode to the default value of AltitudeMode::RelativeToGround.

Since:

BlackBerry 10.0.0

Q_SLOT void resetCaptionContent ()

Resets the caption's content to the default value.

Since:

BlackBerry 10.2.0

Q_SLOT void resetFocusedId ()

Resets the focused element ID to the default value of nothing.

Since:

BlackBerry 10.0.0

Q_SLOT void resetFollowedId ()

Resets the followed element ID to the default value of nothing.

This means turn off follow mode.

Since:

BlackBerry 10.0.0

Q_SLOT void resetHeading ()

Resets the heading to the default value of 0 degrees (North).

Since:

BlackBerry 10.0.0

void resetInlineTrafficEnabled ()

Resets inline traffic mapping to its default state of disabled.

Since:

BlackBerry 10.2.0

Q_SLOT void resetLatitude ()

Resets the latitude to the default value of 0 degrees.

Since:

BlackBerry 10.0.0

Q_SLOT void resetLongitude ()

Resets the longitude to the default value of 0 degrees.

Since:

BlackBerry 10.0.0

void resetMapData ()

Resets the MapData to a new empty MapData instance.

The existing MapData and all DataProvider instances owned by it will be deleted.

Since:

BlackBerry 10.2.0

Q_SLOT void resetTilt ()

Resets the tilt to the default value of 0 degrees (straight down).

Since:

BlackBerry 10.0.0

Q_SLOT void resetViewBoundaries ()

Removes all view boundaries.

Since:

BlackBerry 10.2.0

Q_SLOT void setAltitude (
  • doublenewAlt)

Sets the altitude for the map's view.

Parameters
newAlt

The new altitude, in meters.

Since:

BlackBerry 10.0.0

Q_SLOT void setAltitudeMode (

Sets the altitude mode for the map's view.

Parameters
newAlt
The new altitude mode.

The altitude measurement can be relative to the ground (default) or the sea level.

Since:

BlackBerry 10.0.0

Q_SLOT void setCaptionContent (

Sets the caption's content.

MapView uses a location caption (callout bubble) to indicate the Geographic element that is in focus, as well as provide visual information about that focused element. The contents of this caption can be replaced with custom content.

The default contents of the caption consists of two text fields, one displaying the focused element's name, the other displaying the element's description. The default caption can optionally also contain a "go" button. (This button can be disabled through setCaptionGoButtonVisible( bool ).) The captionLabelTapped signal is emitted if the text fields are tapped. The captionButtonClicked signal is emitted when the "go" button is clicked. The caption's contents will be the default content container if it has not otherwise been set by the client.

The caption's contents can be replaced with an arbitrary container. This container only holds the new content of the caption, it does not contain the caption's chrome (the callout frame). At this time, the caption content is height limited. The content height is currently set at 137 pixels and is the same for all device screen layouts. Therefore, if the new contents exceed the caption's limits, the excess will be truncated.

The caption's new contents can contain controls that emit signals. It is up to the container's author to set up any signal/slot connections.

MapView takes ownership of the provided container. If a new container is provided, the previous container is deleted.

To remove the entire caption (contents and chrome), a NULL value is passed to this operation. To reset the caption's content to the default value, use resetCaptionContent().

Parameters
captionContent

The new caption's content. If NULL, the caption is disabled.

Since:

BlackBerry 10.2.0

Q_INVOKABLE void setCaptionGoButtonVisible (
  • boolshowButton)

Sets whether or not the "Go" button, used to navigate to the focused element, should appear in the focus caption bubble.

This method only applies to the default caption content. If client provides a custom content (using setCaptionContent(bb::cascades::Container*)) then it is the responsibility of the client to provide such button as part of that content.

In the case of default content, the "Go" button automatically appears on the focus caption bubble.

Parameters
showButton

true to show the "Go" button, false to hide the "Go" button.

Since:

BlackBerry 10.0.0

Q_SLOT void setFocusedId (

Sets the element that has focus.

Parameters
newFocusedId

The ID of the element to set focus on.

Since:

BlackBerry 10.0.0

Q_SLOT void setFollowedId (
  • const QString &newFollowedId,
  • floathorizontalOffset,
  • floatverticalOffset )

Sets the element to be followed.

By default the followed element will be shown at center of the map view. If the current map location is modified by the user then the followed ID will be reset.

Parameters
newFollowedId

The ID of the element to follow. If the element defined by this ID doesn't exist within the associated MapData container, then followId is reset.

horizontalOffset

Defines the horizontal position of the followed element on this map view relative to center. Valid values are from -1.0 to 1.0, the effective offset pixel value equals horizontalOffset/('map view width'/2). Therefore, -1.0 defines left edge; 1.0 defines right edge.

verticalOffset

Defines the vertical position of the followed element on this map view relative to center. Valid values are from -1.0 to 1.0, the effective offset pixel value equals verticalOffset/('map view height'/2). Therefore, -1.0 defines top edge; 1.0 defines bottom edge.

Since:

BlackBerry 10.0.0

Q_SLOT void setHeading (
  • doublenewHeading)

Sets the heading for the map's view.

Parameters
newHeading

The new heading, in degrees where 0 is North.

Since:

BlackBerry 10.0.0

void setInlineTrafficEnabled (
  • boolenabled)

Enables (or disables) inline traffic mapping.

Note: If inline traffic is not supported, setting this attribute will have no effect.

Parameters
@c

true to enable, false to disable inline traffic mapping.

Since:

BlackBerry 10.2.0

Q_SLOT void setLatitude (
  • doublenewLat)

Sets the latitude for the map's view.

Parameters
newLat

The new latitude, in degrees decimal.

Since:

BlackBerry 10.0.0

Q_SLOT bool setLocation (

Sets the location of the screen using latitude and longitude coordinates.

Parameters
loc

The location to set the map to.

Return:

true if a change occurred.

Since:

BlackBerry 10.0.0

Q_SLOT bool setLocation (

Sets the map's location such that the entire bounding box is visible within the map's view.

Note: This can modify latitude, longitude, altitude, altitude mode and heading.

Parameters
area

The box to be shown in the view. If this is invalid, no change is performed.

Return:

true if a change occurred.

Since:

BlackBerry 10.1.0

Q_SLOT void setLocationOnFocused ()

Sets the map location to that of the focused element.

If there is no focused element, nothing is done.

Since:

BlackBerry 10.0.0

Q_SLOT void setLocationOnVisible ()

Changes the map's view so that all visible data within the map's model (mapData()) is within the map's view.

If there is no visible data, the view does not change.

Since:

BlackBerry 10.1.0

bool setLocationWindowAbsolute (
  • intx,
  • inty )

Sets the map's location to be that of the window's x and y coordinates.

The window's origin is the upper, left corner.

Parameters
x

The window's x coordinate to make the center of the window.

y

The window's y coordinate to make the center of the window.

Return:

true if a change occurred.

Since:

BlackBerry 10.0.0

bool setLocationWindowAbsolute (

Sets the map's location to be that of the window's coordinates in pixels.

The window's origin is the upper, left corner.

Parameters
pixelLocation

The window's coordinates (in pixels) that will become the new center of the map's window.

Return:

true if a change occurred.

Since:

BlackBerry 10.0.0

bool setLocationWindowDelta (
  • intdeltaX,
  • intdeltaY )

Sets the location of the window relative to the current x and y coordinates.

The units used are screen pixels.

Parameters
deltaX

Move the current center of the map deltaX pixels on the X axis.

deltaY

Move the current center of the map deltaY pixels on the Y axis.

Return:

true if a change occurred.

Since:

BlackBerry 10.0.0

bool setLocationWindowDelta (
  • const QPoint &deltaPixelLocation)

Sets the location of the window relative to the current location in pixels.

The units used are screen pixels.

Parameters
deltaPixelLocation

The relative amount to move the center of the map.

Return:

true if a change occurred.

Since:

BlackBerry 10.0.0

Q_SLOT void setLongitude (
  • doublenewLon)

Sets the longitude for the map's view.

Parameters
newLon

The new longitude, in degrees decimal.

Since:

BlackBerry 10.0.0

Q_SLOT void setMapData (

Adds a new MapData container to this view.

The provided parameter will replace the existing MapData container. Connections will automatically be made between the MapView and MapData instances.

See class-level documentation for more information.

Parameters
data

The new container of data to show on the map.

Since:

BlackBerry 10.0.0

void setRenderEngine (

Allows for the explicit setting of the render engine that this MapView instance should use.

Note: This MapView instance will take explicit ownership of the provided RenderEngine. Thus, MapView will decide when the parameter's destructor will be called.

When a RenderEngine instance is explicitly set through this method, dynamic RenderEngine switching will be disabled (see class level documentation concerning this). A NULL value will re-enable dynamic RenderEngine switching.

Parameters
newEngine

A pointer to the new render engine. A value of NULL tells MapView to automatically pick the best suited RenderEngine from the list of available plug-ins.

Since:

BlackBerry 10.0.0

Q_SLOT bool setRenderEngine (

Sets the render engine to the named plug-in.

Given a plug-in name of FooBar, MapView will look for a RenderEngine plug-in in the following locations
  • [app_root]/app/native/lib/mapview-renderengine/FooBar.so

  • [app_root]/app/native/lib/mapview-renderengine/libFooBar.so

  • QTDIR/plugins/mapview-renderengine/FooBar.so

  • QTDIR/plugins/mapview-renderengine/libFooBar.so Where QTDIR is the installation location of Qt.

The plug-in must properly implement the RenderEngine interface, plus adhere to the plug-in structure as described in the RenderEngine class documentation.

See the class level documentation for information on dynamic RenderEngine switching.

Parameters
pluginName

The name of the plug-in to use as the render engine.

Return:

true if the plug-in was successfully loaded, false otherwise. See the application's log for information as to why the plug-in didn't load.

Since:

BlackBerry 10.0.0

Q_SLOT void setTilt (
  • intnewTilt)

Sets the tilt for the map's view.

Parameters
newTilt

The new tilt. Values are based on a camera pointing straight down (equaling 0) to pointing tangential to the earth's surface (equaling 90).

Since:

BlackBerry 10.0.0

bool setViewBoundaries (

Sets the boundaries of the current view.

View boundaries prevent the user from viewing portions of the map that exceed these boundaries. There are two boundaries: an inner boundary and an outer boundary.

The outer boundary keeps the map's view within the boundary. Thus, the user cannot pan or zoom beyond its borders. The inner boundary works in the opposite direction: the inner boundary is always visible within the map's view.

Both boundaries do not need to be supplied. An inner boundary can be supplied by itself, the outer boundary can be supplied, or both boundaries can be supplied.

Examples:
  • If an inner boundary is supplied representing a box around the Eiffel Tower, then the user will not be able to pan or zoom the map so the Eiffel Tower is no longer on the map.

  • If an outer boundary is supplied representing a box around Paris, then the user will be able to zoom in on Paris, will be able to pan around Paris, but will not be able to pan or zoom outside of Paris.

  • If an inner boundary for the Eiffel Tower and an outer boundary for Paris are supplied, then the user will be able to zoom and pan in and around Paris (but not outside of Paris) such that the Eiffel Tower is always on the map.

It is possible for the boundary's aspect ratio to differ from that of the view. For example, if the MapView is square (1x1 aspect ratio) and the outerBoundary has a 2x1 ratio, then the map's view will be expanded such that the entire outerBoundary is visible.

If both parameters are invalid, then the view boundaries are removed. This is equivalent to calling resetViewBoundaries().

It is a requirement that the innerBoundary is within the box of the outerBoundary.

If the currently-displayed section of the map does not satisfy the inner and outer boundaries, the map will be adjusted accordingly.

Parameters
innerBoundary

The user will not be able to set the map's view such that its borders are within this boundary. In essence, the user will not be able to zoom further zoom into this zone. An invalid BoundingBox indicates no inner boundary.

outerBoundary

The user will not be able to view the map beyond of this boundary. An invalid BoundingBox indicates no outer boundary.

Return:

true if the view boundaries were changed as a result of this call, false otherwise. Boundaries are not changed if the inner boundary is not fully contained within the outer boundary, or if the supplied parameters match the current boundaries for this object.

Since:

BlackBerry 10.2.0

int tilt ()

Retrieves the tilt angle in degrees.

Since:

BlackBerry 10.0.0

Q_INVOKABLE QString url ()

Gets a URL representing the current map view.

Since:

BlackBerry 10.0.0

bb::cascades::maps::ViewProperties viewProperties ()

Gets all the properties of the current view.

Return:

A handle to the viewport properties.

Since:

BlackBerry 10.0.0

bb::platform::geo::Point windowToWorld (
  • const QPoint &windowCoordinates)

Converts window coordinates (pixels) into world coordinates (latitude/longitude).

The origin of the window's coordinates are the upper left corner of the MapView window (not screen), with positive values going right (x axis) and down (y axis).

Parameters
windowCoordinates

The window coordinates to be converted.

Return:

The world coordinates of the given QPoint.

Since:

BlackBerry 10.0.0

QPoint worldToWindow (

Converts world coordinates (latitude/longitude) into window coordinates (pixels).

The origin of the window's coordinates are the upper left corner of the MapView window (not screen), with positive values going right (x axis) and down (y axis).

Parameters
worldCoordinates

The latitude/longitude coordinates to be converted.

Return:

The window coordinates of the given Point.

Since:

BlackBerry 10.0.0

bb::cascades::AbstractA11yObject * accessibility ()Inherited

Returns the accessibility object.

Return:

The accessibility object.

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

Return the current value of the accessibilityMode property.

Return:

The A11yMode of the control.

Since:

BlackBerry 10.2.0

ActionSet * actionSetAt (
  • intindex)
Inherited

Returns an ActionSet at a specified index.

Ownership of the ActionSet object remains with the control.

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 ()Inherited

Returns the number of ActionSet objects.

Return:

The number of ActionSet objects.

Since:

BlackBerry 10.0.0

void addActionSet (Inherited

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.

Parameters
actionSet

The ActionSet to add to the Control.

Since:

BlackBerry 10.0.0

void addAnimation (Inherited

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

void addGestureHandler (Inherited

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 (Inherited

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 (Inherited

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 (Inherited

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.

Since:

BlackBerry 10.0.0

AbstractAnimation * animationAt (
  • intindex)
Inherited

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);
    ...
}
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 ()Inherited

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 ()Inherited

Returns the bottomMargin for the control.

Return:

The bottom margin for the control.

Since:

BlackBerry 10.0.0

float bottomPadding ()Inherited

Returns the bottom padding on the control.

Return:

The bottom padding.

Since:

BlackBerry 10.0.0

Q_INVOKABLE bool builtInShortcutsEnabled ()Inherited

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 ()Inherited

Return:

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

Since:

BlackBerry 10.0.0

Q_INVOKABLE void disableAllShortcuts ()Inherited

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 ()Inherited

Enables all shortcuts attached to the Control.

Since:

BlackBerry 10.1.0

virtual bool event (Inherited

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 ()Inherited

Returns the focusAutoShow property of the control.

Return:

The focusAutoShow state of the control

Since:

BlackBerry 10.0.0

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

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 ()Inherited

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 ()Inherited

Returns the horizontal alignment for the control.

Return:

The horizontal alignment for the control.

Since:

BlackBerry 10.0.0

bool implicitLayoutAnimationsEnabled ()Inherited

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 ()Inherited

Returns the input route properties object.

Return:

The input route properties object.

Since:

BlackBerry 10.1.0

bool isBottomMarginSet ()Inherited

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 ()Inherited

Returns the enabled state of the control.

Return:

true if the control is enabled, false otherwise.

Since:

BlackBerry 10.0.0

bool isFocused ()Inherited

Returns the focused state of the control.

Return:

true if the control is focused, false otherwise.

Since:

BlackBerry 10.0.0

bool isLeftMarginSet ()Inherited

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 isPreferredHeightSet ()Inherited

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 ()Inherited

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 ()Inherited

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 ()Inherited

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 ()Inherited

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.

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

Return:

true if the visual node is visible, false otherwise.

Since:

BlackBerry 10.0.0

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

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 ()Inherited

Returns the number of key listeners.

Return:

The number of key listeners.

Since:

BlackBerry 10.1.0

bb::cascades::LayoutProperties * layoutProperties ()Inherited

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 ()Inherited

Returns the leftMargin for the control.

Return:

The left margin for the control.

Since:

BlackBerry 10.0.0

float leftPadding ()Inherited

Returns the left padding on the control.

Return:

The left padding.

Since:

BlackBerry 10.0.0

Q_SLOT void loseFocus ()Inherited

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

float maxHeight ()Inherited

Returns the maxHeight of the control.

Return:

The maximum height of the control.

Since:

BlackBerry 10.0.0

float maxWidth ()Inherited

Returns the maxWidth of the control.

Return:

The maximum width of the control.

Since:

BlackBerry 10.0.0

float minHeight ()Inherited

Returns the minHeight of the control.

Return:

The minimum height of the control.

Since:

BlackBerry 10.0.0

float minWidth ()Inherited

Returns the minWidth of the control.

Return:

The minimum width of the control.

Since:

BlackBerry 10.0.0

float opacity ()Inherited

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 ()Inherited

Returns the overlap touch policy for the visual node.

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

Return:

The overlap touch policy for the visual node.

Since:

BlackBerry 10.0.0

float pivotX ()Inherited

Returns 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

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 ()Inherited

Returns the position of pivot point of the visual node along the y-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

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 ()Inherited

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 ()Inherited

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 (Inherited

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.

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 ()Inherited

Removes all ActionSet objects from the control and deletes them.

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

Since:

BlackBerry 10.0.0

void removeAllAnimations ()Inherited

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 removeAllGestureHandlers ()Inherited

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

Since:

BlackBerry 10.0.0

Q_INVOKABLE void removeAllKeyListeners ()Inherited

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

Since:

BlackBerry 10.1.0

Q_INVOKABLE void removeAllShortcuts ()Inherited

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

Since:

BlackBerry 10.1.0

void removeAllTouchBehaviors ()Inherited

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

Since:

BlackBerry 10.0.0

bool removeAnimation (Inherited

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

bool removeGestureHandler (Inherited

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 (Inherited

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 (Inherited

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 (Inherited

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.

Since:

BlackBerry 10.0.0

Q_SLOT void requestFocus ()Inherited

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 ()Inherited

Resets the accessibilityMode property to its default value of Default.

Since:

BlackBerry 10.2.0

Q_SLOT void resetBottomMargin ()Inherited

Resets the bottomMargin.

Since:

BlackBerry 10.0.0

Q_SLOT void resetBottomPadding ()Inherited

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 ()Inherited

Resets an builtInShortcutsEnabled property to default value.

Default value is true.

Since:

BlackBerry 10.2.0

Q_SLOT void resetContextMenuHandler ()Inherited

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 ()Inherited

Resets the enabled state of the control to true.

Since:

BlackBerry 10.0.0

Q_SLOT void resetFocusAutoShow ()Inherited

Resets the focusAutoShow to its default value.

Since:

BlackBerry 10.0.0

Q_SLOT void resetFocusPolicy ()Inherited

Resets the focusPolicy to its default value of FOCUSPOLICY_NONE.

Since:

BlackBerry 10.0.0

Q_SLOT void resetFocusRetentionPolicyFlags ()Inherited

Reset the focus retention policy to default value.

Since:

BlackBerry 10.0.0

Q_SLOT void resetHorizontalAlignment ()Inherited

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 ()Inherited

Resets the implicitLayoutAnimationsEnabled property to its default value.

Since:

BlackBerry 10.0.0

Q_SLOT void resetLayoutProperties ()Inherited

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

Since:

BlackBerry 10.0.0

Q_SLOT void resetLeftMargin ()Inherited

Resets the leftMargin.

Since:

BlackBerry 10.0.0

Q_SLOT void resetLeftPadding ()Inherited

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 resetMaxHeight ()Inherited

Resets the maxHeight of the control.

Since:

BlackBerry 10.0.0

Q_SLOT void resetMaxWidth ()Inherited

Resets the maxWidth of the control.

Since:

BlackBerry 10.0.0

Q_SLOT void resetMinHeight ()Inherited

Resets the minHeight of the control.

Since:

BlackBerry 10.0.0

Q_SLOT void resetMinWidth ()Inherited

Resets the minWidth of the control.

Since:

BlackBerry 10.0.0

Q_SLOT void resetOpacity ()Inherited

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 ()Inherited

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

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

Since:

BlackBerry 10.0.0

Q_SLOT void resetPivot ()Inherited

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

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

Since:

BlackBerry 10.0.0

Q_SLOT void resetPivotX ()Inherited

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

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

See also:

resetPivot()

Since:

BlackBerry 10.0.0

Q_SLOT void resetPivotY ()Inherited

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

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

See also:

resetPivot()

Since:

BlackBerry 10.0.0

Q_SLOT void resetPreferredHeight ()Inherited

Resets the preferredHeight to its default value of 0.

Since:

BlackBerry 10.0.0

Q_SLOT void resetPreferredSize ()Inherited

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 ()Inherited

Resets the preferredWidth to its default value of 0.

Since:

BlackBerry 10.0.0

Q_SLOT void resetRightMargin ()Inherited

Resets the rightMargin.

Since:

BlackBerry 10.0.0

Q_SLOT void resetRightPadding ()Inherited

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 ()Inherited

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 ()Inherited

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

Since:

BlackBerry 10.0.0

Q_SLOT void resetScaleX ()Inherited

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 ()Inherited

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 ()Inherited

Resets the topMargin.

Since:

BlackBerry 10.0.0

Q_SLOT void resetTopPadding ()Inherited

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 ()Inherited

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::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 ()Inherited

Convenience function for resetting the translation along all axes.

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

Since:

BlackBerry 10.0.0

Q_SLOT void resetTranslationX ()Inherited

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.

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

Since:

BlackBerry 10.0.0

Q_SLOT void resetTranslationY ()Inherited

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.

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

Since:

BlackBerry 10.0.0

Q_SLOT void resetVerticalAlignment ()Inherited

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 ()Inherited

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.

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

Since:

BlackBerry 10.0.0

float rightMargin ()Inherited

Returns the rightMargin for the control.

Return:

The right margin for the control.

Since:

BlackBerry 10.0.0

float rightPadding ()Inherited

Returns the right padding on the control.

Return:

The right padding.

Since:

BlackBerry 10.0.0

float rotationZ ()Inherited

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 ()Inherited

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 ()Inherited

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 (Inherited

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)
Inherited

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)
Inherited

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 (Inherited

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)
Inherited

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 (Inherited

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)
Inherited

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 (Inherited

Sets the focusAutoShow of the control.

Parameters
focusAutoShow

The focusAutoShow state of the Control.

Since:

BlackBerry 10.0.0

Q_SLOT void setFocusPolicy (Inherited

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)
Inherited

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 (Inherited

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)
Inherited

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 (Inherited

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)
Inherited

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)
Inherited

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 setMaxHeight (
  • floatmaxHeight)
Inherited

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)
Inherited

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)
Inherited

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)
Inherited

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 (Inherited

Sets the objectName property.

Parameters
name

The new name for the object.

Since:

BlackBerry 10.0.0

Q_SLOT void setOpacity (
  • floatopacity)
Inherited

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 (Inherited

Sets the overlap touch policy for the visual node.

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

Parameters
policy

The new overlap touch policy for the visual node.

Since:

BlackBerry 10.0.0

Q_SLOT void setPivot (
  • floatpivotX,
  • floatpivotY )
Inherited

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

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

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)
Inherited

Sets 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

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)
Inherited

Sets the position of pivot point of the visual node along the y-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

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)
Inherited

Sets the preferredHeight of the control.

Parameters
preferredHeight

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

Since:

BlackBerry 10.0.0

Q_SLOT void setPreferredSize (
  • floatpreferredWidth,
  • floatpreferredHeight )
Inherited

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)
Inherited

Sets the preferredWidth of the control.

Parameters
preferredWidth

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

Since:

BlackBerry 10.0.0

Q_SLOT void setRightMargin (
  • floatrightMargin)
Inherited

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)
Inherited

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)
Inherited

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).

Since:

BlackBerry 10.0.0

Q_SLOT void setScale (
  • floatscaleX,
  • floatscaleY )
Inherited

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)
Inherited

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)
Inherited

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

Parameters
scaleX

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

Since:

BlackBerry 10.0.0

Q_SLOT void setScaleY (
  • floatscaleY)
Inherited

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)
Inherited

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)
Inherited

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 (Inherited

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::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 )
Inherited

Convenience function for setting the translation along all axes.

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

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)
Inherited

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.

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

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)
Inherited

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.

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

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 (Inherited

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)
Inherited

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.

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

Parameters
visible

True to make the visual node visible, false otherwise.

Since:

BlackBerry 10.0.0

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

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 ()Inherited

Returns the number of shortcuts.

Return:

The number of shortcuts.

Since:

BlackBerry 10.1.0

bb::cascades::Spacings * softMargin ()Inherited

Get the soft margin for Custom Control object.

Using the returned Spacings object it is possible to get or set the soft margin offset values.

Return:

A pointer to a Spacings object.

Since:

BlackBerry 10.2.0

virtual Q_INVOKABLE QString toDebugString ()Inherited

Returns a debug string representing this object.

Return:

A debug string for the object.

Since:

BlackBerry 10.0.0

float topMargin ()Inherited

Returns the topMargin for the control.

Return:

The top margin for the control.

Since:

BlackBerry 10.0.0

float topPadding ()Inherited

Returns the top padding on the control.

Return:

The top padding.

Since:

BlackBerry 10.0.0

TouchPropagationMode::Type touchPropagationMode ()Inherited

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::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 ()Inherited

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.

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

Return:

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

Since:

BlackBerry 10.0.0

float translationY ()Inherited

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.

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

Return:

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

Since:

BlackBerry 10.0.0

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

Returns the vertical alignment for the control.

Return:

The vertical alignment for the control.

Since:

BlackBerry 10.0.0

Protected Functions

(Only has inherited protected functions)

BaseObject (Inherited

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)
Inherited

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

CustomControl (Inherited

Constructs a CustomControl.

If not 0, the ownership of the constructed CustomControl will be transferred to the parent.

Parameters
parent

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

Since:

BlackBerry 10.0.0

virtual void disconnectNotify (
  • const char *signal)
Inherited

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

bb::cascades::VisualNode * root ()Inherited

Gets the root VisualNode of the CustomControl.

Return:

The root of the VisualNode tree of the CustomControl. The CustomControl still owns the root VisualNode.

Since:

BlackBerry 10.0.0

void setAccessibility (Inherited

Sets an accessibility object for this control.

Once completed, ownership of the accessibility object is assigned to the custom control.

Unlike controls with built-in accessibility objects which can't overridden, this class allows overriding the default accessibility object with a custom one, typically a CustomA11yObject

The accessibility object is expected to be set once (for example when assistive technology is enabled).

Parameters
accessibility

new accessibility object

Since:

BlackBerry 10.2.0

void setRoot (Inherited

Sets the root VisualNode of the CustomControl.

The CustomControl will take over ownership of the new root. The old root, if there is one, will be replaced but is not deleted. The CustomControl will still retain ownership of the old root.

Parameters
root

The root of the VisualNode tree of the CustomControl.

Since:

BlackBerry 10.0.0

Signals

void altitudeChanged (
  • doublenewAlt)

Emitted when the view's altitude has changed.

Since:

BlackBerry 10.0.0

void altitudeModeChanged (

Emitted when the view's altitude mode has changed.

Since:

BlackBerry 10.0.0

void captionButtonClicked ()

Emitted when the button on the focused geographic caption bubble is clicked.

Since:

BlackBerry 10.0.0

void captionContentChanged (

Emitted when the caption's content container changes.

Since:

BlackBerry 10.2.0

void captionLabelTapped (

Emitted when the text label on the focused geographic caption bubble is tapped.

Since:

BlackBerry 10.0.0

void focusedIdChanged (

Emitted when the element with focus has changed.

Since:

BlackBerry 10.0.0

void followedIdChanged (

Emitted when followed ID has changed.

Since:

BlackBerry 10.0.0

void headingChanged (
  • doublenewHeading)

Emitted when the view's heading has changed.

Since:

BlackBerry 10.0.0

void inlineTrafficAvailableChanged (
  • boolavailable)

Emitted when the availability of inline traffic data changes for the current map view.

Parameters
enabled

true if inline traffic is available, false otherwise.

Since:

BlackBerry 10.2.0

void inlineTrafficEnabledChanged (
  • boolenabled)

Emitted when the enabled state for inline traffic mapping changes.

Parameters
enabled

true if inline traffic is enabled, false otherwise.

Since:

BlackBerry 10.2.0

void inlineTrafficSupportedChanged (
  • boolsupported)

Emitted when the support for inline traffic mapping changes.

Parameters
enabled

true if inline traffic is supported, false otherwise.

Since:

BlackBerry 10.2.0

void latitudeChanged (
  • doublenewLat)

Emitted when the view's latitude has changed.

Since:

BlackBerry 10.0.0

void locationLongPressed (

Emitted when an element has had a long-press performed on it.

Listeners should show actions available for this element. For example, show crosscut menu.

Parameters
id

The ID of the GeoLocation that was interacted with.

Since:

BlackBerry 10.0.0

void locationTapped (

Emitted whenever a Geographic is tapped.

Listeners should show additional information associated with this element. For example, display details.

Parameters
id

The ID of the location that was tapped.

Since:

BlackBerry 10.0.0

void longitudeChanged (
  • doublenewLon)

Emitted when the view's longitude has changed.

Since:

BlackBerry 10.0.0

void mapDataChanged (

Emitted when the MapData changes.

Since:

BlackBerry 10.2.0

void mapLongPressed (

Emitted when a long press has occurred on the map.

This differs from locationLongPressed in that this signal is generated when a long press occurs at a location not associated with a GeoLocation. Whereas locationLongPressed is generated when a long press occurs on a GeoLocation.

Parameters
coordinates

The world coordinates where the long press occurred.

Since:

BlackBerry 10.0.0

void requestRender ()

Initiates a new render.

(Asynchronous)

Since:

BlackBerry 10.0.0

void tiltChanged (
  • intnewTilt)

Emitted when the view's tilt angle has changed.

Since:

BlackBerry 10.0.0

void accessibilityModeChanged (Inherited

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 (Inherited

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 (Inherited

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)
Inherited

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)
Inherited

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)
Inherited

Emitted when the bottomPadding property changes.

Parameters
bottomPadding

The new bottom padding.

Since:

BlackBerry 10.0.0

void builtInShortcutsEnabledChanged (
  • boolbuiltInShortcutsEnabled)
Inherited

Emitted when the builtInShortcutsEnabled property changes.

Parameters
builtInShortcutsEnabled

The new value.

Since:

BlackBerry 10.2.0

void contextMenuHandlerChanged (Inherited

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 ()Inherited

This signal is emitted only when this object is instantiated as a result of loading a QML document and creating the root node, or when an object is being constructed using its builder class.

This signal is emitted only 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 is emitted to indicate 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)
Inherited

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 (Inherited

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)
Inherited

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 (Inherited

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)
Inherited

Emitted when the focusRetentionPolicyFlags property on the control changes.

Parameters
policy

The new focusRetentionPolicy.

Since:

BlackBerry 10.0.0

void horizontalAlignmentChanged (Inherited

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)
Inherited

Emitted when the implicitLayoutAnimationsEnabled property on the control changes.

Parameters
implicitLayoutAnimationsEnabled

The new value.

Since:

BlackBerry 10.0.0

void layoutPropertiesChanged (Inherited

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)
Inherited

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)
Inherited

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)
Inherited

Emitted when the leftPadding property changes.

Parameters
leftPadding

The new left padding.

Since:

BlackBerry 10.0.0

void maxHeightChanged (
  • floatmaxHeight)
Inherited

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)
Inherited

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)
Inherited

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)
Inherited

Emitted when the minWidth of the control changes.

Parameters
minWidth

The new minimum width for the control.

Since:

BlackBerry 10.0.0

void objectNameChanged (Inherited

This signal is emitted when the objectName property is changed.

Since:

BlackBerry 10.0.0

void opacityChanged (
  • floatopacity)
Inherited

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)
Inherited

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 (Inherited

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

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

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)
Inherited

Emitted after pivotX of the visual node has changed.

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

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)
Inherited

Emitted after pivotY of the visual node has changed.

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

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)
Inherited

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)
Inherited

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)
Inherited

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)
Inherited

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)
Inherited

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)
Inherited

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)
Inherited

Emitted when the rightPadding property changes.

Parameters
rightPadding

The new right padding.

Since:

BlackBerry 10.0.0

void rotationZChanged (
  • floatrotationZ)
Inherited

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.

Since:

BlackBerry 10.0.0

void rotationZChanging (
  • floatrotationZ)
Inherited

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.

Since:

BlackBerry 10.0.0

void scaleXChanged (
  • floatscaleX)
Inherited

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.

Since:

BlackBerry 10.0.0

void scaleXChanging (
  • floatscaleX)
Inherited

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)
Inherited

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.

Since:

BlackBerry 10.0.0

void scaleYChanging (
  • floatscaleY)
Inherited

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)
Inherited

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)
Inherited

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)
Inherited

Emitted when the topPadding property changes.

Parameters
topPadding

The new top padding.

Since:

BlackBerry 10.0.0

void touch (Inherited

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 (Inherited

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 (Inherited

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 (Inherited

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 (Inherited

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::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)
Inherited

Emitted after translationX of the visual node has changed.

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

Parameters
translationX

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

Since:

BlackBerry 10.0.0

void translationXChanging (
  • floattranslationX)
Inherited

Emitted while translationX of the visual node is changing.

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

Parameters
translationX

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

Since:

BlackBerry 10.0.0

void translationYChanged (
  • floattranslationY)
Inherited

Emitted after translationY of the visual node has changed.

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

Parameters
translationY

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

Since:

BlackBerry 10.0.0

void translationYChanging (
  • floattranslationY)
Inherited

Emitted while translationY of the visual node is changing.

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

Parameters
translationY

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

Since:

BlackBerry 10.0.0

void verticalAlignmentChanged (Inherited

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)
Inherited

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.

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

Parameters
visible

The new visible property set on the visual node.

Since:

BlackBerry 10.0.0

Last modified: 2014-03-13

comments powered by Disqus