Qt Quick Overlay Role Parameters

Detailed Description

Collaboration diagram for Qt Quick Overlay Role Parameters:

Variables
constexpr const char *	QtQuickOverlayConfig::bindQmlPropertyToAttribute = "bindQmlPropertyToAttribute"
constexpr const char *	QtQuickOverlayConfig::qmlDataItemObjectName = "qmlDataItemObjectName"
constexpr const char *	QtQuickOverlayConfig::qmlFilename = "qmlFilename"
constexpr const char *	QtQuickOverlayConfig::qmlTargetWindow = "qmlTargetWindow"
constexpr const char *	QtQuickOverlayConfig::renderOverlayOnly = "renderOverlayOnly"
constexpr const char *	QtQuickOverlayConfig::visibilityAttribute = "visibilityAttribute"

Variable Documentation

bindQmlPropertyToAttribute

const char* QtQuickOverlayConfig::bindQmlPropertyToAttribute = "bindQmlPropertyToAttribute"

constexpr

Parameter Name	bindQmlPropertyToAttribute
Parameter Description	Table of bindings from state attributes to QML properties.
Parameter Type	DtInitTable
Parameter Default	N/A
Required?	Yes

Example Role Config Usage:

["qtQuickOverlay"] = { 
   ... 
   bindQmlPropertyToAttribute = "Table"; 
   ... 
};

qmlDataItemObjectName

const char* QtQuickOverlayConfig::qmlDataItemObjectName = "qmlDataItemObjectName"

constexpr

Parameter Name	qmlDataItemObjectName
Parameter Description	Name of the QML object to bind data to.
Parameter Type	string
Parameter Default	N/A
Required?	Yes

Example Role Config Usage:

["qtQuickOverlay"] = { 
   ... 
   qmlDataItemObjectName = "dataItem"; 
   ... 
};

qmlFilename

const char* QtQuickOverlayConfig::qmlFilename = "qmlFilename"

constexpr

Parameter Name	qmlFilename
Parameter Description	Path to the QML file to load.
Parameter Type	string
Parameter Default	N/A
Required?	Yes

Example Role Config Usage:

["qtQuickOverlay"] = { 
   ... 
   qmlFilename = "overlay.qml"; 
   ... 
};

qmlTargetWindow

const char* QtQuickOverlayConfig::qmlTargetWindow = "qmlTargetWindow"

constexpr

Parameter Name	qmlTargetWindow
Parameter Description	Window to display the overlay on.
Parameter Type	string
Parameter Default	""
Required?	No

Example Role Config Usage:

["qtQuickOverlay"] = { 
   ... 
   qmlTargetWindow = ""; 
   ... 
};

renderOverlayOnly

const char* QtQuickOverlayConfig::renderOverlayOnly = "renderOverlayOnly"

constexpr

Parameter Name	renderOverlayOnly
Parameter Description	If true hides the 3D scene when the overlay is visible.
Parameter Type	bool
Parameter Default	false
Required?	No

Example Role Config Usage:

["qtQuickOverlay"] = { 
   ... 
   renderOverlayOnly = false; 
   ... 
};

visibilityAttribute

const char* QtQuickOverlayConfig::visibilityAttribute = "visibilityAttribute"

constexpr

Parameter Name	visibilityAttribute
Parameter Description	Attribute name to control overlay visibility.
Parameter Type	string
Parameter Default	""
Required?	No

Example Role Config Usage:

["qtQuickOverlay"] = { 
   ... 
   visibilityAttribute = ""; 
   ... 
};