document get_extents_relative_to return code

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

1 files changed, 9 insertions, 0 deletions

diff --git a/include/vcl/weld.hxx b/include/vcl/weld.hxx
index c8eeb9ba04a0..82dd5fb2c00c 100644
--- a/include/vcl/weld.hxx
+++ b/include/vcl/weld.hxx
@@ -146,6 +146,15 @@ public:
     virtual int get_margin_left() const = 0;
     virtual int get_margin_right() const = 0;
 
+    /*
+     * Report the extents of this widget relative to the rRelative target widget.
+     *
+     * To succeed, both widgets must be realized, and must share a common toplevel.
+     *
+     * returns false if the relative extents could not be determined, e.g. if
+     * either widget was not realized, or there was no common ancestor.
+     * Otherwise true.
+     */
     virtual bool get_extents_relative_to(Widget& rRelative, int& x, int& y, int& width, int& height)
         = 0;