include/framework/sfxhelperfunctions.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 #pragma once
  21
  22 #include <framework/fwkdllapi.h>
  23 #include <rtl/ustring.hxx>
  24 #include <rtl/ref.hxx>
  25 #include <vcl/toolboxid.hxx>
  26
  27 namespace com::sun::star::frame { class XFrame; }
  28 namespace com::sun::star::uno { template <typename > class Reference; }
  29 namespace svt { class StatusbarController; }
  30 namespace svt { class ToolboxController; }
  31
  32 class StatusBar;
  33 class ToolBox;
  34
  35 typedef rtl::Reference<svt::ToolboxController> ( *pfunc_setToolBoxControllerCreator)(
  36     const css::uno::Reference< css::frame::XFrame >& rFrame,
  37     ToolBox* pToolbox,
  38     ToolBoxItemId nID,
  39     const OUString& aCommandURL );
  40
  41 typedef rtl::Reference<svt::StatusbarController> ( *pfunc_setStatusBarControllerCreator)(
  42     const css::uno::Reference< css::frame::XFrame >& rFrame,
  43     StatusBar* pStatusBar,
  44     unsigned short nID,
  45     const OUString& aCommandURL );
  46
  47 typedef void ( *pfunc_getRefreshToolbars)(
  48     css::uno::Reference< css::frame::XFrame > const & rFrame );
  49
  50 typedef void ( *pfunc_createDockingWindow)(
  51     const css::uno::Reference< css::frame::XFrame >& rFrame,
  52     std::u16string_view rResourceURL );
  53
  54 typedef bool ( *pfunc_isDockingWindowVisible)(
  55     const css::uno::Reference< css::frame::XFrame >& rFrame,
  56     std::u16string_view rResourceURL );
  57
  58
  59 namespace framework
  60 {
  61 FWK_DLLPUBLIC pfunc_setToolBoxControllerCreator SetToolBoxControllerCreator( pfunc_setToolBoxControllerCreator pSetToolBoxControllerCreator );
  62 FWK_DLLPUBLIC rtl::Reference<svt::ToolboxController> CreateToolBoxController(
  63     const css::uno::Reference< css::frame::XFrame >& rFrame,
  64     ToolBox* pToolbox,
  65     ToolBoxItemId nID,
  66     const OUString& aCommandURL );
  67
  68 FWK_DLLPUBLIC pfunc_setStatusBarControllerCreator SetStatusBarControllerCreator( pfunc_setStatusBarControllerCreator pSetStatusBarControllerCreator );
  69 FWK_DLLPUBLIC rtl::Reference<svt::StatusbarController> CreateStatusBarController(
  70     const css::uno::Reference< css::frame::XFrame >& rFrame,
  71     StatusBar* pStatusBar,
  72     unsigned short nID,
  73      const OUString& aCommandURL );
  74
  75 FWK_DLLPUBLIC pfunc_getRefreshToolbars SetRefreshToolbars( pfunc_getRefreshToolbars pRefreshToolbarsFunc );
  76 FWK_DLLPUBLIC void RefreshToolbars(
  77      css::uno::Reference< css::frame::XFrame > const & rFrame );
  78
  79 FWK_DLLPUBLIC pfunc_createDockingWindow SetDockingWindowCreator( pfunc_createDockingWindow pCreateDockingWindow );
  80 FWK_DLLPUBLIC void CreateDockingWindow(
  81     const css::uno::Reference< css::frame::XFrame >& rFrame,
  82     std::u16string_view rResourceURL );
  83
  84 FWK_DLLPUBLIC pfunc_isDockingWindowVisible SetIsDockingWindowVisible( pfunc_isDockingWindowVisible pIsDockingWindowVisible );
  85 FWK_DLLPUBLIC bool IsDockingWindowVisible(
  86     const css::uno::Reference< css::frame::XFrame >& rFrame,
  87     std::u16string_view rResourceURL );
  88 }
  89
  90 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */