1 files changed, 94 insertions, 0 deletions
diff --git a/include/basic/vbahelper.hxx b/include/basic/vbahelper.hxx
new file mode 100644
index 0000000000..8d18b66b1d
--- /dev/null
+++ b/include/basic/vbahelper.hxx
@@ -0,0 +1,94 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * 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/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ *   Licensed to the Apache Software Foundation (ASF) under one or more
+ *   contributor license agreements. See the NOTICE file distributed
+ *   with this work for additional information regarding copyright
+ *   ownership. The ASF licenses this file to you under the Apache
+ *   License, Version 2.0 (the "License"); you may not use this file
+ *   except in compliance with the License. You may obtain a copy of
+ *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#ifndef INCLUDED_BASIC_VBAHELPER_HXX
+#define INCLUDED_BASIC_VBAHELPER_HXX
+
+#include <rtl/ustring.hxx>
+#include <basic/basicdllapi.h>
+
+namespace com::sun::star::frame { class XModel; }
+namespace com::sun::star::uno { template <typename > class Reference; }
+
+namespace basic::vba {
+
+/*  This header contains public helper functions for VBA used from this module
+    and from other VBA implementation modules such as vbahelper.
+ */
+
+
+/** Locks or unlocks the controllers of all documents that have the same type
+    as the specified document.
+
+    First, the global module manager (com.sun.star.frame.ModuleManager) is
+    asked for the type of the passed model, and all open documents with the
+    same type will be locked or unlocked.
+
+    @param rxModel
+        A document model determining the type of the documents to be locked or
+        unlocked.
+
+    @param bLockControllers
+        Passing true will lock all controllers, passing false will unlock them.
+ */
+BASIC_DLLPUBLIC void lockControllersOfAllDocuments(
+    const css::uno::Reference< css::frame::XModel >& rxModel,
+    bool bLockControllers );
+
+
+/** Enables or disables the container windows of all controllers of all
+    documents that have the same type as the specified document.
+
+    First, the global module manager (com.sun.star.frame.ModuleManager) is
+    asked for the type of the passed model, and the container windows of all
+    open documents with the same type will be enabled or disabled.
+
+    @param rxModel
+        A document model determining the type of the documents to be enabled or
+        disabled.
+
+    @param bEnableWindows
+        Passing true will enable all container windows of all controllers,
+        passing false will disable them.
+ */
+BASIC_DLLPUBLIC void enableContainerWindowsOfAllDocuments(
+    const css::uno::Reference< css::frame::XModel >& rxModel,
+    bool bEnableWindows );
+
+
+/** Registers the passed path as working directory for the application the
+    passed document belongs to.
+
+    @param rxModel
+        A document model determining the type of the application whose working
+        directory has been changed.
+
+    @param rPath
+        The new working directory.
+ */
+BASIC_DLLPUBLIC void registerCurrentDirectory(
+    const css::uno::Reference< css::frame::XModel >& rxModel,
+    const OUString& rPath );
+
+
+} // namespace basic::vba
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */