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

diff --git a/docs/labwc-actions.5.scd b/docs/labwc-actions.5.scd
index fa38698a378754676b005293d48ac7433b1b82be..7aa78507ba55c68bfb6e9c87998afe22d43980c9 100644 (file)
--- 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 d1ea8607780381d30a6ba56fe7347a15b964b37b..536d63a428dd257826531105382e14d74ed202e7 100644 (file)
--- 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">