sfx2/source/sidebar/Deck.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/Deck.hxx>
  21 #include <sidebar/DeckDescriptor.hxx>
  22 #include <sidebar/DeckLayouter.hxx>
  23 #include <sidebar/DeckTitleBar.hxx>
  24 #include <sidebar/PanelTitleBar.hxx>
  25 #include <sfx2/sidebar/Panel.hxx>
  26 #include <sfx2/sidebar/SidebarDockingWindow.hxx>
  27 #include <sfx2/sidebar/Theme.hxx>
  28 #include <sfx2/viewsh.hxx>
  29
  30 #include <vcl/event.hxx>
  31 #include <comphelper/lok.hxx>
  32 #include <tools/json_writer.hxx>
  33
  34 using namespace css;
  35 using namespace css::uno;
  36
  37 namespace sfx2::sidebar {
  38
  39 Deck::Deck(const DeckDescriptor& rDeckDescriptor, SidebarDockingWindow* pParentWindow,
  40            const std::function<void()>& rCloserAction)
  41     : InterimItemWindow(pParentWindow, "sfx/ui/deck.ui", "Deck")
  42     , msId(rDeckDescriptor.msId)
  43     , mnMinimalWidth(0)
  44     , mnScrolledWindowExtraWidth(0)
  45     , mnMinimalHeight(0)
  46     , maPanels()
  47     , mxParentWindow(pParentWindow)
  48     , mxTitleBar(new DeckTitleBar(rDeckDescriptor.msTitle, *m_xBuilder, rCloserAction))
  49     , mxVerticalScrollBar(m_xBuilder->weld_scrolled_window("scrolledwindow"))
  50     , mxContents(m_xBuilder->weld_box("contents"))
  51 {
  52     SetStyle(GetStyle() | WB_DIALOGCONTROL);
  53
  54     m_xContainer->set_background(Theme::GetColor(Theme::Color_DeckBackground));
  55
  56     mxVerticalScrollBar->vadjustment_set_step_increment(10);
  57     mxVerticalScrollBar->vadjustment_set_page_increment(100);
  58
  59     // tdf#142458 Measure the preferred width of an empty ScrolledWindow
  60     // to add to the width of the union of panel widths when calculating
  61     // the minimal width of the deck
  62     mxVerticalScrollBar->set_hpolicy(VclPolicyType::NEVER);
  63     mxVerticalScrollBar->set_vpolicy(VclPolicyType::NEVER);
  64     mnScrolledWindowExtraWidth = mxVerticalScrollBar->get_preferred_size().Width();
  65     mxVerticalScrollBar->set_hpolicy(VclPolicyType::AUTOMATIC);
  66     mxVerticalScrollBar->set_vpolicy(VclPolicyType::AUTOMATIC);
  67 }
  68
  69 Deck::~Deck()
  70 {
  71     disposeOnce();
  72 }
  73
  74 void Deck::dispose()
  75 {
  76     SharedPanelContainer aPanels;
  77     aPanels.swap(maPanels);
  78
  79     // We have to explicitly trigger the destruction of panels.
  80     // Otherwise that is done by one of our base class destructors
  81     // without updating maPanels.
  82     for (auto& rpPanel : aPanels)
  83         rpPanel.reset();
  84
  85     maPanels.clear();
  86     mxTitleBar.reset();
  87     mxContents.reset();
  88     mxVerticalScrollBar.reset();
  89
  90     mxParentWindow.clear();
  91
  92     InterimItemWindow::dispose();
  93 }
  94
  95 DeckTitleBar* Deck::GetTitleBar() const
  96 {
  97     return mxTitleBar.get();
  98 }
  99
 100 tools::Rectangle Deck::GetContentArea() const
 101 {
 102     const Size aWindowSize (GetSizePixel());
 103     const int nBorderSize (Theme::GetInteger(Theme::Int_DeckBorderSize));
 104     if (aWindowSize.IsEmpty())
 105         return tools::Rectangle();
 106
 107     return tools::Rectangle(
 108         Theme::GetInteger(Theme::Int_DeckLeftPadding) + nBorderSize,
 109         Theme::GetInteger(Theme::Int_DeckTopPadding) + nBorderSize,
 110         aWindowSize.Width() - 1 - Theme::GetInteger(Theme::Int_DeckRightPadding) - nBorderSize,
 111         aWindowSize.Height() - 1 - Theme::GetInteger(Theme::Int_DeckBottomPadding) - nBorderSize);
 112 }
 113
 114 void Deck::DataChanged(const DataChangedEvent&)
 115 {
 116     for (auto& rpPanel : maPanels)
 117         rpPanel->DataChanged();
 118
 119     RequestLayoutInternal();
 120 }
 121
 122 /*
 123  * Get the ordering as is shown in the layout, and our type as 'deck'
 124  * also elide nested panel windows.
 125  */
 126 void Deck::DumpAsPropertyTree(tools::JsonWriter& rJsonWriter)
 127 {
 128     rJsonWriter.put("id", get_id().isEmpty() ? msId : get_id());
 129     rJsonWriter.put("type", "deck");
 130     rJsonWriter.put("text", GetText());
 131     rJsonWriter.put("enabled", IsEnabled());
 132     if (!IsVisible())
 133         rJsonWriter.put("visible", false);
 134
 135     auto childrenNode = rJsonWriter.startArray("children");
 136     for (const auto &it : maPanels)
 137     {
 138         // collapse the panel itself out
 139         auto xContent = it->GetContents();
 140         if (!xContent)
 141             continue;
 142
 143         auto childNode = rJsonWriter.startStruct();
 144         rJsonWriter.put("id", it->GetId());
 145         rJsonWriter.put("type", "panel");
 146         rJsonWriter.put("text", it->GetTitle());
 147         rJsonWriter.put("enabled", true);
 148         rJsonWriter.put("hidden", it->IsLurking());
 149         rJsonWriter.put("expanded", it->IsExpanded());
 150
 151         if (it->GetTitleBar() && !it->GetTitleBar()->GetMoreOptionsCommand().isEmpty())
 152             rJsonWriter.put("command", it->GetTitleBar()->GetMoreOptionsCommand());
 153
 154         {
 155             auto children2Node = rJsonWriter.startArray("children");
 156             {
 157                 auto child2Node = rJsonWriter.startStruct();
 158                 xContent->get_property_tree(rJsonWriter);
 159             }
 160         }
 161     }
 162 }
 163
 164 /**
 165  * This container may contain existing panels that are
 166  * being re-used, and new ones too.
 167  */
 168 void Deck::ResetPanels(SharedPanelContainer&& rPanelContainer)
 169 {
 170     SharedPanelContainer aHiddens;
 171
 172     // First hide old panels we don't need just now.
 173     for (auto& rpPanel : maPanels)
 174     {
 175         bool bFound = false;
 176         for (const auto & i : rPanelContainer)
 177             bFound = bFound || (rpPanel.get() == i.get());
 178         if (!bFound) // this one didn't survive.
 179         {
 180             rpPanel->SetLurkMode(true);
 181             aHiddens.push_back(rpPanel);
 182         }
 183     }
 184     maPanels = std::move(rPanelContainer);
 185
 186     // Hidden ones always at the end
 187     maPanels.insert(std::end(maPanels), std::begin(aHiddens), std::end(aHiddens));
 188
 189     RequestLayoutInternal();
 190 }
 191
 192 void Deck::RequestLayoutInternal()
 193 {
 194     mnMinimalWidth = 0;
 195     mnMinimalHeight = 0;
 196
 197     DeckLayouter::LayoutDeck(mxParentWindow.get(), GetContentArea(),
 198                              mnMinimalWidth, mnMinimalHeight, maPanels,
 199                              *GetTitleBar(), *mxVerticalScrollBar);
 200
 201     if (mnMinimalWidth)
 202     {
 203         // tdf#142458 at this point mnMinimalWidth contains the width required
 204         // by the panels, but extra space may be needed by the scrolledwindow
 205         // that will contain the panels
 206         mnMinimalWidth += mnScrolledWindowExtraWidth;
 207     }
 208 }
 209
 210 void Deck::RequestLayout()
 211 {
 212     RequestLayoutInternal();
 213
 214     if (!comphelper::LibreOfficeKit::isActive())
 215         return;
 216
 217     bool bChangeNeeded = false;
 218     Size aParentSize = mxParentWindow->GetSizePixel();
 219
 220     if (mnMinimalHeight > 0 && (mnMinimalHeight != aParentSize.Height() || GetSizePixel().Height() != mnMinimalHeight))
 221     {
 222         aParentSize.setHeight(mnMinimalHeight);
 223         bChangeNeeded = true;
 224     }
 225     const SfxViewShell* pViewShell = SfxViewShell::Current();
 226     if (mnMinimalWidth > 0 && (mnMinimalWidth != aParentSize.Width() || GetSizePixel().Width() != mnMinimalWidth)
 227             && pViewShell && pViewShell->isLOKMobilePhone())
 228     {
 229         aParentSize.setWidth(mnMinimalWidth);
 230         bChangeNeeded = true;
 231     }
 232
 233     if (bChangeNeeded)
 234     {
 235         mxParentWindow->SetSizePixel(aParentSize);
 236         setPosSizePixel(0, 0, aParentSize.Width(), aParentSize.Height());
 237     }
 238     else if (aParentSize != GetSizePixel()) //Sync parent & child sizes
 239         setPosSizePixel(0, 0, aParentSize.Width(), aParentSize.Height());
 240 }
 241
 242 weld::Widget* Deck::GetPanelParentWindow()
 243 {
 244     return mxContents.get();
 245 }
 246
 247 std::shared_ptr<Panel> Deck::GetPanel(std::u16string_view panelId)
 248 {
 249     for (const auto& pPanel : maPanels)
 250     {
 251         if(pPanel->GetId() == panelId)
 252         {
 253             return pPanel;
 254         }
 255     }
 256     return nullptr;
 257
 258 }
 259
 260 void Deck::ShowPanel(const Panel& rPanel)
 261 {
 262     if (!mxVerticalScrollBar || mxVerticalScrollBar->get_vpolicy() == VclPolicyType::NEVER)
 263         return;
 264
 265     // Get vertical extent of the panel.
 266     tools::Rectangle aExtents;
 267     if (!rPanel.get_extents(aExtents))
 268         return;
 269
 270     auto nPanelTop = aExtents.Top();
 271     auto nPanelBottom = aExtents.Bottom() - 1;
 272
 273     // Determine what the new thumb position should be like.
 274     // When the whole panel does not fit then make its top visible
 275     // and it off at the bottom.
 276     sal_Int32 nNewThumbPos(mxVerticalScrollBar->vadjustment_get_value());
 277     if (nPanelBottom >= nNewThumbPos + mxVerticalScrollBar->vadjustment_get_page_size())
 278         nNewThumbPos = nPanelBottom - mxVerticalScrollBar->vadjustment_get_page_size();
 279     if (nPanelTop < nNewThumbPos)
 280         nNewThumbPos = nPanelTop;
 281
 282     mxVerticalScrollBar->vadjustment_set_value(nNewThumbPos);
 283 }
 284
 285 } // end of namespace sfx2::sidebar
 286
 287 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */