QML Object Attributes#

Description of QML object type attributes

Every QML object type has a defined set of attributes. Each instance of an object type is created with the set of attributes that have been defined for that object type. There are several different kinds of attributes which can be specified, which are described below.

Attributes in Object Declarations#

An object declaration in a QML document defines a new type. It also declares an object hierarchy that will be instantiated should an instance of that newly defined type be created.

The set of QML object-type attribute types is as follows:

the id attribute

property attributes

signal attributes

signal handler attributes

method attributes

attached properties and attached signal handler attributes

enumeration attributes

These attributes are discussed in detail below.

The * id*

Attribute#

Every QML object type has exactly one id attribute. This attribute is provided by the language itself, and cannot be redefined or overridden by any QML object type.

A value may be assigned to the id attribute of an object instance to allow that object to be identified and referred to by other objects. This id must begin with a lower-case letter or an underscore, and cannot contain characters other than letters, numbers and underscores.

Below is a TextInput object and a Text object. The TextInput object’s id value is set to “myTextInput”. The Text object sets its text property to have the same value as the text property of the TextInput, by referring to myTextInput.text. Now, both items will display the same text:

An object can be referred to by its id from anywhere within the component scope in which it is declared. Therefore, an id value must always be unique within its component scope. See Scope and Naming Resolution for more information.

Once an object instance is created, the value of its id attribute cannot be changed. While it may look like an ordinary property, the id attribute is not an ordinary property attribute, and special semantics apply to it; for example, it is not possible to access myTextInput.id in the above example.

Property Attributes#

A property is an attribute of an object that can be assigned a static value or bound to a dynamic expression. A property’s value can be read by other objects. Generally it can also be modified by another object, unless a particular QML type has explicitly disallowed this for a specific property.

Defining Property Attributes#

A property may be defined for a type in C++ by registering a Q_PROPERTY of a class which is then registered with the QML type system. Alternatively, a custom property of an object type may be defined in an object declaration in a QML document with the following syntax:

[default] [required] [readonly] property <propertyType> <propertyName>

In this way an object declaration may expose a particular value to outside objects or maintain some internal state more easily.

Property names must begin with a lower case letter and can only contain letters, numbers and underscores. JavaScript reserved words are not valid property names. The default, required, and readonly keywords are optional, and modify the semantics of the property being declared. See the upcoming sections on default properties , required properties and, read-only properties for more information about their respective meaning.

Declaring a custom property implicitly creates a value-change signal for that property, as well as an associated signal handler called on<PropertyName>Changed, where <PropertyName> is the name of the property, with the first letter capitalized.

For example, the following object declaration defines a new type which derives from the Rectangle base type. It has two new properties, with a signal handler implemented for one of those new properties:

Valid Types in Custom Property Definitions#

Any of the QML Value Types aside from the enumeration type can be used as custom property types. For example, these are all valid property declarations:

(Enumeration values are simply whole number values and can be referred to with the int type instead.)

Some value types are provided by the QtQuick module and thus cannot be used as property types unless the module is imported. See the QML Value Types documentation for more details.

Note the var value type is a generic placeholder type that can hold any type of value, including lists and objects:

property var someNumber: 1.5
property var someString: "abc"
property var someBool: true
property var someList: [1, 2, "three", "four"]
property var someObject: Rectangle { width: 100; height: 100; color: "red" }

Additionally, any QML object type can be used as a property type. For example:

property Item someItem
property Rectangle someRectangle

This applies to custom QML types as well. If a QML type was defined in a file named ColorfulButton.qml (in a directory which was then imported by the client), then a property of type ColorfulButton would also be valid.

Assigning Values to Property Attributes#

The value of a property of an object instance may be specified in two separate ways:

a value assignment on initialization

an imperative value assignment

In either case, the value may be either a static value or a binding expression value.

Value Assignment on Initialization#

The syntax for assigning a value to a property on initialization is:

<propertyName> : <value>

An initialization value assignment may be combined with a property definition in an object declaration, if desired. In that case, the syntax of the property definition becomes:

[default] property <propertyType> <propertyName> : <value>

An example of property value initialization follows:

Imperative Value Assignment#

An imperative value assignment is where a property value (either static value or binding expression) is assigned to a property from imperative JavaScript code. The syntax of an imperative value assignment is just the JavaScript assignment operator, as shown below:

[<objectId>.]<propertyName> = value

An example of imperative value assignment follows:

Static Values and Binding Expression Values#

As previously noted, there are two kinds of values which may be assigned to a property: static values, and binding expression values. The latter are also known as property bindings .

Kind

Semantics

Static Value

A constant value which does not depend on other properties.

Binding Expression

A JavaScript expression which describes a property’s relationship with other properties. The variables in this expression are called the property’s dependencies.

The QML engine enforces the relationship between a property and its dependencies. When any of the dependencies change in value, the QML engine automatically re-evaluates the binding expression and assigns the new result to the property.

Kind	Semantics
Static Value	A constant value which does not depend on other properties.
Binding Expression	A JavaScript expression which describes a property’s relationship with other properties. The variables in this expression are called the property’s dependencies. The QML engine enforces the relationship between a property and its dependencies. When any of the dependencies change in value, the QML engine automatically re-evaluates the binding expression and assigns the new result to the property.

Here is an example that shows both kinds of values being assigned to properties:

Note

To assign a binding expression imperatively, the binding expression must be contained in a function that is passed into binding() , and then the value returned by Qt.binding() must be assigned to the property. In contrast, Qt.binding() must not be used when assigning a binding expression upon initialization. See Property Binding for more information.

Type Safety#

Properties are type safe. A property can only be assigned a value that matches the property type.

For example, if a property is a real, and if you try to assign a string to it, you will get an error:

property int volume: "four"  // generates an error; the property's object will not be loaded

Likewise if a property is assigned a value of the wrong type during run time, the new value will not be assigned, and an error will be generated.

Some property types do not have a natural value representation, and for those property types the QML engine automatically performs string-to-typed-value conversion. So, for example, even though properties of the color type store colors and not strings, you are able to assign the string "red" to a color property, without an error being reported.

See QML Value Types for a list of the types of properties that are supported by default. Additionally, any available QML object type may also be used as a property type.

Special Property Types#

Object List Property Attributes#

A list type property can be assigned a list of QML object-type values. The syntax for defining an object list value is a comma-separated list surrounded by square brackets:

[ <item 1>, <item 2>, ... ]

For example, the Item type has a states property that is used to hold a list of State type objects. The code below initializes the value of this property to a list of three State objects:

If the list contains a single item, the square brackets may be omitted:

A list type property may be specified in an object declaration with the following syntax:

[default] property list<<objectType>> propertyName

and, like other property declarations, a property initialization may be combined with the property declaration with the following syntax:

[default] property list<<objectType>> propertyName: <value>

An example of list property declaration follows:

If you wish to declare a property to store a list of values which are not necessarily QML object-type values, you should declare a var property instead.

Grouped Properties#

In some cases properties contain a logical group of sub-property attributes. These sub-property attributes can be assigned to using either the dot notation or group notation.

For example, the Text type has a font group property. Below, the first Text object initializes its font values using dot notation, while the second uses group notation:

Text {
    //dot notation
    font.pixelSize: 12
    font.b: true
}

Text {
    //group notation
    font { pixelSize: 12; b: true }
}

Grouped property types are types which have subproperties. If a grouped property type is an object type (as opposed to a value type), the property that holds it must be read-only. This is to prevent you from replacing the object the subproperties belong to.

Property Aliases#

Property aliases are properties which hold a reference to another property. Unlike an ordinary property definition, which allocates a new, unique storage space for the property, a property alias connects the newly declared property (called the aliasing property) as a direct reference to an existing property (the aliased property).

A property alias declaration looks like an ordinary property definition, except that it requires the alias keyword instead of a property type, and the right-hand-side of the property declaration must be a valid alias reference:

[default] property alias <name>: <alias reference>

Unlike an ordinary property, an alias has the following restrictions:

It can only refer to an object, or the property of an object, that is within the scope of the type within which the alias is declared.

It cannot contain arbitrary JavaScript expressions

It cannot refer to objects declared outside of the scope of its type.

The alias reference is not optional, unlike the optional default value for an ordinary property; the alias reference must be provided when the alias is first declared.

It cannot refer to attached properties .
It cannot refer to properties inside a hierarchy with depth 3 or greater. The following code will not work:
property alias color: myItem.myRect.border.color

Item {
    id: myItem
    property Rectangle myRect
}
However, aliases to properties that are up to two levels deep will work.
property alias color: rectangle.border.color

Rectangle {
    id: rectangle
}

For example, below is a Button type with a buttonText aliased property which is connected to the text object of the Text child:

The following code would create a Button with a defined text string for the child Text object:

Here, modifying buttonText directly modifies the textItem.text value; it does not change some other value that then updates textItem.text. If buttonText was not an alias, changing its value would not actually change the displayed text at all, as property bindings are not bi-directional: the buttonText value would have changed if textItem.text was changed, but not the other way around.

Considerations for Property Aliases#

It is possible for an aliasing property to have the same name as an existing property, effectively overwriting the existing property. For example, the following QML type has a color alias property, named the same as the built-in Rectangle::color property:

Rectangle {
    id: coloredrectangle
    property alias color: bluerectangle.color
    color: "red"

    Rectangle {
        id: bluerectangle
        color: "#1234ff"
    }

    Component.onCompleted: {
        console.log (coloredrectangle.color)    //prints "#1234ff"
        setInternalColor()
        console.log (coloredrectangle.color)    //prints "#111111"
        coloredrectangle.color = "#884646"
        console.log (coloredrectangle.color)    //prints #884646
    }

    //internal function that has access to internal properties
    function setInternalColor() {
        color = "#111111"
    }
}

Any object that use this type and refer to its color property will be referring to the alias rather than the ordinary Rectangle::color property. Internally, however, the rectangle can correctly set its color property and refer to the actual defined property rather than the alias.

Property Aliases and Types#

Property aliases cannot have explicit type specifications. The type of a property alias is the declared type of the property or object it refers to. Therefore, if you create an alias to an object referenced via id with extra properties declared inline, the extra properties won’t be accessible through the alias:

You cannot initialize inner.extraProperty from outside of this component, as inner is only an Item:

However, if you extract the inner object into a separate component with a dedicated .qml file, you can instantiate that component instead and have all its properties available through the alias:

Default Properties#

An object definition can have a single default property. A default property is the property to which a value is assigned if an object is declared within another object’s definition without declaring it as a value for a particular property.

Declaring a property with the optional default keyword marks it as the default property. For example, say there is a file MyLabel.qml with a default property someText:

The someText value could be assigned to in a MyLabel object definition, like this:

This has exactly the same effect as the following:

However, since the someText property has been marked as the default property, it is not necessary to explicitly assign the Text object to this property.

You will notice that child objects can be added to any Item-based type without explicitly adding them to the children property. This is because the default property of Item is its data property, and any items added to this list for an Item are automatically added to its list of children.

Default properties can be useful for reassigning the children of an item. For example:

By setting the default property alias to inner.children, any object assigned as a child of the outer item is automatically reassigned as a child of the inner item.

Required Properties#

An object declaration may define a property as required, using the required keyword. The syntax is

required property <propertyType> <propertyName>

As the name suggests, required properties must be set when an instance of the object is created. Violation of this rule will result in QML applications not starting if it can be detected statically. In case of dynamically instantiated QML components (for instance via createComponent() ), violating this rule results in a warning and a null return value.

It’s possible to make an existing property required with

required <propertyName>

The following example shows how to create a custom Rectangle component, in which the color property always needs to be specified.

Note

You can’t assign an initial value to a required property from QML, as that would go directly against the intended usage of required properties.

Required properties play a special role in model-view-delegate code: If the delegate of a view has required properties whose names match with the role names of the view’s model, then those properties will be initialized with the model’s corresponding values. For more information, visit the Models and Views in Qt Quick page.

See createWithInitialProperties , setInitialProperties and QQuickView::setInitialProperties for ways to initialize required properties from C++.

Read-Only Properties#

An object declaration may define a read-only property using the readonly keyword, with the following syntax:

readonly property <propertyType> <propertyName> : <value>

Read-only properties must be assigned a static value or a binding expression on initialization. After a read-only property is initialized, you cannot change its static value or binding expression anymore.

For example, the code in the Component.onCompleted block below is invalid:

Note

A read-only property cannot also be a default property.

Property Modifier Objects#

Properties can have property value modifier objects associated with them. The syntax for declaring an instance of a property modifier type associated with a particular property is as follows:

<PropertyModifierTypeName> on <propertyName> {
    // attributes of the object instance
}

This is commonly referred to as “on” syntax.

It is important to note that the above syntax is in fact an object declaration which will instantiate an object which acts on a pre-existing property.

Certain property modifier types may only be applicable to specific property types, however this is not enforced by the language. For example, the NumberAnimation type provided by QtQuick will only animate numeric-type (such as int or real) properties. Attempting to use a NumberAnimation with non-numeric property will not result in an error, however the non-numeric property will not be animated. The behavior of a property modifier type when associated with a particular property type is defined by its implementation.

Signal Attributes#

A signal is a notification from an object that some event has occurred: for example, a property has changed, an animation has started or stopped, or when an image has been downloaded. The MouseArea type, for example, has a clicked signal that is emitted when the user clicks within the mouse area.

An object can be notified through a signal handler whenever a particular signal is emitted. A signal handler is declared with the syntax on<Signal> where <Signal> is the name of the signal, with the first letter capitalized. The signal handler must be declared within the definition of the object that emits the signal, and the handler should contain the block of JavaScript code to be executed when the signal handler is invoked.

For example, the onClicked signal handler below is declared within the MouseArea object definition, and is invoked when the MouseArea is clicked, causing a console message to be printed:

Defining Signal Attributes#

A signal may be defined for a type in C++ by registering a Q_SIGNAL of a class which is then registered with the QML type system. Alternatively, a custom signal for an object type may be defined in an object declaration in a QML document with the following syntax:

signal <signalName>[([<parameterName>: <parameterType>[, ...]])]

Attempting to declare two signals or methods with the same name in the same type block is an error. However, a new signal may reuse the name of an existing signal on the type. (This should be done with caution, as the existing signal may be hidden and become inaccessible.)

Here are three examples of signal declarations:

You can also specify signal parameters in property style syntax:

In order to be consistent with method declarations, you should prefer the type declarations using colons.

If the signal has no parameters, the “()” brackets are optional. If parameters are used, the parameter types must be declared, as for the string and int arguments for the actionPerformed signal above. The allowed parameter types are the same as those listed under Defining Property Attributes on this page.

To emit a signal, invoke it as a method. Any relevant signal handlers will be invoked when the signal is emitted, and handlers can use the defined signal argument names to access the respective arguments.

Property Change Signals#

QML types also provide built-in property change signals that are emitted whenever a property value changes, as previously described in the section on property attributes . See the upcoming section on property change signal handlers for more information about why these signals are useful, and how to use them.

Signal Handler Attributes#

Signal handlers are a special sort of method attribute , where the method implementation is invoked by the QML engine whenever the associated signal is emitted. Adding a signal to an object definition in QML will automatically add an associated signal handler to the object definition, which has, by default, an empty implementation. Clients can provide an implementation, to implement program logic.

Consider the following SquareButton type, whose definition is provided in the SquareButton.qml file as shown below, with signals activated and deactivated:

These signals could be received by any SquareButton objects in another QML file in the same directory, where implementations for the signal handlers are provided by the client:

Signal handlers don’t have to declare their parameter types because the signal already specifies them. The arrow function syntax shown above does not support type annotations.

See the Signal and Handler Event System for more details on use of signals.

Property Change Signal Handlers#

Signal handlers for property change signal take the syntax form on<Property>Changed where <Property> is the name of the property, with the first letter capitalized. For example, although the TextInput type documentation does not document a textChanged signal, this signal is implicitly available through the fact that TextInput has a text property and so it is possible to write an onTextChanged signal handler to be called whenever this property changes:

Method Attributes#

A method of an object type is a function which may be called to perform some processing or trigger further events. A method can be connected to a signal so that it is automatically invoked whenever the signal is emitted. See Signal and Handler Event System for more details.

Defining Method Attributes#

A method may be defined for a type in C++ by tagging a function of a class which is then registered with the QML type system with Q_INVOKABLE or by registering it as a Q_SLOT of the class. Alternatively, a custom method can be added to an object declaration in a QML document with the following syntax:

function <functionName>([<parameterName>[: <parameterType>][, ...]]) [: <returnType>] { <body> }

Methods can be added to a QML type in order to define standalone, reusable blocks of JavaScript code. These methods can be invoked either internally or by external objects.

Unlike signals, method parameter types do not have to be declared as they default to the var type. You should, however, declare them in order to help qmlcachegen generate more performant code, and to improve maintainability.

Attempting to declare two methods or signals with the same name in the same type block is an error. However, a new method may reuse the name of an existing method on the type. (This should be done with caution, as the existing method may be hidden and become inaccessible.)

Below is a Rectangle with a calculateHeight() method that is called when assigning the height value:

If the method has parameters, they are accessible by name within the method. Below, when the MouseArea is clicked it invokes the moveTo() method which can then refer to the received newX and newY parameters to reposition the text:

Attached Properties and Attached Signal Handlers#

Attached properties and attached signal handlers are mechanisms that enable objects to be annotated with extra properties or signal handlers that are otherwise unavailable to the object. In particular, they allow objects to access properties or signals that are specifically relevant to the individual object.

A QML type implementation may choose to attaching type :ref:` <Defining-QML-Types-from-C–>` in C++ with particular properties and signals. Instances of this type can then be created and attached to specific objects at run time, allowing those objects to access the properties and signals of the attaching type. These are accessed by prefixing the properties and respective signal handlers with the name of the attaching type.

References to attached properties and handlers take the following syntax form:

<AttachingType>.<propertyName>
<AttachingType>.on<SignalName>

For example, the ListView type has an attached property ListView.isCurrentItem that is available to each delegate object in a ListView. This can be used by each individual delegate object to determine whether it is the currently selected item in the view:

In this case, the name of the attaching type is ListView and the property in question is isCurrentItem, hence the attached property is referred to as ListView.isCurrentItem.

An attached signal handler is referred to in the same way. For example, the onCompleted attached signal handler is commonly used to execute some JavaScript code when a component’s creation process has been completed. In the example below, once the ListModel has been fully created, its Component.onCompleted signal handler will automatically be invoked to populate the model:

Since the name of the attaching type is Component and that type has a completed signal, the attached signal handler is referred to as Component.onCompleted.

A Note About Accessing Attached Properties and Signal Handlers#

A common error is to assume that attached properties and signal handlers are directly accessible from the children of the object to which these attributes have been attached. This is not the case. The instance of the attaching type is only attached to specific objects, not to the object and all of its children.

For example, below is a modified version of the earlier example involving attached properties. This time, the delegate is an Item and the colored Rectangle is a child of that item:

This does not work as expected because ListView.isCurrentItem is attached only to the root delegate object, and not its children. Since the Rectangle is a child of the delegate, rather than being the delegate itself, it cannot access the isCurrentItem attached property as ListView.isCurrentItem. So instead, the rectangle should access isCurrentItem through the root delegate:

Now delegateItem.ListView.isCurrentItem correctly refers to the isCurrentItem attached property of the delegate.

Enumeration Attributes#

Enumerations provide a fixed set of named choices. They can be declared in QML using the enum keyword:

As shown above, enumeration types (e.g. TextType) and values (e.g. Normal) must begin with an uppercase letter.

Values are referred to via <Type>.<EnumerationType>.<Value> or <Type>.<Value>.

More information on enumeration usage in QML can be found in the QML Value Types enumeration documentation.

The ability to declare enumerations in QML was introduced in Qt 5.10.