sfx2/source/sidebar/Panel.cxx

   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 #include <sfx2/sidebar/Panel.hxx>
  21 #include <sidebar/PanelTitleBar.hxx>
  22 #include <sidebar/PanelDescriptor.hxx>
  23 #include <sfx2/sidebar/ResourceManager.hxx>
  24 #include <sfx2/sidebar/SidebarController.hxx>
  25 #include <sfx2/sidebar/SidebarPanelBase.hxx>
  26 #include <sfx2/viewsh.hxx>
  27 #include <tools/json_writer.hxx>
  28
  29
  30 #if OSL_DEBUG_LEVEL >= 2
  31 #include <sidebar/Tools.hxx>
  32 #include <sfx2/sidebar/Deck.hxx>
  33 #endif
  34
  35 #include <com/sun/star/ui/XToolPanel.hpp>
  36 #include <com/sun/star/ui/XSidebarPanel.hpp>
  37 #include <com/sun/star/ui/XUIElement.hpp>
  38
  39 #include <utility>
  40 #include <vcl/weldutils.hxx>
  41
  42 using namespace css;
  43 using namespace css::uno;
  44
  45 namespace sfx2::sidebar {
  46
  47 Panel::Panel(const PanelDescriptor& rPanelDescriptor,
  48              weld::Widget* pParentWindow,
  49              const bool bIsInitiallyExpanded,
  50              Deck* pDeck,
  51              std::function<Context()> aContextAccess,
  52              const css::uno::Reference<css::frame::XFrame>& rxFrame)
  53     : mxBuilder(Application::CreateBuilder(pParentWindow, u"sfx/ui/panel.ui"_ustr, false, reinterpret_cast<sal_uInt64>(SfxViewShell::Current())))
  54     , msPanelId(rPanelDescriptor.msId)
  55     , msTitle(rPanelDescriptor.msTitle)
  56     , mbIsTitleBarOptional(rPanelDescriptor.mbIsTitleBarOptional)
  57     , mbWantsAWT(rPanelDescriptor.mbWantsAWT)
  58     , mbIsExpanded(bIsInitiallyExpanded)
  59     , mbLurking(false)
  60     , maContextAccess(std::move(aContextAccess))
  61     , mxFrame(rxFrame)
  62     , mpParentWindow(pParentWindow)
  63     , mxDeck(pDeck)
  64     , mxContainer(mxBuilder->weld_box(u"Panel"_ustr))
  65     , mxTitleBar(new PanelTitleBar(rPanelDescriptor.msTitle, *mxBuilder, this))
  66     , mxContents(mxBuilder->weld_box(u"contents"_ustr))
  67 {
  68     mxContents->set_visible(mbIsExpanded);
  69     mxContainer->connect_get_property_tree(LINK(this, Panel, DumpAsPropertyTreeHdl));
  70 }
  71
  72 bool Panel::get_extents(tools::Rectangle &rExtents) const
  73 {
  74     // Get vertical extent of the panel.
  75     int x, y, width, height;
  76     if (mxContainer->get_extents_relative_to(*mpParentWindow, x, y, width, height))
  77     {
  78         rExtents = tools::Rectangle(Point(x, y), Size(width, height));
  79         return true;
  80     }
  81     return false;
  82 }
  83
  84 void Panel::SetHeightPixel(int nHeight)
  85 {
  86     mxContainer->set_size_request(-1, nHeight);
  87 }
  88
  89 void Panel::set_margin_top(int nMargin)
  90 {
  91     mxContainer->set_margin_top(nMargin);
  92 }
  93
  94 void Panel::set_margin_bottom(int nMargin)
  95 {
  96     mxContainer->set_margin_bottom(nMargin);
  97 }
  98
  99 void Panel::set_vexpand(bool bExpand)
 100 {
 101     mxContainer->set_vexpand(bExpand);
 102 }
 103
 104 void Panel::SetLurkMode(bool bLurk)
 105 {
 106     // cf. DeckLayouter
 107     mbLurking = bLurk;
 108 }
 109
 110 IMPL_LINK(Panel, DumpAsPropertyTreeHdl, tools::JsonWriter&, rJsonWriter, void)
 111 {
 112     if (!IsLurking())
 113         rJsonWriter.put("type", "panel");
 114 }
 115
 116 Panel::~Panel()
 117 {
 118     mxPanelComponent = nullptr;
 119
 120     {
 121         Reference<lang::XComponent> xComponent (mxElement, UNO_QUERY);
 122         mxElement = nullptr;
 123         if (xComponent.is())
 124             xComponent->dispose();
 125     }
 126
 127     {
 128         Reference<lang::XComponent> xComponent = GetElementWindow();
 129         if (xComponent.is())
 130             xComponent->dispose();
 131     }
 132
 133     mxTitleBar.reset();
 134
 135     if (mxXWindow)
 136     {
 137         mxXWindow->dispose();
 138         mxXWindow.clear();
 139     }
 140     mxContents.reset();
 141
 142     assert(!mxTitleBar);
 143 }
 144
 145 PanelTitleBar* Panel::GetTitleBar() const
 146 {
 147     return mxTitleBar.get();
 148 }
 149
 150 weld::Box* Panel::GetContents() const
 151 {
 152     return mxContents.get();
 153 }
 154
 155 void Panel::Show(bool bShow)
 156 {
 157     mxContainer->set_visible(bShow);
 158 }
 159
 160 void Panel::SetUIElement (const Reference<ui::XUIElement>& rxElement)
 161 {
 162     mxElement = rxElement;
 163     if (!mxElement.is())
 164         return;
 165     mxPanelComponent.set(mxElement->getRealInterface(), UNO_QUERY);
 166     if (mbWantsAWT)
 167         return;
 168     sfx2::sidebar::SidebarPanelBase* pPanelBase = dynamic_cast<sfx2::sidebar::SidebarPanelBase*>(mxElement.get());
 169     assert(pPanelBase && "internal panels are all expected to inherit from SidebarPanelBase");
 170     pPanelBase->SetParentPanel(this);
 171 }
 172
 173 void Panel::TriggerDeckLayouting()
 174 {
 175     mxDeck->RequestLayout();
 176 }
 177
 178 weld::Window* Panel::GetFrameWeld()
 179 {
 180     return mxDeck->GetFrameWeld();
 181 }
 182
 183 void Panel::SetExpanded (const bool bIsExpanded)
 184 {
 185     SidebarController* pSidebarController = SidebarController::GetSidebarControllerForFrame(mxFrame);
 186
 187     if (mbIsExpanded == bIsExpanded)
 188         return;
 189
 190     mbIsExpanded = bIsExpanded;
 191     mxTitleBar->UpdateExpandedState();
 192     TriggerDeckLayouting();
 193
 194     if (maContextAccess && pSidebarController)
 195     {
 196         pSidebarController->GetResourceManager()->StorePanelExpansionState(
 197             msPanelId,
 198             bIsExpanded,
 199             maContextAccess());
 200     }
 201
 202     mxContents->set_visible(mbIsExpanded);
 203 }
 204
 205 bool Panel::HasIdPredicate (std::u16string_view rsId) const
 206 {
 207     return msPanelId == rsId;
 208 }
 209
 210 void Panel::DataChanged()
 211 {
 212     mxTitleBar->DataChanged();
 213 }
 214
 215 Reference<awt::XWindow> Panel::GetElementWindow()
 216 {
 217     if (mxElement.is())
 218     {
 219         Reference<ui::XToolPanel> xToolPanel(mxElement->getRealInterface(), UNO_QUERY);
 220         if (xToolPanel.is())
 221             return xToolPanel->getWindow();
 222     }
 223
 224     return nullptr;
 225 }
 226
 227 const Reference<awt::XWindow>& Panel::GetElementParentWindow()
 228 {
 229     if (!mxXWindow)
 230     {
 231         if (mbWantsAWT)
 232             mxXWindow = mxContents->CreateChildFrame();
 233         else
 234             mxXWindow = Reference<awt::XWindow>(new weld::TransportAsXWindow(mxContents.get()));
 235     }
 236     return mxXWindow;
 237 }
 238
 239 } // end of namespace sfx2::sidebar
 240
 241 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */