Ubuntu.Components

Elements

AbstractButton
The AbstractButton class defines the behavior of the button.

Action
Describe an action that can be re-used and shared between different components.

ActionBar
Show a row of buttons that trigger actions. When the number of visible actions specified is larger than numberOfSlots, an overflow button will be shown which triggers an overflow panel that shows the remaining actions.

ActionContext
ActionContext groups actions together and by providing multiple contexts the developer is able to control the visibility of the actions. The ActionManager then exposes the actions from these different contexts.

ActionItem
A visual representation of an Action. The API of ActionItem is a copy of the API of Action, with additional properties to define visual aspects of the ActionItem.

ActionList
List of Action items

ActionManager
ActionManager manages actions and action contexts withion an application.

ActivityIndicator
The ActivityIndicator component visually indicates that a task of unknown duration is in progress, e.g. busy indication, connection in progress indication, etc.

AdaptivePageLayout
View with multiple columns of Pages.

Alarm
Alarm component is a representation of an alarm event.

AlarmModel
AlarmModel holds the list of alarms defined.

Argument
The Argument class specifies what type a given command line parameter should be.

Arguments
The Arguments class provides a way to declare what command line parameters are expected by the application.

BottomEdge
A component to handle bottom edge gesture and content.

BottomEdgeHint
The BottomEdgeHint shows the availability of extra features available from the bottom edge of the application.

BottomEdgeRegion
Defines an active region within the BottomEdge component.

Button
Standard Ubuntu button.

Captions
Container providing captionStyles for a twin-label column that can be used in RowLayout or GridLayout.

CheckBox
CheckBox is a component with two states, checked or unchecked. It can be used to set boolean options. The behavior is the same as Switch, the only difference is the graphical style.

Clipboard
This is a singleton type providing access to the system clipboard.

ComboButton
Ubuntu button providing a drop-down panel visualizing custom options.

CrossFadeImage
An Image like component which smoothly fades when its source is updated.

FontUtils
FontUtils is a context property, which provides utility functions for font manipulations.

Haptics
Singleton defining the haptics feedback used in components, where execution of the feedback is controlled by the system settings.

Header
Header bar that can contain the title and controls for the current view.

Icon
The Icon component displays an icon from the icon theme.

InverseMouse
Attached object filtering mouse events occured outside the owner.

InverseMouseArea
The InverseMouseArea captures mouse events happening outside of a given area.

Label
Extended Text item with Ubuntu styling.

ListItem
The ListItem element provides Ubuntu design standards for list or grid views. The ListItem component was designed to be used in a list view. It does not define any specific layout, but while its contents can be freely chosen by the developer, care must...

ListItemActions
Provides configuration for actions to be added to a ListItem.

ListItemDrag
Provides information about a ListItem drag event.

ListItemLayout
ListItemLayout provides an easy way to create list items which follow Ubuntu design standards, thus making them visually appealing and consistent with the rest of the platform without effort.

LiveTimer
A live timing source providing peridioc updates.

MainView
MainView is the root Item that should be used for all applications.

MimeData
MimeData type provides interface to access and store data to the Clipboard.

Mouse
Attached property filtering mouse events occured inside the owner.

OptionSelector
Component displaying either a single selected value or expanded multiple choice with an optional image and subtext when not expanded, when expanding it opens a listing of all the possible values for selection with an additional option of always being e...

OrientationHelper
The OrientationHelper automatically rotates its children following the orientation of the device.

Page
A page is the basic Item that represents a single view in an Ubuntu application. It is recommended to use the Page inside the MainView or AdaptivePageLayout.

PageColumn
Component configuring the metrics of a column in AdaptivePageLayout.

PageColumnsLayout
Component configuring a layout in an AdaptivePageLayout component.

PageHeadConfiguration
Page.head is used to configure the header for a Page.

PageHeadSections
PageHeadSections is used to configure the sections for a Page.

PageHeadState
PageHeadState is a helper component to make it easier to configure the page header when changing states.

PageHeader
The PageHeader shows a title with a leading and a trailing ActionBar that add action buttons to the header.

PageStack
A stack of Page items that is used for inter-Page navigation. Pages on the stack can be popped, and new Pages can be pushed. The page on top of the stack is the visible one.

Panel
A panel that can be swiped in and out from an edge of the window by the user. For most applications, it is highly recommended to use the MainView instead which includes a toolbar at its bottom that can be swiped in or out.

PickerPanel
Provides a panel for opening a DatePicker in place of the input panel or as Popover, depending on the form factor.

PopupContext
A special ActionContext used in Dialogs and Popups.

ProgressBar
The ProgressBar component visually indicates the progress of a process of determinate or indeterminate duration.

ProgressionSlot
ProgressionSlot holds an icon representing the progression symbol.

ProportionalShape
Extended UbuntuShape mostly used for icons and vignettes.

PullToRefresh
Pull-to-refresh component for Flickables to reload a model upon pull.

ScrollView
ScrollView is a scrollable view that features scrollbars and scrolling via keyboard keys.

Scrollbar
The Scrollbar component provides scrolling functionality for scrollable views (i.e. Flickable, ListView).

Sections
Display a list of sections that the user can select. By tapping on a section name the selectedIndex will be updated, and the associated Action is triggered.

ServiceProperties
The component enables accessing service properties from QML.

Slider
Slider is a component to select a value from a continuous range of values.

SlotsLayout
The SlotsLayout component provides an easy way to layout a list of user-interface elements horizontally following Ubuntu design standards. We call the elements which we want to layout "slots". Slots is just another name for SlotsLayout...

SortFilterModel
SortFilterModel sorts and filters rows from an existing model.

StateSaver
Attached properties to save component property states.

StyleHints
Component holding style specific properties to configure a particular StyledItem's style runtime.

StyledItem
The StyledItem class allows items to be styled by the theme.

SwipeArea
An area which detects axis-aligned single-finger drag gestures.

Switch
Switch is a component with two states, checked or unchecked. It can be used to set boolean options. The behavior is the same as CheckBox, the only difference is the graphical style.

Tab
Component to represent a single tab in a Tabs environment.

TabBar
Tab bar that will be shown in the header when Tabs is active. This component does not need to be instantiated by the developer, it is automatically created by the Tabs.

Tabs
The Tabs class provides an environment where multible Tab children can be added, and the user is presented with a tab bar with tab buttons to select different tab pages.

TextArea
The TextArea item displays a block of editable, scrollable, formatted text.

TextField
The TextField element displays a single line of editable plain text. Input constraints can be set through validator or inputMask. Setting echoMode to an appropriate value enables TextField to be used as password input field.

Theme
The Theme class provides facilities to interact with the current theme.

ThemeSettings
The ThemeSettings class provides facilities to define the theme of a StyledItem.

Toolbar
Toolbar that can be used as an extension for the edit mode header. Example:

ToolbarButton
An ActionItem that represents a button in the toolbar. ToolbarButtons should be included in ToolbarItems to define the tools of a Page. The behavior and look of the toolbar button can be specified by setting an Action for the button, or by setting the ...

Ubuntu
Provides global object with different enums.

UbuntuAnimation
Singleton defining standard Ubuntu durations and easing for animations that should be used to ensure that Ubuntu applications are consistent in their animations.

UbuntuApplication
UbuntuApplication is a QML binding for a subset of QCoreApplication.

UbuntuColors
Singleton defining the Ubuntu color palette.

UbuntuListView
A ListView with special features tailored for a look and feel fitting the Ubuntu Touch platform. The UbuntuListView works just like a regular ListView, but it adds special features such as expanding/collapsing items (when used together with the Expanda...

UbuntuNumberAnimation
UbuntuNumberAnimation is a NumberAnimation that has predefined settings to ensure that Ubuntu applications are consistent in their animations.

UbuntuShape
Rounded rectangle containing a source image blended over a background color.

UbuntuShapeOverlay
Extended UbuntuShape adding a colored overlay layer.

Units
Units of measurement for sizes, spacing, margin, etc.

UriHandler
Singleton signalling for opened URIs.

ViewItems
A set of properties attached to the ListItem's parent item or ListView.

dateUtils
Various date utility functions.

i18n
i18n is a context property that provides internationalization support.

mathUtils
Various mathematical utility functions.