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