include/sfx2/sidebar/Sidebar.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 <sfx2/dllapi.h>
  23 #include <sfx2/viewfrm.hxx>
  24 #include <rtl/ustring.hxx>
  25
  26 namespace com::sun::star::frame { class XFrame; }
  27 namespace com::sun::star::uno { template <typename > class Reference; }
  28
  29
  30 namespace sfx2::sidebar {
  31
  32 /** Accept requests for switching to certain panels or decks.
  33 */
  34 class SFX2_DLLPUBLIC Sidebar
  35 {
  36 public:
  37     static void ToggleDeck(const OUString& rsDeckId, SfxViewFrame *pViewFrame);
  38
  39     /** Switch to the deck that contains the specified panel and make
  40         sure that the panel is visible (expanded and scrolled into the
  41         visible area.)
  42         Note that most of the work is done asynchronously and that
  43         this function probably returns before the requested panel is visible.
  44     */
  45     static void ShowPanel (
  46         const OUString& rsPanelId,
  47         const css::uno::Reference<css::frame::XFrame>& rxFrame, bool bFocus = false);
  48
  49     /** Switch to the deck that contains the specified panel and toggle
  50         the visibility of the panel (expanded and scrolled into the
  51         visible area when visible)
  52         Note that most of the work is done asynchronously and that
  53         this function probably returns before the requested panel is visible.
  54     */
  55     static void TogglePanel (
  56         const OUString& rsPanelId,
  57         const css::uno::Reference<css::frame::XFrame>& rxFrame);
  58
  59     static bool IsPanelVisible(
  60         const OUString& rsPanelId,
  61         const css::uno::Reference<css::frame::XFrame>& rxFrame);
  62 };
  63
  64 } // end of namespace sfx2::sidebar
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */