From: Johan Malm <jgm323@gmail.com>
Date: Tue, 24 Jun 2025 19:44:32 +0000 (+0100)
Subject: labwc-action(5): describe If action <prompt>
X-Git-Url: https://git.mdlowis.com/?a=commitdiff_plain;h=8a5a04cc1a49f270b14400e1274cdebbfe050aee;p=proto%2Flabwc.git

labwc-action(5): describe If action <prompt>
---

diff --git a/docs/labwc-actions.5.scd b/docs/labwc-actions.5.scd
index fa38698a..7aa78507 100644
--- a/docs/labwc-actions.5.scd
+++ b/docs/labwc-actions.5.scd
@@ -423,6 +423,7 @@ Actions that execute other actions. Used in keyboard/mouse bindings.
 	```
 	<action name="If">
 	  <query/>
+	  <prompt message=""/>
 	  <then><action/></then>
 	  <else><action/></else>
 	</action>
@@ -494,6 +495,26 @@ Actions that execute other actions. Used in keyboard/mouse bindings.
 
 		This argument is optional.
 
+	*prompt*
+		Display a yes/no prompt dialog (labnag by default). If 'yes' is
+		selected, the *then* branch will be taken; and similarly with
+		'no' and *else*. This argument is optional. Note that the syntax
+		is different to that of Openbox where a prompt element is not
+		tied to If-actions but would just be a child of the downstream
+		action. The reason for this difference is increased flexibility
+		and functionality gained by optionally using an *else* branch.
+
+		```
+		<keybind key="W-q">
+		  <action name="If">
+		    <prompt message="Quit?"/>
+		    <then>
+		      <action name="Exit"/>
+		    </then>
+		  </action>
+		</keybind>
+		```
+
 	*then*
 		A list of actions to be executed if the window matches any
 		query. This argument is optional.
diff --git a/docs/menu.xml b/docs/menu.xml
index d1ea8607..536d63a4 100644
--- a/docs/menu.xml
+++ b/docs/menu.xml
@@ -65,6 +65,16 @@
   <item label="Exit">
     <action name="Exit" />
   </item>
+  <!--
+  # A prompt can be used as follows:
+  <item label="Exit">
+    <action name="If"/>
+      <prompt message="Do you really want to exit the compositor?"/>
+      <then>
+        <action name="Exit"/>
+      </then>
+  </item>
+  -->
 </menu>
 
 <menu id="some-custom-menu">