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