cascades

Classes

AbstractAccessibilityObject

AccessibleRole

Represents different accessible roles, which specifies the role of a accessibility object.

AbstractAnimation

Abstract class containing properties inherited by all animations.

AbstractTransition

Abstract class containing properties inherited by all transitions.

AnimationRepeatCount

Defines useful constants for animation repeat count.

AnimationState

States of an animation, like stopped, started, and ended.

EasingCurve

An abstract class for easing curves that are used with animations.

FadeTransition

An animation that controls the opacity of a VisualNode.

GroupAnimation

Abstract class containing properties exposed to group animations.

ImplicitAnimationController

Controls implicit (automatic) property animations.

ParallelAnimation

A group animation that plays its children animations in parallel.

RotateTransition

An animation that rotates a VisualNode around its z-axis.

ScaleTransition

An animation that scales the size of a VisualNode.

SequentialAnimation

A group animation that plays its children animations sequentially.

StockCurve

A set of defined easing curves used for animating properties.

TranslateTransition

An animation that controls the position of a VisualNode.

Application

The class provides an event loop and handles application's menu scene, and main window.

AbstractButton

A clickable abstract button.

AbstractDialog

A base class for UI elements that represent full-screen view.

AbstractPane

An abstract class that provides functionality for inherited page and pane classes.

AbstractTextControl

Abstract base class for all text controls.

AbstractToggleButton

An abstract control that can switch between two possible states.

ActionBarPlacement

A class representing action bar placement options.

ActionMenuVisualState

The visual states for the action menu.

ActivityIndicator

A control that indicates that a process is being completed.

Button

A clickable button with a fixed height and an optional image and text.

CheckBox

A checkbox control with two states: checked or unchecked.

ChromeVisibility

A set of visibility modes for the action bar and TitleBar.

Container

A container that can be used for grouping controls and other containers.

Control

Base class for all UI controls.

CustomControl

A base class that is used for creating custom controls.

CustomListItem

Represents a list item with a highlight, a divider, and user-specified content.

DateTimePicker

A control for selecting a date or time.

DateTimePickerMode

Represents the modes used for the DateTimePicker.

Dialog

A class that represents a full-screen view as a dialog.

Divider

A horizontal divider.

DropDown

A control that allows users to select an option from a drop-down.

FlickMode

Represents different types of flick modes for a ListView.

FocusAutoShow

Represents different behaviors for a control when it receives focus.

FocusPolicy

Represents different focus policies, which specify how a control can receive focus from a user's interation.

FocusRetentionPolicy

Specifies the conditions under which a control can lose focus when the user interacts with other controls.

ForeignWindowControl

Allows for embedding a foreign libscreen window into the Cascades scenegraph.

Header

A header that is used for grouping, or clustering items within a list.

HighlightAppearance

Represents a highlight appearance for a CustomListItem.

ImageButton

A clickable button with a visual representation for each state.

ImageToggleButton

A toggle button with a visual representation for each state.

ImageView

A visual control that is used for displaying images.

ImageViewLoadEffect

Load effects for images in an ImageView.

SubmitKey

A class containing different values used for the Submit key.

SubmitKeyFocusBehavior

A class representing different submit key focus behaviors.

TextInputFlag

Flags for turning on and off different text features (for example, spell check).

TextInputMasking

A class representing different input masking modes.

TextInputProperties

Specifies text input properties for text input controls.

InputRouteProperties

Optional group of properties that can be set on controls to define their role in the propagation of input events and influence the default routing logic.

Label

A non interactive label with one line of text.

LabelAutoSizeProperties

Represents the auto size properties of a Label.

ListItemListener

An optional interface for VisualNodes used as items in a ListView.

ListItemProvider

An interface for providing VisualNode objects as items in a ListView.

ListItemTypeMapper

An interface for determining the type of each item in a ListView.

ListScrollStateHandler

Listens for scroll state changes on a ListView.

ListView

A scrollable container used to display a list of items.

ListViewStickToEdgePolicy

