2 * Copyright (C) 2014 Canonical, Ltd.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; version 3.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 /*! Interface for preview widgets. */
22 //! The widget identifier
23 property string widgetId
25 //! Variable used to contain widget's data
26 property var widgetData
28 //! The ScopeStyle component.
29 property var scopeStyle: null
31 //! Should the widget show in expanded mode (For those that support it)
32 property bool expanded: true
34 //! Should the orientation be locked
35 property bool orientationLock: false
37 //! Set margins width.
38 property real widgetMargins: units.gu(1)
40 /// The parent (vertical) flickable this widget is in (if any)
41 property var parentFlickable: null
43 /*! \brief This signal should be emitted when a preview action was triggered.
45 * \param widgetId, actionId Respective identifiers from widgetData.
46 * \param data Optional widget-specific data sent to the scope.
48 signal triggered(string widgetId, string actionId, var data)
50 /*! \brief This signal should be emitted when widget gains the focus
51 * and input method popups.
52 * And preview widget should reposition in visible area to avoid
53 * keyboard appears over the widget.
55 * \param item, id of specified item which is needed to reposition.
57 signal makeSureVisible(var item)