svtools/source/uno/wizard/wizardshell.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
  21 #include "wizardshell.hxx"
  22 #include "wizardpagecontroller.hxx"
  23
  24 #include <comphelper/diagnose_ex.hxx>
  25
  26 #include <com/sun/star/ui/dialogs/WizardTravelType.hpp>
  27
  28 using vcl::RoadmapWizardTypes::WizardPath;
  29 using vcl::RoadmapWizardTypes::PathId;
  30
  31 namespace svt::uno
  32 {
  33
  34
  35     using css::uno::Reference;
  36     using css::uno::Exception;
  37     using css::uno::Sequence;
  38     using css::ui::dialogs::XWizardController;
  39     using css::ui::dialogs::XWizardPage;
  40
  41     namespace WizardTravelType = css::ui::dialogs::WizardTravelType;
  42
  43
  44     namespace
  45     {
  46
  47         sal_Int16 lcl_determineFirstPageID( const Sequence< Sequence< sal_Int16 > >& i_rPaths )
  48         {
  49             ENSURE_OR_THROW( i_rPaths.hasElements() && i_rPaths[0].hasElements(), "illegal paths" );
  50             return i_rPaths[0][0];
  51         }
  52     }
  53
  54     //= WizardShell
  55     WizardShell::WizardShell(weld::Window* i_pParent, const Reference< XWizardController >& i_rController,
  56             const Sequence< Sequence< sal_Int16 > >& i_rPaths)
  57         :WizardShell_Base( i_pParent )
  58         ,m_xController( i_rController )
  59         ,m_nFirstPageID( lcl_determineFirstPageID( i_rPaths ) )
  60     {
  61         ENSURE_OR_THROW( m_xController.is(), "invalid controller" );
  62
  63         // declare the paths
  64         for ( sal_Int32 i=0; i<i_rPaths.getLength(); ++i )
  65         {
  66             const Sequence< sal_Int16 >& rPath( i_rPaths[i] );
  67             WizardPath aPath( rPath.getLength() );
  68             std::transform(rPath.begin(), rPath.end(), aPath.begin(),
  69                 [this](const sal_Int16 nPageId) -> WizardPath::value_type { return impl_pageIdToState(nPageId); });
  70             declarePath( static_cast<PathId>(i), aPath );
  71         }
  72
  73         // create the first page, to know the page size
  74         GetOrCreatePage( impl_pageIdToState( i_rPaths[0][0] ) );
  75         m_xAssistant->set_current_page(0);
  76
  77         // some defaults
  78         enableAutomaticNextButtonState();
  79     }
  80
  81     short WizardShell::run()
  82     {
  83         ActivatePage();
  84         return WizardShell_Base::run();
  85     }
  86
  87     OUString WizardShell::getPageIdentForState(WizardState nState) const
  88     {
  89         return OUString::number(impl_stateToPageId(nState));
  90     }
  91
  92     WizardState WizardShell::getStateFromPageIdent(const OUString& rIdent) const
  93     {
  94         return impl_pageIdToState(rIdent.toInt32());
  95     }
  96
  97     sal_Int16 WizardShell::convertCommitReasonToTravelType( const CommitPageReason i_eReason )
  98     {
  99         switch ( i_eReason )
 100         {
 101         case vcl::WizardTypes::eTravelForward:
 102             return WizardTravelType::FORWARD;
 103
 104         case vcl::WizardTypes::eTravelBackward:
 105             return WizardTravelType::BACKWARD;
 106
 107         case vcl::WizardTypes::eFinish:
 108             return WizardTravelType::FINISH;
 109
 110         default:
 111             break;
 112         }
 113         OSL_FAIL( "WizardShell::convertCommitReasonToTravelType: unsupported CommitPageReason!" );
 114         return WizardTravelType::FINISH;
 115     }
 116
 117
 118     void WizardShell::enterState( WizardState i_nState )
 119     {
 120         WizardShell_Base::enterState( i_nState );
 121
 122         if ( !m_xController.is() )
 123             return;
 124
 125         try
 126         {
 127             m_xController->onActivatePage( impl_stateToPageId( i_nState ) );
 128         }
 129         catch( const Exception& )
 130         {
 131             DBG_UNHANDLED_EXCEPTION("svtools.uno");
 132         }
 133     }
 134
 135
 136     bool WizardShell::leaveState( WizardState i_nState )
 137     {
 138         if ( !WizardShell_Base::leaveState( i_nState ) )
 139             return false;
 140
 141         if ( !m_xController.is() )
 142             return true;
 143
 144         try
 145         {
 146             m_xController->onDeactivatePage( impl_stateToPageId( i_nState ) );
 147         }
 148         catch( const Exception& )
 149         {
 150             DBG_UNHANDLED_EXCEPTION("svtools.uno");
 151         }
 152
 153         return true;
 154     }
 155
 156
 157     PWizardPageController WizardShell::impl_getController(BuilderPage* i_pPage) const
 158     {
 159         Page2ControllerMap::const_iterator pos = m_aPageControllers.find( i_pPage );
 160         ENSURE_OR_RETURN( pos != m_aPageControllers.end(), "WizardShell::impl_getController: no controller for this page!", PWizardPageController() );
 161         return pos->second;
 162     }
 163
 164
 165     Reference< XWizardPage > WizardShell::getCurrentWizardPage() const
 166     {
 167         const WizardState eState = getCurrentState();
 168
 169         PWizardPageController pController( impl_getController( GetPage( eState ) ) );
 170         ENSURE_OR_RETURN( pController, "WizardShell::getCurrentWizardPage: invalid page/controller!", nullptr );
 171
 172         return pController->getWizardPage();
 173     }
 174
 175     void WizardShell::enablePage( const sal_Int16 i_nPageID, const bool i_bEnable )
 176     {
 177         enableState( impl_pageIdToState( i_nPageID ), i_bEnable );
 178     }
 179
 180     namespace
 181     {
 182         class EmptyPage : public BuilderPage
 183         {
 184         public:
 185             EmptyPage(weld::Widget* pParent, weld::DialogController* pController)
 186                 : BuilderPage(pParent, pController, u"svt/ui/emptypage.ui"_ustr, u"EmptyPage"_ustr)
 187             {
 188                 m_xContainer->set_size_request(m_xContainer->get_approximate_digit_width() * 70,
 189                                                m_xContainer->get_text_height() * 10);
 190             }
 191             weld::Container* GetContainer() const { return m_xContainer.get(); }
 192         };
 193     }
 194
 195     std::unique_ptr<BuilderPage> WizardShell::createPage( WizardState i_nState )
 196     {
 197         ENSURE_OR_RETURN( m_xController.is(), "WizardShell::createPage: no WizardController!", nullptr );
 198
 199         sal_Int16 nPageId = impl_stateToPageId(i_nState);
 200
 201         OUString sIdent(OUString::number(nPageId));
 202         weld::Container* pPageContainer = m_xAssistant->append_page(sIdent);
 203
 204         auto xPage = std::make_unique<EmptyPage>(pPageContainer, this);
 205         m_aPageControllers[xPage.get()] =
 206             std::make_shared<WizardPageController>(xPage->GetContainer(), m_xController, nPageId);
 207
 208         return xPage;
 209     }
 210
 211     vcl::IWizardPageController* WizardShell::getPageController(BuilderPage* i_pCurrentPage) const
 212     {
 213         return impl_getController( i_pCurrentPage ).get();
 214     }
 215
 216     OUString WizardShell::getStateDisplayName( WizardState i_nState ) const
 217     {
 218         try
 219         {
 220             if ( m_xController.is() )
 221                 return m_xController->getPageTitle( impl_stateToPageId( i_nState ) );
 222         }
 223         catch( const Exception& )
 224         {
 225             DBG_UNHANDLED_EXCEPTION("svtools.uno");
 226         }
 227         // fallback for ill-behaved clients: the numeric state
 228         return OUString::number(i_nState);
 229     }
 230
 231
 232     bool WizardShell::canAdvance() const
 233     {
 234         try
 235         {
 236             if ( m_xController.is() && !m_xController->canAdvance() )
 237                 return false;
 238         }
 239         catch( const Exception& )
 240         {
 241             DBG_UNHANDLED_EXCEPTION("svtools.uno");
 242         }
 243
 244         return WizardShell_Base::canAdvance();
 245     }
 246
 247
 248     bool WizardShell::onFinish()
 249     {
 250         try
 251         {
 252             if ( m_xController.is() && !m_xController->confirmFinish() )
 253                 return false;
 254         }
 255         catch( const Exception& )
 256         {
 257             DBG_UNHANDLED_EXCEPTION("svtools.uno");
 258         }
 259
 260         return WizardShell_Base::onFinish();
 261     }
 262
 263
 264 } // namespace svt::uno
 265
 266
 267 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */