Merge lp:~kalikiana/ubuntu-ui-toolkit/aliasdocs into lp:ubuntu-ui-toolkit

[Cris Dywan]

Include alias types in qmlapicheck

Include alias types in qmlapicheck

[Cris Dywan (kalikiana)]

As per a quick survey internal properties don't require the type annotation and only show "internal" as their type because we don't support them.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:552
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/197/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-amd64-ci/54
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/54
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/54/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins:8080/job/ubuntu-ui-toolkit-ci/197/rebuild

review: Approve (continuous-integration)

[Tim Peeters (tpeeters)]

New type checking is good stuff. However, I don't see an advantage in listing internal property types as "internal" as opposed to their actual type.

[Tim Peeters (tpeeters)]

approved, just waiting for some other MRs to land and to merge this one with trunk.

review: Approve

[Tim Peeters (tpeeters)]

Please merge trunk first, or the merge will fail.

[lp:~kalikiana/ubuntu-ui-toolkit/aliasdocs]

553. By Cris Dywan on 2013-07-05

Merge lp:ubuntu-ui-toolkit trunk

[ Zsombor Egri ]
* Fix for re-parenting items that are anchor filled to an item in
  default layout.
* TextField API extended with API left out from TextInput. wrapMode is
  not inlcuded as does not make sense to be used in single line input.
  (LP: #1183265)
* Calculator example which turns from simple calculator (phone
  portrait mode) into scientific one (phone landscape mode) reflecting
  the use of Ubuntu.Layouts. .
* Removing common.pri from Layouts.pro and Layouts\plugin.pro causing
  qmake warnings when Ubuntu UI toolkit project is opened in
  QtCreator.
[ Leo Arias ]
* Replaced the MainWindow emulator for autopilot tests with a MainView
  emulator that the uses the custom emulator features of autopilot.
* Added the Toolbar Autopilot emulator. (LP: #1177341)
[ Juhapekka Piiroinen ]
* Fixed broken ubuntu-ui-toolkit-gallery.qmlproject file, which had an
  invalid value in mainFile field.
[ tpeeters ]
* Update header behavior: - Do not automatically hide the header when
  scrolling in a flickable that is not anchored to the top of the
  page. - Automatically show the header when flickable's contentHeight
  becomes less than flickable.height. - Update documentation for
  Page.flickable. (LP: #1156573, #1160175)
[ Kaleo ]
* Removed common.pri and coverage.pri files that were cluttering
  QtCreator making it harder to understand the real structure of the
  project. coverage.pri has been transformed into a feature file
  (coverage.prf) which works the same way as before.
* Removed antiquated TextCustom class.
* Removed unused old-style tabs delegate.
* Removed UbuntuShape.qml and transferred code & documentation to
  shapeitem.cpp ShapeItem: renamed baseColor property into color.
* UbuntuShape: simplified gradient implementation; gradientColor is
  now the same as color by default. .
* Simplified theming infrastructure. There are no stylesheets anymore
  (.qmltheme file), only delegates remain. A theme is a QML module
  containing delegates whose names are standardized. The default theme
  is called 'Ambiance' and available from QML through 'import
  Ubuntu.Components.Themes.Ambiance 0.1'. The name of the current
  theme is set in ~/.config/ubuntu-ui-toolkit/theme.ini Writing a new
  theme is done by creating a QML module and adding it in the
  Ubuntu/Components/Themes folder. A theme inherits from another theme
  by containing a text file name 'parent_theme' whose first and only
  line is the name of the parent theme. * Moved themes/ directory to
  Ubuntu/Components/Themes so that themes are importable. * Simplified
  ThemeEngine and ThemeSettings class, removed the rest of the theming
  infrastructure (ItemStyle, Style, QmlThemeLoader, Selector,
  StyleCache). * Adapted all widgets to use the simplified theming
  technique: - new StyledItem class that has a 'style' Component
  property representing the delegate - all widgets that have delegates
  inherit from StyledItem - all widgets set the 'style' property to
  the corresponding delegate in the current theme by using
  Theme.createStyleComponent() - Ambiance's stylesheet property/values
  have been moved to where they are used (mostly to the delegates) -
  TextAreaDelegate: exposed background as Component property - Added a
  delegate specific to TextField: TextFieldDelegate - Renamed
  delegates so that they match their widget's name (e.g.
  EditorCursorDelegate.qml renamed to TextCursorDelegate.qml since
  it's the delegate of TextCursor.qml) * Renamed UITK_THEME_PATH into
  UBUNTU_UI_TOOLKIT_THEMES_PATH. (LP: #1152160, #1152161, #1152162,
  #1185950, #1081038, #1167998, #1137210, #1152154, #1152158)
* New UbuntuColors singleton defining the standard Ubuntu color
  palette. (LP: #1098209)
* debian/control: specify same architecture for ubuntu-ui-toolkit-
  theme as for qtdeclarative5-ubuntu-ui-toolkit-plugin so that the
  files end up in the same folder. (LP: #1197164)
* Button: - implementation clean up - updated visual design - new
  'gradient' property.
* When looking up the plugin's directory
  (UbuntuComponentsPlugin::baseUrl), a case was omitted: if another
  Ubuntu/Components directory exists and is present in the
  QML2_IMPORT_PATH then the lookup failed. This fix is temporary until
  Qt 5.1. (LP: #1197293)
* Reverted revisions 562 & 569 that broke the autopilot tests. Fixed
  button related autopilot test. (LP: #1197355)
[ Ubuntu daily release ]
* Automatic snapshot from revision 580
[ Kaleo ]
* Button: do not display a background when the color set is fully
  transparent.
* TextField: new clear icon imported from the icon theme (lp:ubuntu-
  themes).
[ Christian Dywan ]
* Implement bread crumbs in API docs. (LP: #1168026)
[ Ubuntu daily release ]
* Automatic snapshot from revision 560
[ Sebastien Bacher ]
* List.Item.Standard: set the height and verticalCenter of the
  control. (LP: #1190196)
[ Ubuntu daily release ]
* Automatic snapshot from revision 555
[ Zsombor Egri ]
* [layouts] Layout factoring.
[ Ubuntu daily release ]
* Automatic snapshot from revision 552

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:553
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/275/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-saucy/739
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-amd64-ci/132
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/132
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/132/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy/741
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy/741/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-saucy/664

Click here to trigger a rebuild:
http://s-jenkins:8080/job/ubuntu-ui-toolkit-ci/275/rebuild

review: Approve (continuous-integration)

=== modified file 'components.api'
--- components.api	2013-07-04 20:30:21 +0000
+++ components.api	2013-07-05 07:17:28 +0000
@@ -5,7 +5,7 @@
     property bool pressed
     property bool hovered
     property bool __acceptEvents
-    property alias __mouseArea
+    property internal __mouseArea
 modules/Ubuntu/Components/Action.qml
 QtObject
     property string text
@@ -22,7 +22,7 @@
     signal triggered(var caller)
 modules/Ubuntu/Components/ActionList.qml
 QtObject
-    default property alias children
+    default property list<Action> children
     property list<Action> actions
 modules/Ubuntu/Components/ActivityIndicator.qml
 AnimatedItem
@@ -65,34 +65,34 @@
 modules/Ubuntu/Components/Icon.qml
 Item
     property string name
-    property alias color
-    property alias keyColor
+    property color color
+    property color keyColor
 modules/Ubuntu/Components/Label.qml
 Text
     property string fontSize
 modules/Ubuntu/Components/MainView.qml
 PageTreeNode
     property string applicationName
-    property alias automaticOrientation
-    default property alias contentsItem
+    property bool automaticOrientation
+    default property internal contentsItem
     property ToolbarActions tools
     onToolsChanged
 modules/Ubuntu/Components/ModelSectionCounter.qml
 Object
     property var view
     property int count
-    readonly property alias sectionHeight
+    readonly property real sectionHeight
     property bool cacheSections
     property var cache
 modules/Ubuntu/Components/Object.qml
 QtObject
-    default property alias children
+    default property internal children
 modules/Ubuntu/Components/OrientationHelper.qml
 Item
     property bool automaticOrientation
     property bool transitionEnabled
     property alias rotating
-    property alias __orientationAngle
+    property int __orientationAngle
     property int orientationAngle
 modules/Ubuntu/Components/Page.qml
 PageTreeNode
@@ -126,7 +126,7 @@
     function destroyObject()
 modules/Ubuntu/Components/Panel.qml
 Item
-    default property alias contents
+    default property list<Object> contents
     property int align
     property bool opened
     property bool locked
@@ -144,7 +144,7 @@
     property Flickable flickableItem
     property int align
     property bool __interactive
-    property alias __private
+    property internal __private
 modules/Ubuntu/Components/Slider.qml
 AbstractButton
     property real minimumValue
@@ -153,7 +153,7 @@
     property bool live
     signal touched(bool onThumb)
     function formatValue(v)
-    property alias __internals
+    property internal __internals
 modules/Ubuntu/Components/StyledItem.qml
 FocusScope
     property Component style
@@ -173,14 +173,14 @@
     property Component __headerContents
     property ToolbarActions tools
     onToolsChanged
-    property alias __tabs
-    default property alias tabChildren
+    property internal __tabs
+    default property list<Item> tabChildren
     signal modelChanged()
 modules/Ubuntu/Components/TextArea.qml
 StyledItem
     property bool highlighted
-    property alias placeholderText
-    readonly property alias displayText
+    property string placeholderText
+    readonly property string displayText
     property bool selectByMouse
     property bool autoExpand
     property bool autoSize
@@ -189,35 +189,35 @@
     property real contentHeight
     property var popover
     property bool activeFocusOnPress
-    property alias baseUrl
-    property alias canPaste
-    property alias canRedo
-    property alias canUndo
-    property alias color
-    property alias cursorDelegate
-    property alias cursorPosition
-    property alias cursorRectangle
-    property alias cursorVisible
-    property alias effectiveHorizontalAlignment
-    property alias font
-    property alias horizontalAlignment
-    property alias inputMethodComposing
-    property alias inputMethodHints
-    property alias length
-    property alias lineCount
-    property alias mouseSelectionMode
-    property alias persistentSelection
-    property alias readOnly
-    property alias renderType
-    property alias selectedText
-    property alias selectedTextColor
-    property alias selectionColor
-    property alias selectionEnd
-    property alias selectionStart
-    property alias text
-    property alias textFormat
-    property alias verticalAlignment
-    property alias wrapMode
+    property url baseUrl
+    property bool canPaste
+    property bool canRedo
+    property bool canUndo
+    property color color
+    property Component cursorDelegate
+    property int cursorPosition
+    property rectangle cursorRectangle
+    property bool cursorVisible
+    property enumeration effectiveHorizontalAlignment
+    property font font
+    property enumeration horizontalAlignment
+    property bool inputMethodComposing
+    property enumeration inputMethodHints
+    property int length
+    property int lineCount
+    property enumeration mouseSelectionMode
+    property enumeration persistentSelection
+    property bool readOnly
+    property enumeration renderType
+    property string selectedText
+    property color selectedTextColor
+    property color selectionColor
+    property int selectionEnd
+    property int selectionStart
+    property string text
+    property enumeration textFormat
+    property enumeration verticalAlignment
+    property enumeration wrapMode
     signal linkActivated(string link)
     function copy()
     function cut()
@@ -237,7 +237,7 @@
     function remove(start, end)
     function undo()
     function forceActiveFocus()
-    property alias __internal
+    property internal __internal
 modules/Ubuntu/Components/TextCursor.qml
 StyledItem
     property var editorItem
@@ -247,50 +247,50 @@
 modules/Ubuntu/Components/TextField.qml
 StyledItem
     property bool highlighted
-    property alias placeholderText
+    property string placeholderText
     property bool hasClearButton
     property Component customSoftwareInputPanel
     property var popover
-    property alias primaryItem
-    property alias secondaryItem
+    property list<Object> primaryItem
+    property list<Object> secondaryItem
     property bool errorHighlight
-    property alias acceptableInput
-    property alias activeFocusOnPress
-    property alias autoScroll
-    property alias canPaste
-    property alias canRedo
-    property alias canUndo
-    property alias color
-    property alias contentHeight
-    property alias contentWidth
-    property alias cursorDelegate
-    property alias cursorPosition
-    property alias cursorRectangle
-    property alias cursorVisible
-    property alias displayText
-    property alias echoMode
-    property alias font
-    property alias inputMask
-    property alias inputMethodComposing
-    property alias inputMethodHints
-    property alias length
-    property alias maximumLength
-    property alias mouseSelectionMode
-    property alias persistentSelection
-    property alias readOnly
-    property alias renderType
-    property alias selectByMouse
-    readonly property alias selectedText
-    property alias selectionStart
-    property alias selectionEnd
-    property alias text
-    property alias validator
-    property alias horizontalAlignment
-    property alias effectiveHorizontalAlignment
-    property alias verticalAlignment
-    property alias passwordCharacter
-    property alias selectionColor
-    property alias selectedTextColor
+    property bool acceptableInput
+    property bool activeFocusOnPress
+    property bool autoScroll
+    property bool canPaste
+    property bool canRedo
+    property bool canUndo
+    property color color
+    property real contentHeight
+    property real contentWidth
+    property Component cursorDelegate
+    property int cursorPosition
+    property rectangle cursorRectangle
+    property bool cursorVisible
+    property string displayText
+    property enumeration echoMode
+    property font font
+    property string inputMask
+    property bool inputMethodComposing
+    property enumeration inputMethodHints
+    property int length
+    property int maximumLength
+    property enumeration mouseSelectionMode
+    property bool persistentSelection
+    property bool readOnly
+    property enumeration renderType
+    property bool selectByMouse
+    readonly property string selectedText
+    property int selectionStart
+    property int selectionEnd
+    property string text
+    property Validator validator
+    property enumeration horizontalAlignment
+    property internal effectiveHorizontalAlignment
+    property internal verticalAlignment
+    property string passwordCharacter
+    property color selectionColor
+    property color selectedTextColor
     signal accepted()
     function copy()
     function cut()
@@ -309,7 +309,7 @@
     function undo()
     function remove(start, end)
     function getText(start, end)
-    property alias __internal
+    property internal __internal
 modules/Ubuntu/Components/TextInputPopover.qml
 ActionSelectionPopover
 modules/Ubuntu/Components/Toolbar.qml
@@ -319,7 +319,7 @@
     property Item tools
 modules/Ubuntu/Components/ToolbarActions.qml
 Item
-    default property alias children
+    default property list<Action> children
     property list<Action> actions
     property Action back
     property Item __pageStack
@@ -332,7 +332,7 @@
 ActionItem
 modules/Ubuntu/Components/ToolbarItems.qml
 Item
-    default property alias contents
+    default property list<Object> contents
     property Item back
     property Item pageStack
     property bool opened
@@ -341,11 +341,11 @@
 NumberAnimation
 modules/Ubuntu/Components/UbuntuShape.qml
 Item
-    property alias color
-    property alias gradientColor
-    property alias radius
+    property color color
+    property color gradientColor
+    property string radius
     property Item image
-    property alias borderSource
+    property url borderSource
 plugins.qmltypes
     name: "InverseMouseAreaType"
     prototype: "QQuickItem"

=== modified file 'modules/Ubuntu/Components/ModelSectionCounter.qml'
--- modules/Ubuntu/Components/ModelSectionCounter.qml	2013-01-08 09:50:42 +0000
+++ modules/Ubuntu/Components/ModelSectionCounter.qml	2013-07-05 07:17:28 +0000
@@ -41,6 +41,7 @@
 
     /*!
       \preliminary
+      \qmlproperty real sectionHeight
       The property contains the section Item height.
     */
     readonly property alias sectionHeight: internals.sectionHeight

=== modified file 'tests/qmlapicheck.py'
--- tests/qmlapicheck.py	2013-05-21 11:40:46 +0000
+++ tests/qmlapicheck.py	2013-07-05 07:17:28 +0000
@@ -36,6 +36,7 @@
     if fileinput.isfirstline():
         in_block = 0
         in_comment = False
+        annotated_type = None
         if fileinput.filename()[-3:] == 'qml':
             filetype = 'qml'
             keywords = ['signal', 'property', 'function']
@@ -48,6 +49,12 @@
         print('%s' % fileinput.filename())
 
     line = line.split('//')[0]
+    # alias properties only define their type through qdoc comments
+    if '\\qmlproperty' in line:
+        annotated_type = line
+    elif '\\internal' in line:
+        annotated_type = 'internal internal internal'
+
     if '/*' in line and not '*/' in line:
         in_comment = True
         continue
@@ -77,6 +84,14 @@
             if word in keywords:
                 if filetype == 'qml':
                     signature = line.split(':')[0].split('{')[0].strip()
+                    if 'alias' in line:
+                        if not annotated_type:
+                            print('    %s' % (signature))
+                            print('Error: Missing \\qmlproperty annotation')
+                            sys.exit (1)
+                        real_type = annotated_type.strip().split(' ')[1]
+                        signature = signature.replace('alias', real_type)
+                    annotated_type = None
                 elif filetype == 'qmltypes':
                     signature = line.strip()
                 print('    %s' % (signature))