include/basic/vbahelper.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_BASIC_VBAHELPER_HXX
  21 #define INCLUDED_BASIC_VBAHELPER_HXX
  22
  23 #include <rtl/ustring.hxx>
  24 #include <basic/basicdllapi.h>
  25
  26 namespace com::sun::star::frame { class XModel; }
  27 namespace com::sun::star::uno { template <typename > class Reference; }
  28
  29 namespace basic::vba {
  30
  31 /*  This header contains public helper functions for VBA used from this module
  32     and from other VBA implementation modules such as vbahelper.
  33  */
  34
  35
  36 /** Locks or unlocks the controllers of all documents that have the same type
  37     as the specified document.
  38
  39     First, the global module manager (com.sun.star.frame.ModuleManager) is
  40     asked for the type of the passed model, and all open documents with the
  41     same type will be locked or unlocked.
  42
  43     @param rxModel
  44         A document model determining the type of the documents to be locked or
  45         unlocked.
  46
  47     @param bLockControllers
  48         Passing true will lock all controllers, passing false will unlock them.
  49  */
  50 BASIC_DLLPUBLIC void lockControllersOfAllDocuments(
  51     const css::uno::Reference< css::frame::XModel >& rxModel,
  52     bool bLockControllers );
  53
  54
  55 /** Enables or disables the container windows of all controllers of all
  56     documents that have the same type as the specified document.
  57
  58     First, the global module manager (com.sun.star.frame.ModuleManager) is
  59     asked for the type of the passed model, and the container windows of all
  60     open documents with the same type will be enabled or disabled.
  61
  62     @param rxModel
  63         A document model determining the type of the documents to be enabled or
  64         disabled.
  65
  66     @param bEnableWindows
  67         Passing true will enable all container windows of all controllers,
  68         passing false will disable them.
  69  */
  70 BASIC_DLLPUBLIC void enableContainerWindowsOfAllDocuments(
  71     const css::uno::Reference< css::frame::XModel >& rxModel,
  72     bool bEnableWindows );
  73
  74
  75 /** Registers the passed path as working directory for the application the
  76     passed document belongs to.
  77
  78     @param rxModel
  79         A document model determining the type of the application whose working
  80         directory has been changed.
  81
  82     @param rPath
  83         The new working directory.
  84  */
  85 BASIC_DLLPUBLIC void registerCurrentDirectory(
  86     const css::uno::Reference< css::frame::XModel >& rxModel,
  87     const OUString& rPath );
  88
  89
  90 } // namespace basic::vba
  91
  92 #endif
  93
  94 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */