Sailfish Silica Reference

Essential types

Every Sailfish application begins with an ApplicationWindow item, and each application has a single PageStack object containing all of its pages. Additionally, the special Theme object allows applications to style their user interface according to the Sailfish style.

Clipboard

Exposes basic clipboard functionality

StandardPaths

Exposes the locations of system-standard user directories

ApplicationWindow

Top-level component of a Sailfish application

PageStack

Stores and manages the pages of an application

Sailfish.Silica.Screen

Provides device display attributes

Theme

Provides Sailfish styling properties

Pages and dialogs

Each page or dialog contains a single screen of application content. A dialog is a type of page that presents content while requesting a confirmation or cancelation action from the user.

ColorPickerDialog

A dialog for selecting a color from a ColorPicker

ColorPickerPage

A page for selecting a color from a ColorPicker

DatePickerDialog

A dialog for selecting a date from a DatePicker

Dialog

A page that is closed by a confirmation or cancelation action

DialogHeader

A header for use in a Dialog

Page

A single page within an application

PageHeader

A header for use in a Page

TimePickerDialog

A dialog for selecting a time from a TimePicker

Views and containers

These are used to display or serve as a container for other items. (Note the SilicaFlickable, SilicaListView, SilicaGridView and SilicaWebView provide Sailfish-specific behavior and should be used in preference to Flickable, ListView and GridView from the QtQuick module and WebView from the QtWebKit module.) Additionally, the ScrollDecorator types provide scroll indicators for views.

ColumnView

Repeatedly instantiates a delegate in a column

DockedPanel

An expanding panel anchored to the side of an Item

Drawer

A sliding panel with a second panel underneath

HorizontalScrollDecorator

Adds a horizontal scroll indicator to a flickable Silica view

ScrollDecorator

Adds horizontal and vertical scroll indicators to a flickable Silica view

SilicaFlickable

A Sailfish-styled flickable view

SilicaGridView

A Sailfish-styled grid view

SilicaListView

A Sailfish-styled list view

SilicaWebView

A Sailfish-styled flickable and pinchable view for displaying web pages

SlideshowView

A view for flicking through a series of items

VerticalScrollDecorator

Adds a vertical scroll indicator to a flickable Silica view

ViewPlaceholder

Shows a Sailfish-style fullscreen placeholder for an empty view

Controls

Control components allow users to trigger actions, change values and select options.

ButtonLayout

An item that lays out Button types

BackgroundItem

A simple Sailfish-styled item for building touch-interactive items

BusyIndicator

Displayed while waiting for content to load or some process to finish

Button

A push button with a text label

ColorPicker

A grid of colors for selecting a color

ComboBox

A combo box control for selecting from a list of options

DatePicker

A calendar grid for selecting a date

IconButton

A push button with an image

IconTextSwitch

A toggle button with a label and an icon

Keypad

A dialer-type keypad

ListItem

A simple Sailfish-styled item for building touch-interactive list items

PasswordField

A text field for password entry

ProgressBar

A horizontal progress bar

Remorse

Shows prompts that brief allow destructive actions to be canceled

RemorseItem

Shows an item that briefly allows a destructive action to be canceled

RemorsePopup

Shows a pop-up that briefly allows a destructive action to be canceled

Separator

A horizontal separator

Slider

A horizontal slider

Switch

A toggle button with an icon

TextSwitch

A toggle button with a label

TimePicker

A clock face for selecting a time

TouchBlocker

An item that accepts all mouse and touch input

ValueButton

A clickable control that displays a label and a value

Text display and input

Text components can display text and enable text input.

DetailItem

Styled display of a label and an associated value

EnterKey

Controls the appearance and behaviour of the Enter key in the software input panel

Label

A text label

LinkedLabel

A text paragraph with numbers and addresses automatically highlighted as links

SearchField

A text field for entering a text search query

SectionHeader

Heading text for the start of a section on a page

TextArea

Displays multiple lines of editable plain text

TextField

Displays a single line of editable plain text

Menus allow users to select and trigger an action from a list of options.

ContextMenu

Provides a context-specific menu

MenuItem

Encapsulates a menu item

MenuLabel

A static label shown at the beginning of a pulley menu

PullDownMenu

Adds a pull-down menu to a flickable Silica view

PushUpMenu

Adds a push-up menu to a flickable Silica view

Animations and effects

These are common Silica animations to be applied when fading items or changing the contents of lists, grids and other views. Additionally OpacityRampEffect provides a simple way to fade an item in a linear fashion.

AddAnimation

A Sailfish-style item-addition animation

FadeAnimation

A Sailfish-style fade animation

FadeAnimator

A Sailfish-style fade animation that runs outside of the main application UI thread

OpacityRampEffect

A shader effect that applies an opacity fade gradient

RemoveAnimation

A Sailfish-style item-removal animation

Application covers

Covers are the visual representations of backgrounded applications that are displayed on the running applications screen.

CoverAction

An action for a Cover

CoverActionList

A list of cover actions

Cover

An application cover

CoverBackground

Provides a transparent cover

CoverPlaceholder

Provides template cover content for a very simple application cover