This articlerelies excessively onreferences toprimary sources. Please improve this article by addingsecondary or tertiary sources. Find sources: "QML" – news ·newspapers ·books ·scholar ·JSTOR(September 2010) (Learn how and when to remove this message) |
| QML | |
|---|---|
| Paradigm | Multi-paradigm:declarative,reactive,scripting |
| Family | ECMAScript |
| Developer | Qt Project |
| First appeared | 2009; 17 years ago (2009) |
| Stable release | |
| Typing discipline | dynamic,strong |
| Website | doc |
| Influenced by | |
| XAML,[2]JSON,JavaScript,Qt | |
| Influenced | |
| Qt | |
| QML | |
|---|---|
| Filename extension | .qml |
| Internet media type | text/x-qml |
| Developed by | Qt Project |
| Type of format | Scripting language |
| Website | doc |
QML (Qt Meta-object Language[3]) is auser interface markup language. It is adeclarative language (similar toCSS andJSON) for designinguser interface–centric applications. InlineJavaScript code handles imperative aspects. It is associated withQt Quick, the UI creation kit originally developed byNokia within theQt framework. Qt Quick is used for mobile applications where touch input, fluid animations and user experience are crucial. QML is also used with Qt3D[4] to describe a 3D scene and a "frame graph" rendering methodology. A QML document describes a hierarchical object tree. QML modules[5] shipped with Qt include primitive graphical building blocks (e.g., Rectangle, Image), modeling components (e.g., FolderListModel, XmlListModel), behavioral components (e.g., TapHandler, DragHandler, State, Transition, Animation), and more complex controls (e.g., Button, Slider, Drawer, Menu). These elements can be combined to build components ranging in complexity from simple buttons and sliders, to complete internet-enabled programs.
QML elements can be augmented by standardJavaScript both inline and via included .js files. Elements can also be seamlessly integrated and extended byC++ components using the Qt framework.
QML is the language; its JavaScript runtime is the custom V4 engine,[6] since Qt 5.2;[7] andQt Quick is the 2Dscene graph and the UI framework based on it. These are all part of the Qt Declarative module, while the technology is no longer called Qt Declarative.
QML and JavaScript code can be compiled into native C++ binaries with the Qt Quick Compiler.[8] Alternatively there is a QML cache file format[9] which stores a compiled version of QML dynamically for faster startup the next time it is run.
Somesyntax examples follow:
importQtQuickRectangle{id: canvaswidth:250height:200color:"blue"Image{id: logosource:"pics/logo.png"anchors.centerIn:parentx:canvas.height/5}}
Objects are specified by their type, followed by a pair of braces. Object types always begin with a capital letter. In the example above, there are two objects, a Rectangle; and its child, an Image. Between the braces, one can specify information about the object, such as its properties. Properties are specified as property: value. In the example above, the Image has a property namedsource, which has been assigned the valuepics/logo.png. The property and its value are separated by a colon.
The id property
Each object can be given a special unique property called an id. Assigning an id enables the object to be referred to by other objects and scripts. The first Rectangle element below has an id,myRect. The second Rectangle element defines its own width by referring tomyRect.width, which means it will have the same width value as the first Rectangle element.
Item{Rectangle{id: myRectwidth:120height:100}Rectangle{width:myRect.widthheight:200}}
An id must begin with a lower-case letter or an underscore, and can contain no characters other than letters, digits, and underscores.
A propertybinding specifies the value of a property in a declarative way. The property value is automatically updated if the other properties or data values change, following thereactive programming paradigm.
Property bindings are created implicitly in QML whenever a property is assigned a JavaScript expression. The following QML uses two property bindings to connect the size of the rectangle to that of otherItem.
Rectangle{width:otherItem.widthheight:otherItem.height}
QML extends a standards-compliant JavaScript engine, so any valid JavaScript expression can be used as a property binding. Bindings can access object properties, make function calls, and even use built-in JavaScript objects like Date and Math.
Rectangle{functioncalculateMyHeight(){returnMath.max(otherItem.height,thirdItem.height);}anchors.centerIn:parentwidth:Math.min(otherItem.width,10)height:calculateMyHeight()color:width>10?"blue":"red"}
States are a mechanism to combine changes to properties in a semantic unit. A button for example has a pressed and a non-pressed state, an address book application could have a read-only and an edit state for contacts. Every element has an "implicit" base state. Every other state is described by listing the properties and values of those elements which differ from the base state.
Example:In the default state, myRect is positioned at 0,0. In the "moved" state, it is positioned at 50,50. Clicking within the mouse area changes the state from the default state to the "moved" state, thus moving the rectangle.
importQtQuickItem{id: myItemwidth:200;height:200Rectangle{id: myRectwidth:100;height:100color:"red"}states:[State{name:"moved"PropertyChanges{target:myRectx:50y:50}}]MouseArea{anchors.fill:parentonClicked:myItem.state='moved'}}
State changes can be animated using Transitions.
For example, adding this code to the above Item element animates the transition to the "moved" state:
transitions:[Transition{from:"*"to:"moved"NumberAnimation{properties:"x,y";duration:500}}]
Animations in QML are done by animating properties of objects. Properties of type real, int, color, rect, point, size, and vector3d can all be animated.
QML supports three main forms of animation: basic property animation, transitions, and property behaviors.
The simplest form of animation is a PropertyAnimation, which can animate all of the property types listed above. A property animation can be specified as a value source using the Animation on property syntax. This is especially useful for repeating animations.
The following example creates a bouncing effect:
Rectangle{id: rectwidth:120;height:200Image{id: imgsource:"pics/qt.png"x:60-img.width/2y:0SequentialAnimationony{loops:Animation.InfiniteNumberAnimation{to:200-img.height;easing.type:Easing.OutBounce;duration:2000}PauseAnimation{duration:1000}NumberAnimation{to:0;easing.type:Easing.OutQuad;duration:1000}}}}
Usage of QML does not require Qt/C++ knowledge to use, but it can be easily extended via Qt.[27][28] Any C++ class derived from QObject can be easily registered as a type which can then be instantiated in QML.
QML provides direct access to the following concepts from Qt:
Signal handlers are JavaScript callbacks which allow imperative actions to be taken in response to an event. For instance, the MouseArea element has signal handlers to handle mouse press, release and click:
MouseArea{onPressed:console.log("mouse button pressed")}
All signal handler names begin with "on".
Because QML and JavaScript are very similar, almost all code editors supporting JavaScript will work. Full support forsyntax highlighting, code completion, integrated help, and aWYSIWYG editor are available in the free cross-platformintegrated development environment (IDE)Qt Creator since version 2.1 and many other IDEs.
The qml executable can be used to run a QML file as a script. If the QML file begins with ashebang it can be made directly executable. However packaging an application for deployment (especially on mobile platforms) generally involves writing a simple C++ launcher and packaging the needed QML files as resources.