sfx2/source/dialog/basedlgs.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 <vcl/help.hxx>
  21 #include <svl/eitem.hxx>
  22 #include <unotools/viewoptions.hxx>
  23 #include <vcl/idle.hxx>
  24
  25 #include <sfx2/basedlgs.hxx>
  26 #include <sfx2/tabdlg.hxx>
  27 #include <sfx2/bindings.hxx>
  28 #include <sfx2/dispatch.hxx>
  29 #include <sfx2/childwin.hxx>
  30 #include <sfx2/viewsh.hxx>
  31 #include <workwin.hxx>
  32 #include <comphelper/lok.hxx>
  33
  34 using namespace ::com::sun::star::uno;
  35
  36 constexpr OUStringLiteral USERITEM_NAME = u"UserItem";
  37
  38 class SfxModelessDialog_Impl : public SfxListener
  39 {
  40 public:
  41     OUString aWinState;
  42     SfxChildWindow* pMgr;
  43     bool            bClosing;
  44     void            Notify( SfxBroadcaster& rBC, const SfxHint& rHint ) override;
  45
  46     Idle            aMoveIdle { "SfxModelessDialog_Impl aMoveIdle" };
  47 };
  48
  49 void SfxModelessDialog_Impl::Notify( SfxBroadcaster&, const SfxHint& rHint )
  50 {
  51     if (pMgr && rHint.GetId() == SfxHintId::Dying) {
  52         pMgr->Destroy();
  53     }
  54 }
  55
  56 void SfxModelessDialogController::Initialize(SfxChildWinInfo const *pInfo)
  57
  58 /*  [Description]
  59
  60     Initialization of the class SfxModelessDialog via a SfxChildWinInfo.
  61     The initialization is done only in a 2nd step after the constructor, this
  62     constructor should be called from the derived class or from the
  63     SfxChildWindows.
  64 */
  65
  66 {
  67     if (!pInfo)
  68         return;
  69     m_xImpl->aWinState = pInfo->aWinState;
  70     if (m_xImpl->aWinState.isEmpty())
  71         return;
  72     m_xDialog->set_window_state(m_xImpl->aWinState);
  73 }
  74
  75 SfxModelessDialogController::SfxModelessDialogController(SfxBindings* pBindinx,
  76     SfxChildWindow *pCW, weld::Window *pParent, const OUString& rUIXMLDescription,
  77     const OUString& rID)
  78     : SfxDialogController(pParent, rUIXMLDescription, rID)
  79 {
  80     Init(pBindinx, pCW);
  81 }
  82
  83 /*  [Description]
  84
  85     Fills a SfxChildWinInfo with specific data from SfxModelessDialog,
  86     so that it can be written in the INI file. It is assumed that rinfo
  87     receives all other possible relevant data in the ChildWindow class.
  88     ModelessDialogs have no specific information, so that the base
  89     implementation does nothing and therefore must not be called.
  90 */
  91 void SfxModelessDialogController::FillInfo(SfxChildWinInfo& rInfo) const
  92 {
  93     rInfo.aSize = m_xDialog->get_size();
  94 }
  95
  96 void SfxModelessDialogController::Init(SfxBindings *pBindinx, SfxChildWindow *pCW)
  97 {
  98     m_pBindings = pBindinx;
  99     m_xImpl.reset(new SfxModelessDialog_Impl);
 100     m_xImpl->pMgr = pCW;
 101     m_xImpl->bClosing = false;
 102     if (pBindinx)
 103         m_xImpl->StartListening( *pBindinx );
 104 }
 105
 106 /*  [Description]
 107
 108     If a ModelessDialog is enabled its ViewFrame will be activated.
 109     This is necessary by PluginInFrames.
 110 */
 111 IMPL_LINK_NOARG(SfxDialogController, FocusChangeHdl, weld::Container&, void)
 112 {
 113     if (m_xDialog->has_toplevel_focus())
 114         Activate();
 115     else
 116         Deactivate();
 117 }
 118
 119 void SfxModelessDialogController::Activate()
 120 {
 121     if (!m_xImpl || !m_xImpl->pMgr)
 122         return;
 123     m_pBindings->SetActiveFrame(m_xImpl->pMgr->GetFrame());
 124     m_xImpl->pMgr->Activate_Impl();
 125 }
 126
 127 void SfxModelessDialogController::Deactivate()
 128 {
 129     if (!m_xImpl)
 130         return;
 131     m_pBindings->SetActiveFrame(css::uno::Reference< css::frame::XFrame>());
 132 }
 133
 134 SfxModelessDialogController::~SfxModelessDialogController()
 135 {
 136     if (!m_xImpl->pMgr)
 137         return;
 138     auto xFrame = m_xImpl->pMgr->GetFrame();
 139     if (!xFrame)
 140         return;
 141     if (xFrame == m_pBindings->GetActiveFrame())
 142         m_pBindings->SetActiveFrame(nullptr);
 143 }
 144
 145 void SfxDialogController::EndDialog(int nResponse)
 146 {
 147     if (!m_xDialog->get_visible())
 148         return;
 149     response(nResponse);
 150 }
 151
 152 bool SfxModelessDialogController::IsClosing() const
 153 {
 154     return m_xImpl->bClosing;
 155 }
 156
 157 void SfxModelessDialogController::EndDialog(int nResponse)
 158 {
 159     if (m_xImpl->bClosing)
 160         return;
 161     // In the case of async dialogs, the call to SfxDialogController::EndDialog
 162     // may delete this object, so keep myself alive for the duration of this
 163     // stack frame.
 164     auto aHoldSelf = shared_from_this();
 165     m_xImpl->bClosing = true;
 166     SfxDialogController::EndDialog(nResponse);
 167     if (!m_xImpl)
 168         return;
 169     m_xImpl->bClosing = false;
 170 }
 171
 172 void SfxModelessDialogController::ChildWinDispose()
 173 {
 174     if (m_xImpl->pMgr)
 175     {
 176         vcl::WindowDataMask nMask = vcl::WindowDataMask::Pos | vcl::WindowDataMask::State;
 177         if (m_xDialog->get_resizable())
 178             nMask |= vcl::WindowDataMask::Size;
 179         m_xImpl->aWinState = m_xDialog->get_window_state(nMask);
 180         GetBindings().GetWorkWindow_Impl()->ConfigChild_Impl( SfxChildIdentifier::DOCKINGWINDOW, SfxDockingConfig::ALIGNDOCKINGWINDOW, m_xImpl->pMgr->GetType() );
 181     }
 182
 183     m_xImpl->pMgr = nullptr;
 184 }
 185
 186 /*  [Description]
 187
 188     The window is closed when the ChildWindow is destroyed by running the
 189     ChildWindow-slots.
 190 */
 191 void SfxModelessDialogController::Close()
 192 {
 193     if (m_xImpl->bClosing)
 194         return;
 195     // Execute with Parameters, since Toggle is ignored by some ChildWindows.
 196     SfxBoolItem aValue(m_xImpl->pMgr->GetType(), false);
 197     m_pBindings->GetDispatcher_Impl()->ExecuteList(
 198         m_xImpl->pMgr->GetType(),
 199         SfxCallMode::RECORD|SfxCallMode::SYNCHRON, { &aValue } );
 200     SfxDialogController::Close();
 201 }
 202
 203 SfxDialogController::SfxDialogController(weld::Widget* pParent, const OUString& rUIFile,
 204                                          const OUString& rDialogId)
 205     : GenericDialogController(pParent, rUIFile, rDialogId,
 206                                     comphelper::LibreOfficeKit::isActive()
 207                                     && SfxViewShell::Current()
 208                                     && SfxViewShell::Current()->isLOKMobilePhone())
 209 {
 210     m_xDialog->SetInstallLOKNotifierHdl(LINK(this, SfxDialogController, InstallLOKNotifierHdl));
 211     m_xDialog->connect_container_focus_changed(LINK(this, SfxDialogController, FocusChangeHdl));
 212 }
 213
 214 void SfxDialogController::Close()
 215 {
 216     // tdf3146571 ignore focus changes after we've closed
 217     m_xDialog->connect_container_focus_changed(Link<weld::Container&, void>());
 218 }
 219
 220 IMPL_STATIC_LINK_NOARG(SfxDialogController, InstallLOKNotifierHdl, void*, vcl::ILibreOfficeKitNotifier*)
 221 {
 222     return SfxViewShell::Current();
 223 }
 224
 225 SfxSingleTabDialogController::SfxSingleTabDialogController(weld::Widget *pParent, const SfxItemSet* pSet,
 226     const OUString& rUIXMLDescription, const OUString& rID)
 227     : SfxOkDialogController(pParent, rUIXMLDescription, rID)
 228     , m_pInputSet(pSet)
 229     , m_xContainer(m_xDialog->weld_content_area())
 230     , m_xOKBtn(m_xBuilder->weld_button("ok"))
 231     , m_xHelpBtn(m_xBuilder->weld_button("help"))
 232 {
 233     m_xOKBtn->connect_clicked(LINK(this, SfxSingleTabDialogController, OKHdl_Impl));
 234 }
 235
 236 SfxSingleTabDialogController::SfxSingleTabDialogController(weld::Widget *pParent, const SfxItemSet* pSet,
 237     const OUString& rContainerId, const OUString& rUIXMLDescription, const OUString& rID)
 238     : SfxOkDialogController(pParent, rUIXMLDescription, rID)
 239     , m_pInputSet(pSet)
 240     , m_xContainer(m_xBuilder->weld_container(rContainerId))
 241     , m_xOKBtn(m_xBuilder->weld_button("ok"))
 242     , m_xHelpBtn(m_xBuilder->weld_button("help"))
 243 {
 244     m_xOKBtn->connect_clicked(LINK(this, SfxSingleTabDialogController, OKHdl_Impl));
 245 }
 246
 247 SfxSingleTabDialogController::~SfxSingleTabDialogController()
 248 {
 249 }
 250
 251 /*  [Description]
 252
 253     Insert a (new) TabPage; an existing page is deleted.
 254     The passed on page is initialized with the initially given Itemset
 255     through calling Reset().
 256 */
 257 void SfxSingleTabDialogController::SetTabPage(std::unique_ptr<SfxTabPage> xTabPage)
 258 {
 259     m_xSfxPage = std::move(xTabPage);
 260     if (!m_xSfxPage)
 261         return;
 262
 263     // First obtain the user data, only then Reset()
 264     OUString sConfigId = m_xSfxPage->GetConfigId();
 265     SvtViewOptions aPageOpt(EViewType::TabPage, sConfigId);
 266     Any aUserItem = aPageOpt.GetUserItem( USERITEM_NAME );
 267     OUString sUserData;
 268     aUserItem >>= sUserData;
 269     m_xSfxPage->SetUserData(sUserData);
 270     m_xSfxPage->Reset(GetInputItemSet());
 271
 272     m_xHelpBtn->set_visible(Help::IsContextHelpEnabled());
 273
 274     // Set TabPage text in the Dialog if there is any
 275     OUString sTitle(m_xSfxPage->GetPageTitle());
 276     if (!sTitle.isEmpty())
 277         m_xDialog->set_title(sTitle);
 278
 279     // Dialog receives the HelpId of TabPage if there is any
 280     OUString sHelpId(m_xSfxPage->GetHelpId());
 281     if (!sHelpId.isEmpty())
 282         m_xDialog->set_help_id(sHelpId);
 283 }
 284
 285 /*  [Description]
 286
 287     Ok_Handler; FillItemSet() is called for setting of Page.
 288 */
 289 IMPL_LINK_NOARG(SfxSingleTabDialogController, OKHdl_Impl, weld::Button&, void)
 290 {
 291     const SfxItemSet* pInputSet = GetInputItemSet();
 292     if (!pInputSet)
 293     {
 294         // TabPage without ItemSet
 295         m_xDialog->response(RET_OK);
 296         return;
 297     }
 298
 299     if (!GetOutputItemSet())
 300     {
 301         CreateOutputItemSet(*pInputSet);
 302     }
 303
 304     bool bModified = false;
 305
 306     if (m_xSfxPage->HasExchangeSupport())
 307     {
 308         DeactivateRC nRet = m_xSfxPage->DeactivatePage(m_xOutputSet.get());
 309         if (nRet != DeactivateRC::LeavePage)
 310             return;
 311         else
 312             bModified = m_xOutputSet->Count() > 0;
 313     }
 314     else
 315         bModified = m_xSfxPage->FillItemSet(m_xOutputSet.get());
 316
 317     if (bModified)
 318     {
 319         // Save user data in IniManager.
 320         m_xSfxPage->FillUserData();
 321         OUString sData(m_xSfxPage->GetUserData());
 322
 323         OUString sConfigId = m_xSfxPage->GetConfigId();
 324         SvtViewOptions aPageOpt(EViewType::TabPage, sConfigId);
 325         aPageOpt.SetUserItem( USERITEM_NAME, Any( sData ) );
 326         m_xDialog->response(RET_OK);
 327     }
 328     else
 329         m_xDialog->response(RET_CANCEL);
 330 }
 331
 332 void SfxSingleTabDialogController::CreateOutputItemSet(const SfxItemSet& rSet)
 333 {
 334     assert(!m_xOutputSet && "Double creation of OutputSet!");
 335     m_xOutputSet.reset(new SfxItemSet(rSet));
 336     m_xOutputSet->ClearItem();
 337 }
 338
 339 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */