tdf#153519 use new IdleTask::waitUntilIdleDispatched

to wait until the Idle inside sw/ has done populating the navigator
tree.

Which required
(*) moving the code down from test/ to vcl/ to avoid circular dependency
issues.
(*) adding a call SolarMutexGuard before Application::Yield inside
IdleTask::waitUntilIdleDispatched
(*) exposing the function to python by adding a method to the
XToolkitExperimental UNO API

Change-Id: Iee418f7a0beb1f5b53addb7fe25823d61720eb3a
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/158495
Tested-by: Jenkins
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>

1 files changed, 51 insertions, 0 deletions

diff --git a/vcl/source/helper/idletask.cxx b/vcl/source/helper/idletask.cxx
new file mode 100644
index 000000000000..7df0514912db
--- /dev/null
+++ b/vcl/source/helper/idletask.cxx
@@ -0,0 +1,51 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+#include <vcl/idletask.hxx>
+#include <vcl/svapp.hxx>
+
+//constructor of IdleTask Class
+IdleTask::IdleTask()
+    : flag(false)
+{
+    //setting the Priority of Idle task to LOW, LOWEST
+    maIdle.SetPriority(TaskPriority::LOWEST);
+    //set idle for callback
+    maIdle.SetInvokeHandler(LINK(this, IdleTask, FlipFlag));
+    //starting the idle
+    maIdle.Start();
+}
+
+//GetFlag() of IdleTask Class
+bool IdleTask::GetFlag() const
+{
+    //returning the status of current flag
+    return flag;
+}
+
+//Callback function of IdleTask Class
+IMPL_LINK(IdleTask, FlipFlag, Timer*, , void)
+{
+    //setting the flag to make sure that low priority idle task has been dispatched
+    flag = true;
+}
+
+void IdleTask::waitUntilIdleDispatched()
+{
+    //creating instance of IdleTask Class
+    IdleTask idleTask;
+    while (!idleTask.GetFlag())
+    {
+        //dispatching all the events via VCL main-loop
+        SolarMutexGuard aGuard;
+        Application::Yield();
+    }
+}
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */