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 #ifndef INCLUDED_SFX2_SIDEBAR_SIDEBAR_HXX
  21 #define INCLUDED_SFX2_SIDEBAR_SIDEBAR_HXX
  22
  23 #include <sfx2/dllapi.h>
  24 #include <com/sun/star/frame/XFrame.hpp>
  25
  26 namespace cssu = ::com::sun::star::uno;
  27
  28
  29 namespace sfx2 { namespace sidebar {
  30
  31 /** Accept requests for switching to certain panels or decks.
  32 */
  33 class SFX2_DLLPUBLIC Sidebar
  34 {
  35 public:
  36     /** Switch to the deck that contains the specified panel and make
  37         sure that the panel is visible (expanded and scrolled into the
  38         visible area.)
  39         Note that most of the work is done asynchronously and that
  40         this function probably returns before the requested panel is visible.
  41     */
  42     static void ShowPanel (
  43         const ::rtl::OUString& rsPanelId,
  44         const cssu::Reference<css::frame::XFrame>& rxFrame);
  45 };
  46
  47 } } // end of namespace sfx2::sidebar
  48
  49 #endif
  50
  51 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */