sfx2/source/sidebar/Sidebar.hxx

   1 /*
   2  * This file is part of the LibreOffice project.
   3  *
   4  * This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this
   6  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   7  *
   8  * This file incorporates work covered by the following license notice:
   9  *
  10  *   Licensed to the Apache Software Foundation (ASF) under one or more
  11  *   contributor license agreements. See the NOTICE file distributed
  12  *   with this work for additional information regarding copyright
  13  *   ownership. The ASF licenses this file to you under the Apache
  14  *   License, Version 2.0 (the "License"); you may not use this file
  15  *   except in compliance with the License. You may obtain a copy of
  16  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  17  */
  18 #ifndef SFX_SIDEBAR_HXX
  19 #define SFX_SIDEBAR_HXX
  20
  21 #include "sfx2/dllapi.h"
  22 #include <vcl/window.hxx>
  23 #include <com/sun/star/frame/XFrame.hpp>
  24
  25
  26 namespace css = ::com::sun::star;
  27 namespace cssu = ::com::sun::star::uno;
  28
  29 namespace sfx2 { namespace sidebar {
  30
  31
  32 /** SFX-less version of a module dependent task pane, filled with tool panels as specified in the respective
  33     module's configuration
  34 */
  35 class SFX2_DLLPUBLIC Sidebar
  36     : public Window
  37 {
  38 public:
  39         /** creates a new instance
  40             @param i_rParentWindow
  41                 the parent window
  42             @param i_rDocumentFrame
  43                 the frame to which the task pane belongs. Will be passed to any custom tool panels created
  44                 via an XUIElementFactory. Also, it is used to determine the module which the task pane is
  45                 responsible for, thus controlling which tool panels are actually available.
  46         */
  47     Sidebar(
  48         Window& rParentWindow,
  49         const cssu::Reference<css::frame::XFrame>& rxDocumentFrame);
  50
  51
  52     virtual ~Sidebar (void);
  53
  54 protected:
  55     virtual void Resize (void);
  56     virtual void GetFocus (void);
  57
  58 private:
  59 };
  60
  61
  62 } } // end of namespace sfx2::sidebar
  63
  64 #endif