1 /************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 #ifndef SFX_SIDEBAR_SIDEBAR_HXX 23 #define SFX_SIDEBAR_SIDEBAR_HXX 24 25 #include "sfx2/dllapi.h" 26 #include <com/sun/star/frame/XFrame.hpp> 27 28 namespace css = ::com::sun::star; 29 namespace cssu = ::com::sun::star::uno; 30 31 32 namespace sfx2 { namespace sidebar { 33 34 /** Accept requests for switching to certain panels or decks. 35 */ 36 class SFX2_DLLPUBLIC Sidebar 37 { 38 public: 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 ::rtl::OUString& rsPanelId, 47 const cssu::Reference<css::frame::XFrame>& rxFrame); 48 49 /** Switch to the specified deck. 50 Note that most of the work is done asynchronously and that 51 this function probably returns before the requested deck is visible. 52 */ 53 static void ShowDeck ( 54 const ::rtl::OUString& rsDeckId, 55 const cssu::Reference<css::frame::XFrame>& rxFrame); 56 }; 57 58 } } // end of namespace sfx2::sidebar 59 60 #endif 61