[Libreoffice-commits] core.git: include/vcl

[Caolán McNamara (via logerrit)]

 include/vcl/weld.hxx |   13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

New commits:
commit c50d544595700825b30ac0942197755259969cf0
Author:     Caolán McNamara <caolanm at redhat.com>
AuthorDate: Mon Aug 24 09:40:01 2020 +0100
Commit:     Caolán McNamara <caolanm at redhat.com>
CommitDate: Mon Aug 24 15:15:07 2020 +0200

    add documentation to get_buildable_name
    
    Change-Id: Idb18905f741cbb6f25508c3b9afc0ae6cca7abd2
    Reviewed-on: https://gerrit.libreoffice.org/c/core/+/101270
    Tested-by: Jenkins
    Reviewed-by: Caolán McNamara <caolanm at redhat.com>

diff --git a/include/vcl/weld.hxx b/include/vcl/weld.hxx
index 98880ca76f43..49c6daa8d8dc 100644
--- a/include/vcl/weld.hxx
+++ b/include/vcl/weld.hxx
@@ -113,9 +113,20 @@ public:
     virtual float get_approximate_digit_width() const = 0;
     virtual int get_text_height() const = 0;
     virtual Size get_pixel_size(const OUString& rText) const = 0;
+
+    // The name of the widget in the GtkBuilder UI definition used to construct it.
     virtual OString get_buildable_name() const = 0;
-    virtual void set_help_id(const OString& rName) = 0;
+
+    /* The help id of the widget used to identify help for this widget.
+     *
+     * By default the help id of a a widget is a path-like sequence of
+     * buildable-names from the widgets UI definition ancestor to this
+     * widget, e.g. grandparent/parent/widget.
+     *
+     * The default can be overwritten with set_help_id
+     */
     virtual OString get_help_id() const = 0;
+    virtual void set_help_id(const OString& rName) = 0;
 
     virtual void set_grid_left_attach(int nAttach) = 0;
     virtual int get_grid_left_attach() const = 0;