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     OString 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 OString& 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()
 146 {
 147     if (!m_xDialog->get_visible())
 148         return;
 149     response(RET_CLOSE);
 150 }
 151
 152 bool SfxModelessDialogController::IsClosing() const
 153 {
 154     return m_xImpl->bClosing;
 155 }
 156
 157 void SfxModelessDialogController::EndDialog()
 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();
 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         WindowStateMask nMask = WindowStateMask::Pos | WindowStateMask::State;
 177         if (m_xDialog->get_resizable())
 178             nMask |= WindowStateMask::Width | WindowStateMask::Height;
 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 OString& 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 OString& 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()
 237 {
 238 }
 239
 240 /*  [Description]
 241
 242     Insert a (new) TabPage; an existing page is deleted.
 243     The passed on page is initialized with the initially given Itemset
 244     through calling Reset().
 245 */
 246 void SfxSingleTabDialogController::SetTabPage(std::unique_ptr<SfxTabPage> xTabPage)
 247 {
 248     m_xSfxPage = std::move(xTabPage);
 249     if (!m_xSfxPage)
 250         return;
 251
 252     // First obtain the user data, only then Reset()
 253     OUString sConfigId = OStringToOUString(m_xSfxPage->GetConfigId(), RTL_TEXTENCODING_UTF8);
 254     SvtViewOptions aPageOpt(EViewType::TabPage, sConfigId);
 255     Any aUserItem = aPageOpt.GetUserItem( USERITEM_NAME );
 256     OUString sUserData;
 257     aUserItem >>= sUserData;
 258     m_xSfxPage->SetUserData(sUserData);
 259     m_xSfxPage->Reset(GetInputItemSet());
 260
 261     m_xHelpBtn->set_visible(Help::IsContextHelpEnabled());
 262
 263     // Set TabPage text in the Dialog if there is any
 264     OUString sTitle(m_xSfxPage->GetPageTitle());
 265     if (!sTitle.isEmpty())
 266         m_xDialog->set_title(sTitle);
 267
 268     // Dialog receives the HelpId of TabPage if there is any
 269     OString sHelpId(m_xSfxPage->GetHelpId());
 270     if (!sHelpId.isEmpty())
 271         m_xDialog->set_help_id(sHelpId);
 272 }
 273
 274 /*  [Description]
 275
 276     Ok_Handler; FillItemSet() is called for setting of Page.
 277 */
 278 IMPL_LINK_NOARG(SfxSingleTabDialogController, OKHdl_Impl, weld::Button&, void)
 279 {
 280     const SfxItemSet* pInputSet = GetInputItemSet();
 281     if (!pInputSet)
 282     {
 283         // TabPage without ItemSet
 284         m_xDialog->response(RET_OK);
 285         return;
 286     }
 287
 288     if (!GetOutputItemSet())
 289     {
 290         CreateOutputItemSet(*pInputSet);
 291     }
 292
 293     bool bModified = false;
 294
 295     if (m_xSfxPage->HasExchangeSupport())
 296     {
 297         DeactivateRC nRet = m_xSfxPage->DeactivatePage(m_xOutputSet.get());
 298         if (nRet != DeactivateRC::LeavePage)
 299             return;
 300         else
 301             bModified = m_xOutputSet->Count() > 0;
 302     }
 303     else
 304         bModified = m_xSfxPage->FillItemSet(m_xOutputSet.get());
 305
 306     if (bModified)
 307     {
 308         // Save user data in IniManager.
 309         m_xSfxPage->FillUserData();
 310         OUString sData(m_xSfxPage->GetUserData());
 311
 312         OUString sConfigId = OStringToOUString(m_xSfxPage->GetConfigId(),
 313             RTL_TEXTENCODING_UTF8);
 314         SvtViewOptions aPageOpt(EViewType::TabPage, sConfigId);
 315         aPageOpt.SetUserItem( USERITEM_NAME, makeAny( sData ) );
 316         m_xDialog->response(RET_OK);
 317     }
 318     else
 319         m_xDialog->response(RET_CANCEL);
 320 }
 321
 322 void SfxSingleTabDialogController::CreateOutputItemSet(const SfxItemSet& rSet)
 323 {
 324     assert(!m_xOutputSet && "Double creation of OutputSet!");
 325     m_xOutputSet.reset(new SfxItemSet(rSet));
 326     m_xOutputSet->ClearItem();
 327 }
 328
 329 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */