En esta página

Qt QML Type

Proporciona un objeto global con enumeraciones y funciones útiles de Qt. Más...

Import Statement: import QtQml

Propiedades

Métodos

  • string QT_TRANSLATE_NOOP(string context, string sourceText, string disambiguation)
  • string QT_TRID_NOOP(string id)
  • string QT_TR_NOOP(string sourceText, string disambiguation)
  • color alpha(color baseColor, real value)
  • ArrayBuffer atob(ArrayBuffer data) (since 6.11)
  • var atob(var data) (since 6.11)
  • var binding(var function)
  • ArrayBuffer btoa(ArrayBuffer data) (since 6.11)
  • var btoa(var data) (since 6.11)
  • void callLater(function)
  • void callLater(function, argument1, argument2, ...)
  • color color(string name)
  • color colorEqual(color lhs, string rhs)
  • Component createComponent(url url, enumeration mode, QtObject parent)
  • Component createComponent(string moduleUri, string typeName, enumeration mode, QtObject parent) (since 6.5)
  • QtObject createQmlObject(string qml, QtObject parent, url url)
  • color darker(color baseColor, real factor)
  • real enumStringToValue(enumType, keyName)
  • string enumValueToString(enumType, keyValue)
  • list<string> enumValueToStrings(enumType, keyValue)
  • string escapeHtml(string data) (since 6.12)
  • void exit(int retCode)
  • font font(var fontSpecifier)
  • list<string> fontFamilies()
  • string formatDate(datetime date, variant format, variant localeFormatOption)
  • string formatDateTime(datetime dateTime, variant format, variant localeFormatOption)
  • string formatTime(datetime time, variant format, variant localeFormatOption)
  • void gc()
  • color hsla(real hue, real saturation, real lightness, real alpha)
  • color hsva(real hue, real saturation, real value, real alpha)
  • bool isQtObject(object)
  • color lighter(color baseColor, real factor)
  • locale locale(name)
  • string md5(data)
  • matrix4x4 matrix4x4()
  • matrix4x4 matrix4x4(var values)
  • matrix4x4 matrix4x4(real m11, real m12, real m13, real m14, real m21, real m22, real m23, real m24, real m31, real m32, real m33, real m34, real m41, real m42, real m43, real m44)
  • bool openUrlExternally(url target)
  • point point(real x, real y)
  • string qsTr(string sourceText, string disambiguation, int n)
  • string qsTrId(string id, int n)
  • string qsTranslate(string context, string sourceText, string disambiguation, int n)
  • quaternion quaternion(real scalar, real x, real y, real z)
  • void quit()
  • rect rect(real x, real y, real width, real height)
  • url resolvedUrl(url url)
  • url resolvedUrl(url url, object context)
  • color rgba(real red, real green, real blue, real alpha)
  • size size(real width, real height)
  • color tint(color baseColor, color tintColor)
  • url url(url url)
  • vector2d vector2d(real x, real y)
  • vector3d vector3d(real x, real y, real z)
  • vector4d vector4d(real x, real y, real z, real w)

Descripción detallada

Qt es un tipo singleton que proporciona funciones de utilidad, propiedades y enumeraciones. A continuación se muestra un ejemplo que ilustra cómo utilizar este tipo:

import QtQuick 2.0

Text {
    color: Qt.rgba(1, 0, 0, 1)
    text: Qt.md5("hello, world")
}

Enumeraciones

El objeto Qt contiene las enumeraciones disponibles en Qt Namespace. Por ejemplo, puedes acceder a los valores de las enumeraciones « Qt::LeftButton » y « Qt::RightButton » como « Qt.LeftButton » y « Qt.RightButton ».

Tipos

El objeto Qt también contiene funciones auxiliares para crear objetos de tipos de datos específicos. Esto resulta especialmente útil a la hora de establecer las propiedades de un elemento cuando la propiedad es de uno de los siguientes tipos:

Si se ha importado el módulo QtQuick, los clientes también tienen a su disposición las siguientes funciones auxiliares para crear objetos de tipos de datos específicos:

Formateadores de fecha y hora

El objeto Qt contiene varias funciones para dar formato a los valores de QDateTime, QDate y QTime.

La especificación de formato se describe en Qt.formatDateTime.

Creación dinámica de objetos

Las siguientes funciones del objeto global te permiten crear dinámicamente elementos QML a partir de archivos o cadenas de caracteres. Consulta «Creación dinámica de objetos QML desde JavaScript» para obtener una visión general de su uso.

Otras funciones

Las siguientes funciones también se encuentran en el objeto Qt.

Documentación de la propiedad

application : Application

El objeto ` application ` permite acceder a las propiedades de estado global de la aplicación que comparten muchos componentes QML.

Es el mismo que el singleton ` Application `.

El siguiente ejemplo utiliza el objeto ` application ` para indicar si la aplicación está activa en ese momento:

import QtQuick

Rectangle {
    width: 300; height: 55
    color: Qt.application.active ? "white" : "lightgray"
    Text {
        text: "Application " + (Qt.application.active ? "active" : "inactive")
        opacity: Qt.application.active ? 1.0 : 0.5
        anchors.centerIn: parent
    }
}

Nota: Al utilizar QML sin un ` QGuiApplication`, las siguientes propiedades quedarán sin definir:

  • application.active
  • application.state
  • application.layoutDirection
  • application.font

inputMethod : InputMethod

Es igual que el singleton ` InputMethod `.

El objeto ` inputMethod ` permite acceder al objeto ` QInputMethod ` de la aplicación y a todas sus propiedades y ranuras. Consulta la documentación de ` QInputMethod ` para obtener más detalles.

platform : var

El objeto ` platform ` proporciona información sobre la plataforma subyacente.

Sus propiedades son:

platform.osEsta propiedad de solo lectura contiene el nombre del sistema operativo.

Los valores posibles son:

  • "android" - Android
  • "ios" - iOS
  • "tvos" - tvOS
  • "visionos" - visionOS
  • "linux" - Linux
  • "osx" - macOS
  • "qnx" - QNX (desde Qt 5.9.3)
  • "unix" - Otros sistemas operativos basados en Unix
  • "windows" - Windows
  • "wasm" - WebAssembly

Nota: El valor de la propiedad en macOS es «osx», independientemente de la convención de nomenclatura de Apple. El valor devuelto se actualizará a «macos» para Qt 7.

platform.pluginNameEste es el nombre de la plataforma establecido en la instancia de ` QGuiApplication `, tal y como lo devuelve ` QGuiApplication::platformName()`

styleHints : QtObject

El objeto ` styleHints ` proporciona sugerencias y configuraciones de estilo específicas para cada plataforma. Consulta la documentación de ` QStyleHints ` para obtener más detalles.

Se recomienda acceder a StyleHints a través de Application::styleHints, ya que esto proporciona una mejor información de tipos para herramientas como el compilador deQt Quick .

Nota: El objeto ` styleHints ` solo está disponible cuando se utiliza el módulo ` Qt Quick `.

uiLanguage : string

La propiedad `uiLanguage` contiene el nombre del idioma que se utilizará para las traducciones de las cadenas de la interfaz de usuario. En C++, se expone como una propied QJSEngine::uiLanguage.

Puedes establecer el valor libremente y utilizarlo en los enlaces. Se recomienda configurarlo tras instalar los traductores en tu aplicación. Por convención, una cadena vacía significa que no se pretende realizar ninguna traducción desde el idioma utilizado en el código fuente.

Si utilizas ` QQmlApplicationEngine ` y el valor cambia, se llamará a ` QQmlEngine::retranslate()`.

Documentación del método

string QT_TRANSLATE_NOOP(string context, string sourceText, string disambiguation)

Marca « sourceText » para la traducción dinámica en el contexto dado « context »; es decir, el « sourceText » almacenado no se modificará.

Si se utiliza el mismo sourceText en diferentes roles dentro del mismo contexto de traducción, se puede pasar una cadena de identificación adicional para disambiguation.

Devuelve sourceText.

QT_TRANSLATE_NOOP se utiliza junto con las funciones de traducción dinámica qsTr() y qsTranslate(). Identifica una cadena como susceptible de traducción (de modo que pueda identificarse mediante lupdate), pero deja la traducción propiamente dicha en manos de las funciones dinámicas.

Ejemplo:

Item {
    property string greeting: QT_TRANSLATE_NOOP("CustomContext", "hello")

    Text { text: qsTranslate("CustomContext", greeting) }
}

Véase también Internacionalización con Qt.

string QT_TRID_NOOP(string id)

Marca « id » para la traducción dinámica.

Devuelve el id.

QT_TRID_NOOP se utiliza junto con la función de traducción dinámica qsTrId(). Identifica una cadena como susceptible de traducción (por lo que puede identificarse mediante lupdate), pero deja la traducción real en manos de qsTrId().

Ejemplo:

Item {
    property string greetingId: QT_TRID_NOOP("hello_id")

    Text { text: qsTrId(greetingId) }
}

Véase también qsTrId e Internacionalización con Qt.

string QT_TR_NOOP(string sourceText, string disambiguation)

Marca « sourceText » para la traducción dinámica; es decir, el archivo « sourceText » almacenado no se modificará.

Si se utiliza el mismo « sourceText » en diferentes roles dentro del mismo contexto de traducción, se puede pasar una cadena identificativa adicional para « disambiguation ».

Devuelve sourceText.

QT_TR_NOOP se utiliza junto con las funciones de traducción dinámica qsTr() y qsTranslate(). Identifica una cadena como susceptible de traducción (de modo que pueda ser identificada por lupdate), pero deja la traducción propiamente dicha en manos de las funciones dinámicas.

Ejemplo:

Item {
    property string greeting: QT_TR_NOOP("hello")

    Text { text: qsTr(greeting) }
}

Véase también Internacionalización con Qt.

color alpha(color baseColor, real value)

Devuelve « baseColor » con un valor alfa de « value ».

value es un número real que oscila entre 0 (totalmente transparente) y 1 (totalmente opaco).

Nota: Es preferible utilizar el tipo Color::transparent

[since 6.11] ArrayBuffer atob(ArrayBuffer data)

De ASCII a binario: esta función decodifica la cadena data, codificada en base64, y la devuelve.

Puedes pasar cualquier estructura similar a un array como « data », y la función intentará convertirla en un array de bytes. En concreto, esto funciona con una lista de números y una lista de cadenas de un solo carácter. Sin embargo, la forma más eficiente de hacerlo es pasando un objeto ` QByteArray ` o un objeto `ArrayBuffer` de JavaScript.

Si la conversión falla y resulta que el objeto de tipo « data » no tiene el formato esperado, se lanza una excepción de tipo « Invalid Character » y se devuelve una matriz vacía.

Este método se introdujo en Qt 6.11.

[since 6.11] var atob(var data)

De ASCII a binario: esta función decodifica el texto « data », codificado en Base64, y lo devuelve.

Se trata de una función sobrecargada.

Este método se introdujo en Qt 6.11.

var binding(var function)

Devuelve un objeto JavaScript que representa un enlace de propiedad, con un ` function ` que evalúa dicho enlace.

Hay dos casos de uso principales para esta función: en primer lugar, para aplicar un enlace de propiedad de forma imperativa desde código JavaScript:

Item {
    property bool someCondition: true
    property int edgePosition

    Component.onCompleted: {
        if (someCondition == true) {
            // bind to the result of the binding expression passed to Qt.binding()
            edgePosition = Qt.binding(function() { return x + width })
        }
    }
}

y, en segundo lugar, para aplicar un enlace de propiedad al inicializar los valores de las propiedades de objetos construidos dinámicamente (mediante Component.createObject() o Loader.setSource()).

Por ejemplo, suponiendo que existe un componente DynamicText:

import QtQuick

Text {
    id: textElement
    width: 200
    height: 200
    text: "Default text"
    property string dynamicText: "Dynamic text"
    onTextChanged: console.log(text)
}

el resultado de:

Item {
    id: root
    property string dynamicText: "Root text"

    Component.onCompleted: {
        var c = Qt.createComponent("DynamicText.qml")

        var obj1 = c.createObject(root, { 'text': Qt.binding(function() { return dynamicText + ' extra text' }) })
        root.dynamicText = "Modified root text"

        var obj2 = c.createObject(root, { 'text': Qt.binding(function() { return this.dynamicText + ' extra text' }) })
        obj2.dynamicText = "Modified dynamic text"
    }
}

y de:

Item {
    id: root
    property string dynamicText: "Root text"

    Loader {
        id: loaderOne
        onLoaded: root.dynamicText = "Modified root text"
    }

    Loader {
        id: loaderTwo
        onLoaded: item.dynamicText = "Modified dynamic text"
    }

    Component.onCompleted: {
        loaderOne.setSource("DynamicText.qml", { 'text': Qt.binding(function() { return dynamicText + ' extra text' }) })
        loaderTwo.setSource("DynamicText.qml", { 'text': Qt.binding(function() { return this.dynamicText + ' extra text' }) })
    }
}

debería ser, en ambos casos:

Root text extra text
Modified root text extra text
Dynamic text extra text
Modified dynamic text extra text

Esta función no se puede utilizar en declaraciones de enlace de propiedades (véase la documentación sobre declaraciones de enlace y asignaciones de enlace), salvo cuando el resultado se almacena en una matriz enlazada a una propiedad var.

Item {
    width: 50
    property var storedBindings: [ Qt.binding(function() { return x + width }) ] // stored
    property int a: Qt.binding(function() { return x + width }) // error!
    property int b

    Component.onCompleted: {
        b = storedBindings[0] // causes binding assignment
    }
}

[since 6.11] ArrayBuffer btoa(ArrayBuffer data)

De binario a ASCII: esta función devuelve una codificación Base64 de data.

Puedes pasar cualquier estructura similar a una matriz como « data », y la función intentará convertirla en una matriz de bytes. En concreto, esto funciona con una lista de números y una lista de cadenas de un solo carácter. Sin embargo, la forma más eficiente de hacerlo es pasando un objeto ` QByteArray ` o un objeto `ArrayBuffer` de JavaScript.

Si la conversión falla y resulta que el objeto de tipo « data » no tiene el formato esperado, se lanza una excepción « Invalid Character » y se devuelve una matriz vacía.

Este método se introdujo en Qt 6.11.

[since 6.11] var btoa(var data)

De binario a ASCII: esta función devuelve una codificación Base64 de data.

Se trata de una función sobrecargada.

Este método se introdujo en Qt 6.11.

void callLater(function)

void callLater(function, argument1, argument2, ...)

Utiliza esta función para eliminar llamadas redundantes a una función o señal.

La función pasada como primer argumento a Qt.callLater() se llamará más tarde, una vez que el motor QML vuelva al bucle de eventos.

Cuando esta función se invoca varias veces seguidas con la misma función como primer argumento, dicha función solo se invocará una vez.

Por ejemplo:

import QtQuick

Rectangle {
    width: 480
    height: 320

    property int callsToUpdateMinimumWidth: 0
    property bool optimize: true

    property int currentTextModel: 0
    property var columnTexts: [
        ["Click on either", "rectangle above", "and note how the counter", "below updates", "significantly faster using the", "regular (non-optimized)", "implementation"],
        ["The width", "of this column", "is", "no wider than the", "widest item"],
        ["Note how using Qt.callLater()", "the minimum width is", "calculated a bare-minimum", "number", "of times"]
    ]

    Text {
        x: 20; y: 280
        text: "Times minimum width has been calculated: " + callsToUpdateMinimumWidth
    }

    Row {
        y: 25; spacing: 30; anchors.horizontalCenter: parent.horizontalCenter
        Rectangle {
            width: 200; height:  50; color: "lightgreen"
            Text { text: "Optimized behavior\nusing Qt.callLater()"; anchors.centerIn: parent }
            MouseArea { anchors.fill: parent; onClicked: { optimize = true; currentTextModel++ } }
        }
        Rectangle {
            width: 200; height:  50; color: "lightblue"
            Text { text: "Regular behavior"; anchors.centerIn: parent}
            MouseArea { anchors.fill: parent; onClicked: { optimize = false; currentTextModel++ } }
        }
    }

    Column {
        id: column
        anchors.centerIn: parent

        onChildrenChanged: optimize ? Qt.callLater(updateMinimumWidth) : updateMinimumWidth()

        property int widestChild
        function updateMinimumWidth() {
            callsToUpdateMinimumWidth++
            var w = 0;
            for (var i in children) {
                var child = children[i];
                if (child.implicitWidth > w) {
                    w = child.implicitWidth;
                }
            }

            widestChild = w;
        }

        Repeater {
            id: repeater
            model: columnTexts[currentTextModel%3]
            delegate: Text {
                color: "white"
                text: modelData
                width: column.widestChild
                horizontalAlignment: Text.Center
                Rectangle { anchors.fill: parent; z: -1; color: index%2 ? "gray" : "darkgray" }
            }
        }
    }
}

callLaterCualquier argumento adicional pasado a Qt XML-ph-0000@deepl.internal se transmitirá a la función invocada. Ten en cuenta que, si se eliminan las llamadas redundantes, solo se pasará a la función el último conjunto de argumentos.

color color(string name)

Devuelve el color correspondiente al valor « name » proporcionado (es decir, «red» o «#ff0000»). Si no existe dicho color, se devuelve « null ».

Nota: Es preferible utilizar el tipo Color::fromString

color colorEqual(color lhs, string rhs)

Devuelve ` true ` si tanto ` lhs ` como ` rhs ` dan como resultado valores de color iguales. Ambos argumentos pueden ser valores de color o valores de cadena. Si se proporciona un valor de cadena, este debe poder convertirse en un color, tal y como se describe para el tipo de valor ` color `.

Nota: Es preferible utilizar el tipo Color::equal

Component createComponent(url url, enumeration mode, QtObject parent)

Devuelve un objeto ` Component ` creado a partir del archivo QML situado en la ruta especificada ` url`, o en ` null ` si se ha proporcionado una cadena vacía.

La propiedad Component::status del componente devuelto indica si el componente se ha creado correctamente. Si el estado es Component.Error, consulta Component::errorString() para obtener una descripción del error.

Si el parámetro opcional ` mode ` se establece en ` Component.Asynchronous`, el componente se cargará en un hilo en segundo plano. La propiedad ` Component::status ` tendrá el valor ` Component.Loading ` mientras se está cargando. El estado cambiará a ` Component.Ready ` si el componente se carga correctamente, o a ` Component.Error ` si la carga falla. Si se omite este parámetro, el valor por defecto es ` Component.PreferSynchronous `.

Si mode se establece en Component.PreferSynchronous, Qt intentará cargar el componente de forma sincrónica, pero puede acabar cargándolo de forma asincrónica si es necesario. Entre los casos que pueden provocar una carga asincrónica se incluyen, entre otros, los siguientes:

  • La URL hace referencia a un recurso de red
  • El componente se está creando como resultado de otro componente que se está cargando de forma asíncrona

Si se proporciona el parámetro opcional ` parent `, este debe hacer referencia al objeto que se convertirá en el padre del objeto ` Component ` creado. Si no se ha pasado ningún modo, este puede ser el segundo argumento.

Llama a Component.createObject() en el componente devuelto para crear una instancia del componente.

Por ejemplo:

import QtQuick

Item {
    id: container
    width: 300; height: 300

    function loadButton() {
        var component = Qt.createComponent("Button.qml");
        if (component.status == Component.Ready) {
            var button = component.createObject(container);
            button.color = "red";
        }
    }

    Component.onCompleted: loadButton()
}

Consulta Creación dinámica de objetos QML desde JavaScript para obtener más información sobre el uso de esta función.

Para crear un objeto QML a partir de una cadena arbitraria de QML (en lugar de un archivo), utiliza ` Qt.createQmlObject()`.

[since 6.5] Component createComponent(string moduleUri, string typeName, enumeration mode, QtObject parent)

Devuelve un objeto ` Component ` creado para el tipo especificado por ` moduleUri ` y ` typeName`.

import QtQml
QtObject {
    id: root
    property Component myComponent: Qt.createComponent("QtQuick", "Rectangle", Component.Asynchronous, root)
}

Esta sobrecarga se comporta en su mayor parte como la versión basada en ` url `, pero puede utilizarse para instanciar tipos que no tienen una URL (por ejemplo, tipos de C++ registrados a través de ` QML_ELEMENT`).

Nota: En algunos casos, pasar Component.Asynchronous no tendrá ningún efecto:

  • El tipo está implementado en C++
  • El tipo es un componente en línea.

Si se proporciona el parámetro opcional parent, debe hacer referencia al objeto que se convertirá en el padre del objeto Component creado. Si no se ha pasado ningún modo, este puede ser el segundo argumento.

Esta es una función sobrecargada.

Este método se introdujo en Qt 6.5.

QtObject createQmlObject(string qml, QtObject parent, url url)

Compila la cadena « qml » proporcionada en un componente y, a continuación, devuelve un nuevo objeto creado a partir de dicho componente. El nuevo objeto tendrá el « parent » especificado. Devuelve « null » si se ha producido un error al crear el componente o el objeto.

Si se especifica url, se utilizará como URL del componente. Esto resulta útil para la notificación de errores.

Advertencia: El nuevo componente ocultará cualquier componente existente con la misma URL. No debes pasar la URL de un componente ya existente. En concreto, al pasar la URL del archivo QML que lo contiene, impides que el nuevo componente acceda al componente que lo rodea.

Ejemplo (donde parentItem es el identificador de un elemento QML existente):

const newObject = Qt.createQmlObject(`
    import QtQuick

    Rectangle {
        color: "red"
        width: 20
        height: 20
    }
    `,
    parentItem,
    "myDynamicSnippet"
);

En caso de error, se lanza un objeto ` QQmlError `. Este objeto tiene una propiedad adicional, ` qmlErrors`, que es una matriz con los errores detectados. Cada objeto de esta matriz tiene los miembros ` lineNumber`, ` columnNumber`, ` fileName ` y ` message`. Por ejemplo, si en el fragmento de código anterior se hubiera escrito mal la palabra «color» como «colro», la matriz contendría un objeto como el siguiente: { «lineNumber» : 1, «columnNumber» : 32, «fileName» : «dynamicSnippet1», «message» : "No se puede asignar a la propiedad inexistente «colro»"}.

Nota: Esta función devuelve un resultado de forma inmediata y, por lo tanto, puede que no funcione si la cadena « qml » carga nuevos componentes (es decir, archivos QML externos que aún no se han cargado). Si este es el caso, plantéate utilizar « Qt.createComponent()» en su lugar.

Advertencia: Esta función es extremadamente lenta, ya que tiene que compilar la cadena QML pasada cada vez que se invoca. Además, es muy fácil generar código QML no válido al construir código QML mediante programación. Es mucho mejor mantener los componentes QML en archivos independientes y añadir propiedades y métodos para personalizar su comportamiento, en lugar de crear nuevos componentes mediante la manipulación de cadenas.

Consulta «Creación dinámica de objetos QML desde JavaScript» para obtener más información sobre el uso de esta función.

color darker(color baseColor, real factor)

Devuelve un color más oscuro que baseColor en la cantidad indicada por factor.

Si el factor es mayor que 1,0, esta función devuelve un color más oscuro. Si se establece el factor en 3,0, devuelve un color con un tercio del brillo. Si el factor es menor que 1,0, el color devuelto es más claro, pero recomendamos utilizar la función Qt.lighter() para este fin. Si el factor es 0 o negativo, el valor devuelto no está especificado.

La función convierte el color RGB actual a HSV, divide el valor del componente (V) por el factor y vuelve a convertir el color a RGB.

Si no se proporciona ` factor `, devuelve un color un 50 % más oscuro que ` baseColor ` (factor 2,0).

Nota: Es preferible utilizar el tipo Color::darker

real enumStringToValue(enumType, keyName)

Devuelve el valor numérico de la clave « keyName » de la enumeración « enumType ». Si no se encuentra la enumeración, se lanza una excepción de tipo « TypeError ». Si la clave no es una entrada de la enumeración, se lanza una excepción de tipo « ReferenceError ».

string enumValueToString(enumType, keyValue)

Devuelve la representación como cadena de una clave de la enumeración enumType que tiene el valor keyValue. Si no se encuentra la enumeración, se lanza una excepción de tipo TypeError. Si el valor no coincide con ninguna clave de la enumeración, se lanza una excepción de tipo ReferenceError.

Nota: Si varias claves coinciden con el valor de ` keyValue`, no se especifica cuál de las claves coincidentes se devolverá. En ese caso, utilice ` enumValueToStrings `.

list<string> enumValueToStrings(enumType, keyValue)

Devuelve una lista con la representación como cadena de todas las claves de la enumeración enumType que tengan el valor keyValue. Si no se encuentra la enumeración, se lanza una excepción de tipo TypeError. Si ninguna clave de la enumeración tiene el valor keyValue, se lanza una excepción de tipo ReferenceError.

[since 6.12] string escapeHtml(string data)

Devuelve data con los caracteres especiales de HTML escapados.

Esta función convierte la cadena de texto sin formato data en una cadena HTML en la que los metacaracteres HTML <, >, & y " se sustituyen por entidades HTML.

Ejemplo:

var plain = "<script>alert('XSS')</script>";
var escaped = Qt.escapeHtml(plain);
// escaped is now "&lt;script&gt;alert('XSS')&lt;/script&gt;"

Este método se introdujo en Qt 6.12.

Véase también QString::toHtmlEscaped().

void exit(int retCode)

Esta función provoca que se emita la señal « QQmlEngine::exit(int)». Dentro de la herramienta QML, esto hace que la aplicación de inicio se cierre con el código de retorno especificado (retCode). Para salir del bucle de eventos con un código de retorno especificado cuando se llama a este método, una aplicación en C++ puede conectar la señal « QQmlEngine::exit(int)» a la ranura « QCoreApplication::exit(int)».

Véase también quit().

font font(var fontSpecifier)

Devuelve una fuente con las propiedades especificadas en el objeto ` fontSpecifier ` o la fuente más parecida. El objeto ` fontSpecifier ` debe contener pares clave-valor, en los que las claves válidas sean los nombres de las subpropiedades del tipo ` font `, y los valores sean valores válidos para cada subpropiedad. Las claves no válidas se ignorarán.

list<string> fontFamilies()

Devuelve una lista de las familias de fuentes disponibles para la aplicación.

string formatDate(datetime date, variant format, variant localeFormatOption)

Devuelve una representación en forma de cadena de ` date`, con formato opcional según ` format`.

El parámetro date puede ser un objeto JavaScript Date, una propiedad date, un QDate o un valor QDateTime. Los parámetros format y localeFormatOption pueden ser cualquiera de los valores de formato posibles, tal y como se describe para Qt.formatDateTime().

Si no se especifica format, date se formatea utilizando Locale.ShortFormat con la configuración regional predeterminada.

Véase también Locale.

string formatDateTime(datetime dateTime, variant format, variant localeFormatOption)

Devuelve una representación en forma de cadena de ` dateTime`, con formato opcional mediante ` format ` y ` localeFormatOption`.

El parámetro ` dateTime ` puede ser un objeto ` Date ` de JavaScript, una propiedad ` date `, o bien un valor de ` QDate`, ` QTime` o ` QDateTime `.

Si no se proporciona format, dateTime se formatea utilizando Locale.ShortFormat con la configuración regional predeterminada. De lo contrario, format debe ser:

  • Uno de los valores de la enumeración « Qt::DateFormat », como « Qt.RFC2822Date » o « Qt.ISODate ».
  • Una cadena que especifique el formato de la cadena devuelta, tal y como se detalla a continuación.
  • Un objeto ` locale `.

Si ` format ` especifica un objeto de configuración regional, ` dateTime ` se formatea con ` QLocale::toString`. En este caso, ` localeFormatOption ` puede contener un valor de tipo ` QLocale::FormatType ` para ajustar aún más el formato. Si no se proporciona ninguno, se utiliza ` Locale.ShortFormat `.

Si format especifica una cadena de formato, debe utilizar las siguientes expresiones para indicar la fecha:

ExpresiónSalida
del día como número sin cero inicial (del 1 al 31)
ddel día como número con un cero a la izquierda (del 01 al 31)
dddel nombre abreviado del día según la configuración regional (p. ej., de «Lun» a «Dom»). Utiliza QDate::shortDayName().
ddddel nombre completo del día en la configuración regional (p. ej., «Monday» a «Qt::Sunday »). Utiliza QDate::longDayName().
Mel mes como número sin cero inicial (1-12)
MMel mes como número con un cero inicial (01-12)
MMMel nombre abreviado del mes según la configuración regional (p. ej., de «Jan» a «Dec»). Utiliza QDate::shortMonthName().
MMMMel nombre completo del mes en la versión localizada (p. ej., «January» a «December»). Utiliza QDate::longMonthName().
yyel año expresado como un número de dos dígitos (00-99)
yyyyel año como número de cuatro dígitos

Además, se pueden utilizar las siguientes expresiones para especificar la hora:

ExpresiónResultado
hla hora sin el cero inicial (del 0 al 23 o del 1 al 12 si se muestra AM/PM)
hhla hora con un cero inicial (de 00 a 23 o de 01 a 12 si se muestra AM/PM)
mlos minutos sin el cero inicial (de 0 a 59)
mmel minuto con un cero inicial (de 00 a 59)
sel segundo sin el cero inicial (de 0 a 59)
ssel segundo con un cero inicial (de 00 a 59)
zlos milisegundos sin ceros a la izquierda (de 0 a 999)
zzzlos milisegundos con ceros a la izquierda (de 000 a 999)
APutiliza el formato AM/PM. AP se sustituirá por «AM» o «PM».
aputiliza el formato AM/PM. «ap» se sustituirá por «am» o «pm».
tincluir un indicador de zona horaria.

Se ignorarán todos los demás caracteres introducidos. Cualquier secuencia de caracteres entre comillas simples se tratará como texto y no se utilizará como expresión. Dos comillas simples consecutivas («''») se sustituyen por una sola comilla simple en la salida.

Por ejemplo, si se especificara el siguiente valor de fecha y hora:

// 21 May 2001 14:13:09
var dateTime = new Date(2001, 5, 21, 14, 13, 09)

Este valor « dateTime » podría pasarse a Qt.formatDateTime(), Qt.formatDate() o Qt.formatTime() con los valores « format » que se indican a continuación para obtener los siguientes resultados:

FormatoResultado
«dd.MM.aaaa»21.05.2001
«ddd MMMM d yy»Martes, 21 de mayo de 01
«hh:mm:ss.zzz»14:13:09.042
«h:m:s ap»2:13:9 p. m.

Véase también Locale.

string formatTime(datetime time, variant format, variant localeFormatOption)

Devuelve una representación en forma de cadena de ` time`, con formato opcional según ` format` y, si se proporciona, ` localeFormatOption`.

El parámetro ` time ` puede ser un objeto JavaScript ` Date `, un ` QTime` o un valor ` QDateTime `. Los parámetros ` format ` y ` localeFormatOption ` pueden ser cualquiera de los valores de formato posibles, tal y como se describe para ` Qt.formatDateTime()`.

Si no se especifica format, time se formatea utilizando Locale.ShortFormat con la configuración regional predeterminada.

Véase también Locale.

void gc()

Ejecuta el recolector de basura.

Esto equivale a llamar a ` QJSEngine::collectGarbage()`.

Véase también «Recolección de basura».

color hsla(real hue, real saturation, real lightness, real alpha)

Devuelve un color con los componentes especificados hue, saturation, lightness y alpha. Todos los componentes deben estar comprendidos entre 0 y 1 (ambos inclusive).

Nota: Es preferible utilizar el tipo Color::hsla

color hsva(real hue, real saturation, real value, real alpha)

Devuelve un color con los componentes especificados « hue », « saturation », « value » y « alpha ». Todos los componentes deben estar comprendidos entre 0 y 1 (ambos incluidos).

Nota: Es preferible utilizar el tipo Color::hsva

bool isQtObject(object)

Devuelve ` true ` si ` object ` es una referencia válida a un objeto Qt o QML; en caso contrario, devuelve ` false `.

color lighter(color baseColor, real factor)

Devuelve un color más claro que baseColor en la proporción indicada por factor.

Si el factor es mayor que 1,0, esta función devuelve un color más claro. Si se establece el factor en 1,5, se devuelve un color un 50 % más brillante. Si el factor es menor que 1,0, el color devuelto es más oscuro, pero recomendamos utilizar la función Qt.darker() para este fin. Si el factor es 0 o negativo, el valor devuelto no está especificado.

La función convierte el color RGB actual a HSV, multiplica el componente del valor (V) por el factor y vuelve a convertir el color a RGB.

Si no se proporciona factor, devuelve un color un 50 % más claro que baseColor (factor 1,5).

Nota: Es preferible utilizar el tipo Color::lighter

locale locale(name)

Devuelve un objeto JS que representa la configuración regional con el « name » especificado, que tiene el formato «idioma[_territorio][.juego de caracteres][@modificador]» o «C», donde:

  • language es un código de idioma ISO 639 de dos letras en minúsculas,
  • territory es un código de país ISO 3166 de dos letras en mayúsculas, y
  • codeset y « modifier » se ignoran.

Si la cadena incumple el formato de configuración regional, o si «language» no es un código ISO 369 válido, se utiliza en su lugar la configuración regional «C». Si «country» no está presente, o no es un código ISO 3166 válido, se elige el país más adecuado para el idioma especificado.

El objeto devuelto es de un tipo QML anónimo respaldado por QLocale.

Véase también Locale.

string md5(data)

Devuelve una cadena hexadecimal con el hash MD5 de data.

matrix4x4 matrix4x4()

Devuelve una matriz de identidad de 4x4.

matrix4x4 matrix4x4(var values)

Devuelve una matriz de 4x4 con el ` values` especificado. Se espera que ` values ` sea un array de JavaScript con 16 elementos.

Los índices del array se corresponden con las posiciones en la matriz de la siguiente manera:

0123
4567
891011
12131415

matrix4x4 matrix4x4(real m11, real m12, real m13, real m14, real m21, real m22, real m23, real m24, real m31, real m32, real m33, real m34, real m41, real m42, real m43, real m44)

Devuelve una matriz de 4x4 con los valores especificados.

Los argumentos se corresponden con sus posiciones en la matriz:

m11m12m13m14
m21m22m23m24
m31m32m33m34
m41m42m43m44

bool openUrlExternally(url target)

Intenta abrir la URL especificada target en una aplicación externa, según las preferencias de escritorio del usuario. Devuelve true si se realiza con éxito; en caso contrario, devuelve false.

Si target es una URL relativa, se resolverá. A continuación, la URL se reenviará a QDesktopServices::openUrl.

Advertencia: Un valor de retorno de ` true ` indica que la aplicación ha solicitado con éxito al sistema operativo que abra la URL en una aplicación externa. Es posible que la aplicación externa no se inicie o no consiga abrir la URL solicitada. Este resultado no se comunicará a la aplicación.

Advertencia: Pasar URL no fiables a `openUrlExternally` puede provocar un comportamiento inesperado. Si se van a pasar URL no fiables a esta función, crea un objeto URL de JavaScript y comprueba su propiedad ` protocol ` con una lista de protocolos permitidos. También puedes aplicar un filtrado adicional basándote en otras propiedades, como ` host`.

point point(real x, real y)

Devuelve un punto con las coordenadas especificadas en « x » y « y ».

string qsTr(string sourceText, string disambiguation, int n)

Devuelve una versión traducida de sourceText, basada opcionalmente en una cadena de disambiguation y en el valor de n para las cadenas que contengan plurales; en caso contrario, devuelve la propia sourceText si no hay disponible ninguna cadena traducida adecuada.

Ejemplos con sourceText y n:

    Text { text: qsTr("hello") }
    // Translates the source text into the correct
    // plural form and replaces %n with the value of total.
    Text {
        text: qsTr("%n message(s) saved", "", total)
    }

Si se utiliza el mismo « sourceText » en diferentes roles dentro del mismo contexto de traducción, se puede pasar una cadena identificativa adicional a « disambiguation ». Para obtener más información y ejemplos, consulta «Desambiguación de texto idéntico».

Véase también qsTranslate(), Internacionalización con Qt y Redacción de código fuente para su traducción.

string qsTrId(string id, int n)

Devuelve una cadena traducida identificada por id. Si no se encuentra ninguna cadena que coincida, se devuelve el propio identificador. Esto no debería ocurrir en condiciones normales.

Si n >= 0, todas las apariciones de « %n » en la cadena resultante se sustituyen por una representación decimal de « n ». Además, dependiendo del valor de n, el texto traducido puede variar.

Ejemplo:

Text { text: qsTrId("hello_id") }

Es posible proporcionar una plantilla de cadena de origen como:

//% <string>

    Text {
        //% "hello"
        text: qsTrId("hello_id")
    }

o

/*% <string> */

    Text {
        /*% "hello" */
        text: qsTrId("hello_id")
    }

Para crear archivos de traducción binarios (QM) adecuados para su uso con esta función, es necesario pasar la opción -idbased a la herramienta lrelease.

Véase también QT_TRID_NOOP() e Internacionalización con Qt.

string qsTranslate(string context, string sourceText, string disambiguation, int n)

Devuelve una versión traducida de sourceText dentro del context dado, opcionalmente basada en una cadena disambiguation y en el valor de n para las cadenas que contengan plurales; de lo contrario, devuelve la propia sourceText si no hay disponible ninguna cadena traducida adecuada.

Si se utiliza el mismo sourceText en diferentes roles dentro del mismo context de traducción, se puede pasar una cadena identificativa adicional para disambiguation.

Ejemplo:

Text { text: qsTranslate("CustomContext", "hello") }

Úsalo si tienes una traducción context que difiere del archivo context.

Véase también «Internacionalización con Qt XML» y « qsTr()».

quaternion quaternion(real scalar, real x, real y, real z)

Devuelve un cuaternión con los valores especificados para « scalar », « x », « y » y « z ».

void quit()

Esta función provoca que se emita la señal ` QQmlEngine::quit()`. En la herramienta QML, esto hace que la aplicación de inicio se cierre; para cerrar una aplicación en C++ cuando se llame a este método, conecta la señal ` QQmlEngine::quit()` a la ranura ` QCoreApplication::quit()`.

Véase también exit().

rect rect(real x, real y, real width, real height)

Devuelve un rect cuya esquina superior izquierda se encuentra en x y y, y cuyos valores de width y height son los especificados.

url resolvedUrl(url url)

Devuelve url resuelto de forma relativa a la URL del llamante.

Si no hay ningún llamante o si este no está asociado a un contexto QML, devuelve url resuelto en relación con la URL base del motor QML. Si el motor QML no tiene URL base, simplemente devuelve url.

Véase también url().

url resolvedUrl(url url, object context)

Devuelve url resuelto de forma relativa a la URL del contexto QML de context. Si context no está asociado a ningún contexto QML, devuelve url resuelto de forma relativa a la URL base del motor QML. Si el motor QML no tiene URL base, simplemente devuelve url.

Véase también url().

color rgba(real red, real green, real blue, real alpha)

Devuelve un color con los componentes especificados red, green, blue y alpha. Todos los componentes deben estar comprendidos entre 0 y 1, ambos inclusive.

Nota: Es preferible utilizar el tipo Color::rgba

size size(real width, real height)

Devuelve un tamaño con los valores especificados en « width » y « height ».

color tint(color baseColor, color tintColor)

Esta función permite aplicar un matiz a un color (baseColor) con otro (tintColor).

El color de matiz suele ser mayoritariamente transparente; de lo contrario, no se podrá ver el color subyacente. El ejemplo siguiente proporciona un ligero matiz rojizo al utilizar como color de matiz un rojo puro con una opacidad de solo 1/16.

Item {
    Rectangle {
        x: 0; width: 80; height: 80
        color: "lightsteelblue"
    }
    Rectangle {
        x: 100; width: 80; height: 80
        color: Qt.tint("lightsteelblue", "#10FF0000")
    }
}

Representación en paralelo de un cuadrado de color azul acero claro y un cuadrado de color azul acero claro al que se le ha aplicado un matiz

El matiz resulta especialmente útil cuando se pretende transmitir un cambio sutil debido a algún evento; en ese caso, puedes utilizar el matiz para ajustar de forma más eficaz el color visible.

Nota: Es preferible utilizar el tipo Color::tint

url url(url url)

Devuelve « url » tal cual. Esto se puede utilizar para forzar una conversión de tipo a « url ». A diferencia de Qt.resolvedUrl(), esta función conserva las URL relativas. Dado que las cadenas se convierten implícitamente en URL, la función se puede invocar con una cadena como argumento y, en ese caso, devolverá una URL.

Véase también resolvedUrl().

vector2d vector2d(real x, real y)

Devuelve un vector2d con los valores especificados de « x » y « y ».

vector3d vector3d(real x, real y, real z)

Devuelve un vector3d con los valores especificados de « x », « y » y « z ».

vector4d vector4d(real x, real y, real z, real w)

Devuelve un vector4d con los valores especificados para « x », « y », « z » y « w ».

© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.