{ "name": "RetainableLock", "module": "Quickshell", "type": "class", "super": { "type": "qt", "module": "qml.QtQml", "name": "QtObject" }, "description": "A helper for easily using Retainable.", "details": "A RetainableLock provides extra safety and ease of use for locking\nTYPE99MQS_Quickshell99NRetainable99TYPE objects. A retainable object can be locked by multiple\nlocks at once, and each lock re-exposes relevant properties\nof the retained objects.\n\n#### Example\nThe code below will keep a retainable object alive for as long as the\nRetainableLock exists.\n\n```qml\nRetainableLock {\n object: aRetainableObject\n locked: true\n}\n```\n", "properties": { "retained": { "type": { "type": "qt", "module": "qml", "name": "bool" }, "details": "If the object is currently in a retained state.\n", "flags": [ "readonly" ] }, "object": { "type": { "type": "qt", "module": "qml.QtQml", "name": "QtObject" }, "details": "The object to lock. Must be TYPE99MQS_Quickshell99NRetainable99TYPE.\n" }, "locked": { "type": { "type": "qt", "module": "qml", "name": "bool" }, "details": "If the object should be locked.\n" } }, "functions": [], "signals": { "dropped": { "name": "dropped", "details": "Rebroadcast of the object's TYPE99MQS_Quickshell99NRetainable99Vdropped99Tsignal99TYPE.\n", "params": [] }, "aboutToDestroy": { "name": "aboutToDestroy", "details": "Rebroadcast of the object's TYPE99MQS_Quickshell99NRetainable99VaboutToDestroy99Tsignal99TYPE.\n", "params": [] } }, "variants": {} }