Represents the different policies of maintaining edge positions for the ListView.

NavigationPane

A class that is used for stack-like navigation between Page objects.

Option

An option that can be used in a list of selectable items.

Page

Defines an individual screen within an application.

PageResizeBehavior

The different ways that a Page can be resized when the available screen space is affected by external components (for example, when the keyboard appears).

Picker

A control for selecting custom items such as text, images or colors.

PickerKind

A class representing different kinds of Picker controls.

PickerProvider

An interface for providing VisualNode objects as items in a Picker.

ProgressIndicator

A control that is used to measure the progress of a specified process.

ProgressIndicatorState

Represents the different states of a progress indicator.

RadioGroup

Used for grouping a set of Option controls.

ScalingMethod

A set of methods that specify how an image should be scaled.

ScrollIndicatorMode

Represents different types of scroll indicator modes.

ScrollMode

Represents different types of scrolling modes.

ScrollPosition

Represents different scroll positions used in a list.

ScrollRailsPolicy

Rails policies that can be applied to the scrolling behavior of a scrollable control (for example, a ScrollView).

ScrollView

A container class that enables scrolling and zooming of its content.

SegmentedControl

A control that displays a horizontal row of selectable options.

Sheet

A class that represents a full-screen view as a layer.

SidebarState

The visibility states for the Tab menu.

SidebarVisualState

The visual states for the sidebar.

Slider

A control that allows for selection of a value from a range of values.

SnapMode

Represents different types of snap modes for a ListView.

Spacings

A description of the white space allocated adjacent to the border of a component, inside or outside.

StandardListItem

An item with a set of common properties to be displayed in a list.

StandardPickerItem

An item with a set of common properties to be displayed in a Picker.

TabbedPane

A navigation control that allows the user to switch between tabs.

TextArea

A multi-line text control for displaying and editing text.

TextContentFlag

Flags for enabling or disabling text features.

TextContentProperties

Use for specifying different text content properties for text controls.

TextEditor

Use for text selection and editing.

TextField

A single-line text control with a button that clears the field.

TextFormat

Defines how a text control should interpret its provided string.

ToggleButton

A fixed-size switch control with two states: checked or unchecked.

WebView

A control that is used to display dynamic web content.

AbstractCover

Abstract base class for cover implementations.

AbstractGestureEvent

This is the base class for all gesture events.

AbstractShortcut

The base class for all shortcut subclasses.

ActiveTextHandler

A handler for active text interaction.

ActiveTextTriggeredEvent

An event indicating that an active text has been activated.

ApplicationViewCover

Cover which displays a scaled down or cropped version of the app as cover.

BaseObject

The base object for the classes in the framework.

ColorTheme

A class representing the color configurations of the theme.

ContextMenuHandler

A handler for communicating with the Context Menu.

ContextMenuShowingEvent

An event indicating that the Context menu is about to be displayed.

ContextMenuVisualState

The visual states for the context menu.

DisplayDirection

Represents the display direction of the device's screen plane.

DoubleTapEvent

Double tap events are emitted when the user performs a double tap gesture.

DoubleTapHandler

A double tap handler can be used to react to double tap gesture.

Event

Base class for events.

EventReaction

Abstract base class for all event reactions.

GestureHandler

A base class for all gesture handlers which can be used to react to various gestures.

KeyEvent

An event indicating that a key has been pressed or released.

KeyListener

Enables controls to be notified on key events that are introduced by user interaction with the keyboard.

LongPressEvent

Long press events are emitted when the user performs a long press gesture.

LongPressHandler

A long press handler can be used to react to long press gestures.

Menu

A menu that contains important application-wide actions.

OrientationSupport

Provides support for display and UI orientation changes.

OverlapTouchPolicy

Specifies whether overlapped nodes receive touch interaction.

PinchEvent

Pinch events are emitted when the user performs a pinch gesture.

PinchHandler

A pinch handler can be used to react to pinch gesture.

PropagationPhase

Represents different event propagation phases.

RenderFence

Provides a way to get notified when current changes to the scene associated with particular window have been rendered.

RenderFenceState

A class representing RenderFence states.

SceneCover

Renders a non-interactive scene graph that is displayed when the application is in cover mode.

ScreenIdleMode

Represents the choices in how the screen idle behavior can be controlled.

Shortcut

Represents a shortcut that can be invoked on objects that inherit from Control, AbstractPane, and AbstractActionItem.

SupportedDisplayOrientation

Represents display orientations supported by the application.

SystemShortcut

Represents a Shortcut that can be invoked on objects that inherit from Control, AbstractPane, and AbstractActionItem.

SystemShortcuts

Enumeration for shortcuts defined in the QNX platform.

TapEvent

Tap events are emitted when the user performs a tap gesture.

TapHandler

A tap handler can be used to react to tap gestures.

Theme

A class representing the application theme, which can consist of different elements, such as color values.

ThemeSupport

A class containing theme related functionality.

TouchBehavior

A series of touch-input reactions that can be added to a VisualNode.

TouchEnterEvent

The touch enter event is sent as parameter to the touchEnter signal from VisualNode.

TouchEvent

Touch events are emitted when the user touches the screen.

TouchExitEvent

The touch exit event is sent as parameter to the touchExit signal from VisualNode.

TouchPropagationMode

Enumeration for specifying the touch propagation mode for a node and it's subtree.

TouchReaction

Touch reactions are used to build up touch behaviors.

TouchResponse

Represents different touch responses used for event reactions.

TouchType

Represents different touch types.

UIObject

The base for all Cascades UI classes.

UIOrientation

Represents the orientation of the UI.

Validator

A default validation class used to validate any Control.

VisualNode

A visual node in the scene graph.

VisualStyle

A class representing a theme's overall visual color style.

Window

Provides access to native window properties and state.

WindowProperty

A class representing window properties and their combinations.

WindowState

A class representing window lifecycle states.

ArrayDataModel

Contains a list of QVariant values, typically for a ListView.

DataModel

An abstract class that can be used to provide a ListView with data.

DataModelChangeType

Represents different types of data model changes.

GroupDataModel

A data model to be used with a ListView.

ItemGrouping

Represents different ways of grouping items in a GroupDataModel.

QListDataModel

Contains a list of <Item> values, typically for a ListView.

XmlDataModel

A class that creates a static DataModel for ListView from an XML file.

AdaptableExtensionPlugin

A base class for asset selection aware QML extension plugins.

AbsoluteLayout

A Layout that allows you to set X and Y coordinates for controls.

AbsoluteLayoutProperties

LayoutProperties that can be assigned to controls in an AbsoluteLayout.

DockLayout

A Layout that docks children to a specified area of the container.

FlowListLayout

A layout used to fill rows and columns based on available space.

FlowListLayoutProperties

Layout properties that are assigned to controls in a FlowListLayout.

GridListLayout

A layout used with ListView to lay out items in a grid.

HorizontalAlignment

Ways to horizontally align a control within its parent container.

Layout

Abstract base class inherited by all layouts.

LayoutOrientation

The different orientations that can be used for layouts.

LayoutProperties

Abstract base class inherited by all layout properties classes.

LayoutUpdateHandler

Used for listening to layout and sizing changes on a control.

ListHeaderMode

Specifies header modes for list layouts.

ListLayout

Abstract base class for list layouts.

StackLayout

A layout that is used to position a container's children in a stack.

StackLayoutProperties

LayoutProperties that are assigned to controls within a StackLayout.

StackListLayout

A layout used with ListView to lay out children in a simple stack.

VerticalAlignment

Ways to vertically align a control within its parent container.

AbstractActionItem

The base class for all action item subclasses.

AbstractContentSecurity

The base class for all content security subclasses.

AbstractTextFilter

The base class for all text filter subclasses.

AbstractTitleBarKindProperties

An abstract base class inherited by all title bar kind properties classes.

ActionBarAutoHideBehavior

Specifies the auto-hide behavior for a page's action bar.

ActionItem

Represents an action that can be invoked on a page.

ActionSet

Used to group a set of actions to be displayed in the Context Menu.

Color

An implementation of Paint that represents a color with alpha channel.

ColorPaint

A representation of a color.

ContentSecurity

Allows for associating a control with a security perimeter.

DeleteActionItem

The DeleteActionItem is used to specify that an action is a "destructive" action.

FontSize

Represents the types of font sizes for a TextStyle.

FontStyle

Represents a set of font styles for a TextStyle.

FontWeight

Represents the types of font weights for a TextStyle.

FreeFormTitleBarKindProperties

A class that groups properties associated with the FreeForm type of TitleBar.

HelpActionItem

A Help action to add to a Menu.

Image

An image resource, the source of which might not be known.

ImageAnimator

A class that can be used to control the animation of an animated image (typically a .gif animation).

ImageAnimatorAnchor

A set of anchor configurations to use with ImageAnimator.

ImageAnimatorSeekMode

A set of seek mode configurations to use with ImageAnimator.

ImagePaint

A representation of a image that can be used as a fill.

ImageTracker

Provides access to state and size changes associated with an Image.

Invocation

Represents an invocation which can be triggered from program code.

InvokeActionItem

Represents actions for invoking application-level components.

InvokeHandler

Communicates with the caller when an action item is ready to invoke the target.

InvokeQuery

Contains the query data to use in invoke items.

InvokeState

The different states of an invocation.

LocaleHandler

Enables dynamic translation and locale updates in C++ and QML.

MultiSelectActionItem

The multi-select action is used to start a multiple selection session.

MultiSelectHandler

A handler used during multiple selection to populate the Context Menu.

NavigationPaneProperties

A class to specify properties on a child pane of a NavigationPane.

OverScrollEffectMode

Represents a set of states for overscroll effects in a ScrollView.

Paint

An abstract class representing a type of fill.

PaneProperties

An abstract base class inherited by all pane properties classes.

QmlDocument

Represents a QML document that can be loaded into a C++ application.

RepeatPattern

Specifies how and if an image should be repeated within a container.

Resource

Abstract base class inherited by all resources.

ResourceState

Exposes resource state enum to QML.

ResourceTracker

Abstract base class inherited by all resource trackers.

ScrollAnimation

Represents a set of animations for a ScrollView.

ScrollRole

Specifies the scrollRole of a scrollable Control.

ScrollViewProperties

A set of behavioral properties that can be applied to a ScrollView.

SettingsActionItem

A Settings action to add to a Menu.

SingleLineTextFilter

A text filter that prevents line breaks from being added to text in a text control.

SystemDefaults

Provides access to system defaults for texts and colors.

Tab

A tab that can be added to a TabbedPane.

TextAlign

A set of text alignment configurations to use with text controls.

TextAreaInputMode

Represents a text input mode for the TextArea.

TextAreaScrollMode

Represents a scoll mode for the TextArea.

TextAutoFit

A set of configurations that specify dynamic font size behaviour to use with the TextField control.

TextFieldInputMode

Represents a text input mode for the TextField.

TextStyle

Represents a text style that defines how a text is rendered.

TextStyleDefinition

Used to define style sets for sets of text nodes in an application.

TitleBar

Defines a title bar on a page.

TitleBarAppearance

A class that represents different appearances for the TitleBar.

TitleBarExpandableArea

Describes an expandable area, such as FreeFormTitleBarProperties.

TitleBarExpandableAreaIndicatorVisibility

A class that represents different visible states for the expandable indicator on the TitleBar.

TitleBarExpandableAreaToggleArea

A class that represents different toggle area for the title bar expandable area.

TitleBarKind

A class that represents the different types of a TitleBar.

TitleBarScrollBehavior

Represents the different types of scroll behavior used for the TitleBar.

TriBool

A Boolean data type that allows for a third value called Undefined.

ValidationMode

Represents a validation mode.

ValidationState

Represents the validation state of the Validator.

JavaScriptWorld

The execution environment in which calls to evaluateJavaScript should run.

WebCookieJar

The cookie database for the WebView control.

WebDownloadRequest

A request to download a file.

WebFindFlag

A class to wrap a set of flags that can be passed into findText().

WebLoadRequest

A utility class for the loadingChanged() signal.

WebLoadStatus

The load status of a WebLoadRequest.

WebNavigationRequest

A utility class for the WebView::navigationRequested() signal.

WebNavigationRequestAction

The response action of a navigation request.

WebNavigationType

The type of navigation from one location to another.

WebPage

A webpage that can be used when the app needs to interact with web content but not display it.

WebPageCompositor

A class that composites the internal scene graph of a WebPage.

WebPageEventHandler

A class that injects events into a WebPage.

WebPageTexture

The texture that can be used as a render target when compositing the internal scene graph of a webpage.

WebResourceRequest

A resource being requested by a WebView.

WebResourceRequestFilter

A class that exposes control over the networking layer of a WebPage.

WebSettings

Settings for the WebView control.

WebStorage

Utilities for accessing the storage for a WebView control.

ListItemComponent

Specifies a QML template used by a ListView to display items.

PickerItemComponent

Specifies a QML template used by a Picker to display items.

Delegate

Provides a generic delegate that instantiate an object when active and deletes it when it is not active.

QmlComponentDefinition

Provides a way to dynamically define QML Components.

QmlControlDelegate

Provides a delegate for a dynamically loaded control.

QmlOrientationHandler

This class is used for defining an orientation handler for orientation-related events in QML.

QmlQObject

This class is used to define QtObjects.

TabDelegateActivationPolicy

Specifies when a tab should set the active property of its delegate.

ImagePaintDefinition

A definition of an ImagePaint to use as a background image.

QmlRetranslate

Enables dynamic translation and locale updates in QML.

Functions Index

BBCASCADES_EXPORT QDebugoperator<< (QDebug dbg, const AbstractGestureEvent &abstractGestureEvent)
BBCASCADES_EXPORT QDebugoperator<< (QDebug dbg, const ActiveTextTriggeredEvent &ActiveTextTriggeredEvent)
BBCASCADES_EXPORT QDebugoperator<< (QDebug dbg, const BaseObject &base)
BBCASCADES_EXPORT QDebugoperator<< (QDebug dbg, const ContextMenuShowingEvent &contextMenuShowingEvent)
BBCASCADES_EXPORT QDebugoperator<< (QDebug dbg, const Event &event)
BBCASCADES_EXPORT QDebugoperator<< (QDebug dbg, const KeyEvent &keyEvent)
BBCASCADES_EXPORT QDebugoperator<< (QDebug dbg, const PinchEvent &pinchEvent)
BBCASCADES_EXPORT QDebugoperator<< (QDebug dbg, RenderFenceState::Type state)
BBCASCADES_EXPORT QDebugoperator<< (QDebug dbg, ScreenIdleMode::Type screenIdleMode)
BBCASCADES_EXPORT QDebugoperator<< (QDebug dbg, const TouchEvent &touchEvent)
BBCASCADES_EXPORT QDebugoperator<< (QDebug dbg, bb::cascades::VisualStyle::Type visualStyle)
BBCASCADES_EXPORT QDebugoperator<< (QDebug dbg, WindowState::Type state)
BBCASCADES_EXPORT QDebugoperator<< (QDebug dbg, const Color &color)
BBCASCADES_EXPORT QDebugoperator<< (QDebug dbg, const Image &image)
BBCASCADES_EXPORT QDebugoperator<< (QDebug dbg, const ImagePaint &paint)
BBCASCADES_EXPORT QDebugoperator<< (QDebug dbg, RepeatPattern::Type pattern)

Typedefs

typedef QListDataModel< QVariant > QVariantListDataModel

The QVariantListDataModel is a shortcut for QListDataModel<QVariant>

Since:

BlackBerry 10.0.0

typedef QListDataModel< QString > QStringListDataModel

The QStringListDataModel is a shortcut for QListDataModel<QString>

Since:

BlackBerry 10.0.0

typedef QListDataModel< QVariantMap > QMapListDataModel

The QMapListDataModel is a shortcut for QListDataModel<QVariantMap>

Since:

BlackBerry 10.0.0

Functions

BBCASCADES_EXPORT QDebug operator<< (

Streams debug output about a AbstractGestureEvent to the QDebug stream object.

Parameters
dbg

The QDebug stream.

abstractGestureEvent

The AbstractGestureEvent to output debug information about.

Return:

Returns the QDebug stream.

BBCASCADES_EXPORT QDebug operator<< (

Streams debug output about an ActiveTextTriggeredEvent to the QDebug stream object.

Parameters
dbg

The QDebug stream.

ActiveTextTriggeredEvent

The ActiveTextTriggeredEvent whose debug information will be output.

Return:

The QDebug stream.

BBCASCADES_EXPORT QDebug operator<< (

BBCASCADES_EXPORT QDebug operator<< (

Streams debug output about a ContextMenuShowingEvent to the QDebug stream object.

Parameters
dbg

The QDebug stream.

contextMenuShowingEvent

The ContextMenuShowingEvent to output debug information about.

Return:

The QDebug stream.

BBCASCADES_EXPORT QDebug operator<< (

Streams debug output about an Event to the QDebug stream object.

Parameters
dbg

The QDebug stream.

event

The Event to output debug information about.

Return:

The QDebug stream.

BBCASCADES_EXPORT QDebug operator<< (

BBCASCADES_EXPORT QDebug operator<< (

Streams debug output about a PinchEvent to the QDebug stream object.

Parameters
dbg

The QDebug stream.

pinchEvent

The PinchEvent to output debug information about.

Return:

The QDebug stream.

BBCASCADES_EXPORT QDebug operator<< (

Streams debug output about the pattern to the QDebug stream object.

Parameters
dbg

The QDebug stream.

state

The state to output debug information about.

Return:

The QDebug stream.

BBCASCADES_EXPORT QDebug operator<< (

Streams debug output about the pattern to the QDebug stream object.

Parameters
dbg

The QDebug stream.

screenIdleMode

The state to output debug information about.

Return:

The QDebug stream.

BBCASCADES_EXPORT QDebug operator<< (

Streams debug output about a TouchEvent to the QDebug stream object.

Parameters
dbg

The QDebug stream.

touchEvent

The TouchEvent to output debug information about.

Return:

The QDebug stream.

BBCASCADES_EXPORT QDebug operator<< (

Streams debug output about the pattern to the QDebug stream object.

Parameters
dbg

The QDebug stream.

visualStyle

The VisualStyle to output debug information about.

Return:

The QDebug stream.

BBCASCADES_EXPORT QDebug operator<< (

Streams debug output about the pattern to the QDebug stream object.

Parameters
dbg

The QDebug stream.

state

The state to output debug information about.

Return:

The QDebug stream.

BBCASCADES_EXPORT QDebug operator<< (

Streams debug output about the color to the QDebug stream object.

Color c = Color::Red;
qDebug() << c;
Parameters
dbg

The QDebug stream.

color

The color to output debug information about.

Return:

The QDebug stream.

BBCASCADES_EXPORT QDebug operator<< (

Streams debug output about the image to the QDebug stream object.

Parameters
dbg

The QDebug stream.

image

The image to output debug information about.

Return:

The QDebug stream.

BBCASCADES_EXPORT QDebug operator<< (

Streams debug output about the paint to the QDebug stream object.

ImagePaint ip(Image("core16x16"), RepeatPattern::XY);
qDebug() << ip;
Parameters
dbg

The QDebug stream.

paint

The paint to output debug information about.

Return:

The QDebug stream.

BBCASCADES_EXPORT QDebug operator<< (

Streams debug output about the pattern to the QDebug stream object.

Parameters
dbg

The QDebug stream.

pattern

The pattern to output debug information about.

Return:

The QDebug stream.