sw/source/uibase/inc/mailmergewizard.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 #ifndef INCLUDED_SW_SOURCE_UIBASE_INC_MAILMERGEWIZARD_HXX
  20 #define INCLUDED_SW_SOURCE_UIBASE_INC_MAILMERGEWIZARD_HXX
  21
  22 #include <vcl/roadmapwizard.hxx>
  23 #include <rtl/ustring.hxx>
  24
  25 class SwView;
  26 class SwMailMergeConfigItem;
  27
  28 using vcl::WizardTypes::WizardState;
  29 using vcl::WizardTypes::CommitPageReason;
  30
  31 #define MM_DOCUMENTSELECTPAGE   0
  32 #define MM_OUTPUTTYPETPAGE      1
  33 #define MM_ADDRESSBLOCKPAGE     2
  34 #define MM_GREETINGSPAGE        3
  35 #define MM_LAYOUTPAGE           4
  36
  37 class SwMailMergeWizard : public ::vcl::RoadmapWizardMachine
  38 {
  39     SwView*                 m_pSwView;
  40     OUString                sDocumentURL;
  41     bool                    m_bDocumentLoad;
  42
  43     std::shared_ptr<SwMailMergeConfigItem> m_xConfigItem;
  44
  45     OUString                m_sStarting;
  46     OUString                m_sDocumentType;
  47     OUString                m_sAddressBlock;
  48     OUString                m_sAddressList;
  49     OUString                m_sGreetingsLine;
  50     OUString                m_sLayout;
  51
  52     sal_uInt16              m_nRestartPage;
  53
  54     using vcl::WizardMachine::skipUntil;
  55
  56 protected:
  57     virtual std::unique_ptr<BuilderPage> createPage( WizardState _nState ) override;
  58     virtual void                    enterState( WizardState _nState ) override;
  59
  60     virtual OUString                getStateDisplayName( WizardState _nState ) const override;
  61
  62 public:
  63     SwMailMergeWizard(SwView& rView, std::shared_ptr<SwMailMergeConfigItem> const & rConfigItem);
  64     virtual ~SwMailMergeWizard() override;
  65
  66     SwView*                     GetSwView() {return m_pSwView;}
  67     SwMailMergeConfigItem&      GetConfigItem() { return *m_xConfigItem;}
  68
  69     void                    SetReloadDocument(const OUString& rURL) {sDocumentURL = rURL;}
  70     const OUString&         GetReloadDocument() const {return sDocumentURL;}
  71
  72     //next step requires loading of document
  73     void                    SetDocumentLoad(bool bSet) {m_bDocumentLoad = bSet;}
  74
  75     void                    UpdateRoadmap();
  76
  77     sal_uInt16              GetRestartPage() const {return m_nRestartPage;}
  78     void                    SetRestartPage(sal_uInt16 nPage) { m_nRestartPage = nPage;}
  79
  80     bool                skipUntil( sal_uInt16 nPage)
  81                                 {return ::vcl::RoadmapWizardMachine::skipUntil(WizardState(nPage));}
  82
  83     virtual short           run() override;
  84 };
  85 #endif
  86
  87 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */