document how to align extra widgets with message dialog labels

Change-Id: I6c64d1b637120cab71de5f521c0c0268f2f80732
Reviewed-on: https://gerrit.libreoffice.org/78870
Tested-by: Jenkins
Reviewed-by: Caolán McNamara <caolanm@redhat.com>
Tested-by: Caolán McNamara <caolanm@redhat.com>

1 files changed, 10 insertions, 0 deletions

diff --git a/include/vcl/weld.hxx b/include/vcl/weld.hxx
index 18637cceda7b..d3fd087333df 100644
--- a/include/vcl/weld.hxx
+++ b/include/vcl/weld.hxx
@@ -1936,6 +1936,16 @@ protected:
     std::unique_ptr<weld::Container> m_xOrigParent;
 
 public:
+    /* @param rRelocateId - optional argument of the name of a widget in the .ui file
+                            which should be relocated into the content area of the dialog.
+
+                            e.g. a checkbox for a "Never show this again" option.
+
+                            This results in the named widget relocating to the same container
+                            as the messages.  This enables aligning the extra widget with the
+                            message labels in the content area container which doesn't
+                            explicitly exist in the ui description, but is only implied.
+    */
     MessageDialogController(weld::Widget* pParent, const OUString& rUIFile,
                             const OString& rDialogId, const OString& rRelocateId = OString());
     virtual Dialog* getDialog() override;