svtools/source/uno/wizard/wizardshell.hxx

   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 #pragma once
  21
  22 #include <com/sun/star/ui/dialogs/XWizardController.hpp>
  23 #include <com/sun/star/ui/dialogs/XWizard.hpp>
  24 #include <vcl/roadmapwizard.hxx>
  25 #include <map>
  26 #include <memory>
  27
  28 using vcl::WizardTypes::WizardState;
  29 using vcl::WizardTypes::CommitPageReason;
  30
  31 namespace svt::uno
  32 {
  33
  34
  35     class WizardPageController;
  36     typedef std::shared_ptr< WizardPageController > PWizardPageController;
  37
  38
  39     //= WizardShell
  40
  41     typedef ::vcl::RoadmapWizardMachine WizardShell_Base;
  42     class WizardShell : public WizardShell_Base
  43     {
  44     public:
  45         WizardShell(
  46             weld::Window* pParent,
  47             const css::uno::Reference< css::ui::dialogs::XWizardController >& i_rController,
  48             const css::uno::Sequence< css::uno::Sequence< sal_Int16 > >& i_rPaths
  49         );
  50
  51         // Dialog overridables
  52         virtual short   run() override;
  53
  54         // OWizardMachine overridables
  55         virtual std::unique_ptr<BuilderPage> createPage( WizardState i_nState ) override;
  56         virtual void        enterState( WizardState i_nState ) override;
  57         virtual bool        leaveState( WizardState i_nState ) override;
  58         virtual OUString    getStateDisplayName( WizardState i_nState ) const override;
  59         virtual bool        canAdvance() const override;
  60         virtual bool        onFinish() override;
  61         virtual vcl::IWizardPageController* getPageController(BuilderPage* pCurrentPage) const override;
  62
  63         static sal_Int16 convertCommitReasonToTravelType( const CommitPageReason i_eReason );
  64
  65         // operations
  66         bool    advanceTo( const sal_Int16 i_nPageId )
  67         {
  68             return skipUntil( impl_pageIdToState( i_nPageId ) );
  69         }
  70         bool    goBackTo( const sal_Int16 i_nPageId )
  71         {
  72             return skipBackwardUntil( impl_pageIdToState( i_nPageId ) );
  73         }
  74         using WizardShell_Base::travelNext;
  75         using WizardShell_Base::travelPrevious;
  76
  77         void        activatePath( const sal_Int16 i_nPathID, const bool i_bFinal )
  78         {
  79             WizardShell_Base::activatePath( vcl::RoadmapWizardTypes::PathId( i_nPathID ), i_bFinal );
  80         }
  81
  82         css::uno::Reference< css::ui::dialogs::XWizardPage >
  83                     getCurrentWizardPage() const;
  84
  85         sal_Int16   getCurrentPage() const
  86         {
  87             return impl_stateToPageId( getCurrentState() );
  88         }
  89
  90         void        enablePage( const sal_Int16 i_PageID, const bool i_Enable );
  91
  92         bool        knowsPage( const sal_Int16 i_nPageID ) const
  93         {
  94             return knowsState( impl_pageIdToState( i_nPageID ) );
  95         }
  96
  97     private:
  98         sal_Int16   impl_stateToPageId( const WizardState i_nState ) const
  99         {
 100             return static_cast< sal_Int16 >( i_nState + m_nFirstPageID );
 101         }
 102
 103         WizardState impl_pageIdToState( const sal_Int16 i_nPageId ) const
 104         {
 105             return static_cast<WizardState>(i_nPageId - m_nFirstPageID);
 106         }
 107
 108         PWizardPageController impl_getController(BuilderPage* i_pPage) const;
 109
 110         // prevent outside access to some base class members
 111         using WizardShell_Base::skip;
 112         using WizardShell_Base::skipUntil;
 113         using WizardShell_Base::skipBackwardUntil;
 114         using WizardShell_Base::getCurrentState;
 115         using WizardShell_Base::activatePath;
 116
 117     private:
 118         typedef std::map<BuilderPage*, PWizardPageController> Page2ControllerMap;
 119
 120         const css::uno::Reference< css::ui::dialogs::XWizardController >  m_xController;
 121         const sal_Int16                                                                             m_nFirstPageID;
 122         Page2ControllerMap                                                                          m_aPageControllers;
 123     };
 124
 125
 126 } // namespace svt::uno
 127
 128
 129
 130 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */