summaryrefslogtreecommitdiff
path: root/include/svtools
diff options
context:
space:
mode:
authorJulien Nabet <serval2412@yahoo.fr>2024-01-05 13:50:34 +0100
committerMiklos Vajna <vmiklos@collabora.com>2024-01-12 11:40:58 +0100
commit8f215fab5593070556e903121cc195660e16105c (patch)
tree72f59caf3e24d4861ae4ae82dd9ede05e95069be /include/svtools
parent43a7d21f99a08185ccbb3cc7b4cb9e9851c4d418 (diff)
Document a bit async methods
Retrieved from Miklos' feedback in https://lists.freedesktop.org/archives/libreoffice/2024-January/091377.html Thank you to him! Change-Id: I13f074b12cae0ffbc78a4c580d7f0ce58f0ea1e6 Reviewed-on: https://gerrit.libreoffice.org/c/core/+/161664 Reviewed-by: Miklos Vajna <vmiklos@collabora.com> Tested-by: Jenkins
Diffstat (limited to 'include/svtools')
-rw-r--r--include/svtools/genericasyncunodialog.hxx7
1 files changed, 7 insertions, 0 deletions
diff --git a/include/svtools/genericasyncunodialog.hxx b/include/svtools/genericasyncunodialog.hxx
index 058c37b00cdb..64fe80d5f9eb 100644
--- a/include/svtools/genericasyncunodialog.hxx
+++ b/include/svtools/genericasyncunodialog.hxx
@@ -32,6 +32,13 @@ typedef cppu::ImplInheritanceHelper<::svt::OGenericUnoDialog,
OGenericUnoAsyncDialogBase;
/** abstract base class for implementing UNO objects representing asynchronous dialogs
+
+ Contrary to StartExecuteAsync in VclAbstractDialog from include/vcl/abstdlg.hxx,
+ the different methods are used in a special case when an import or export action
+ wants to show a dialog, as part of a synchronous filter() API call.
+
+ In this case it's not possible to move the "rest of the code" to an async
+ callback, so that needs special handling. Luckily these dialogs are rather rare.
*/
template <typename T> class OGenericUnoAsyncDialog : public OGenericUnoAsyncDialogBase
{