sw/source/ui/inc/mailmergewizard.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: mailmergewizard.hxx,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef _MAILMERGEWIZARD_HXX
  31 #define _MAILMERGEWIZARD_HXX
  32
  33 #include <svtools/roadmapwizard.hxx>
  34
  35 class SwView;
  36 class SwMailMergeConfigItem;
  37
  38 #define MM_DOCUMENTSELECTPAGE   0
  39 #define MM_OUTPUTTYPETPAGE      1
  40 #define MM_ADDRESSBLOCKPAGE     2
  41 #define MM_GREETINGSPAGE        3
  42 #define MM_LAYOUTPAGE           4
  43 #define MM_PREPAREMERGEPAGE     5
  44 #define MM_MERGEPAGE            6
  45 #define MM_OUTPUTPAGE           7
  46
  47 class SwMailMergeWizard : public ::svt::RoadmapWizard
  48 {
  49     SwView*                 m_pSwView;
  50     String                  sDocumentURL;
  51     bool                    m_bDocumentLoad;
  52
  53     SwMailMergeConfigItem&  m_rConfigItem;
  54
  55     String                  m_sStarting;
  56     String                  m_sDocumentType;
  57     String                  m_sAddressBlock;
  58     String                  m_sAddressList;
  59     String                  m_sGreetingsLine;
  60     String                  m_sLayout;
  61     String                  m_sPrepareMerge;
  62     String                  m_sMerge;
  63     String                  m_sOutput;
  64     String                  m_sFinish;
  65
  66     sal_uInt16              m_nRestartPage;
  67
  68     using svt::OWizardMachine::skipUntil;
  69
  70 protected:
  71     virtual svt::OWizardPage*       createPage(WizardState _nState);
  72     virtual void                    enterState( WizardState _nState );
  73
  74 // roadmap feature ??
  75 //    virtual sal_Bool            prepareLeaveCurrentState( CommitPageReason _eReason );
  76     virtual String                  getStateDisplayName( WizardState _nState ) const;
  77
  78 public:
  79     SwMailMergeWizard(SwView& rView, SwMailMergeConfigItem& rConfigItem);
  80     ~SwMailMergeWizard();
  81
  82     SwView*                     GetSwView() {return m_pSwView;}
  83     SwMailMergeConfigItem&      GetConfigItem() { return m_rConfigItem;}
  84
  85     void                    SetReloadDocument(const String& rURL){sDocumentURL = rURL;}
  86     const String&           GetReloadDocument() const {return sDocumentURL;}
  87
  88     //next step requires loading of document
  89     void                    SetDocumentLoad(bool bSet) {m_bDocumentLoad = bSet;}
  90
  91     void                    UpdateRoadmap();
  92     void                    CreateTargetDocument();
  93
  94     sal_uInt16              GetRestartPage() const {return m_nRestartPage;}
  95     void                    SetRestartPage(sal_uInt16 nPage) { m_nRestartPage = nPage;}
  96
  97     sal_Bool                skipUntil( sal_uInt16 nPage)
  98                                 {return ::svt::RoadmapWizard::skipUntil(WizardState(nPage));}
  99
 100     void                    updateRoadmapItemLabel( WizardState _nState );
 101
 102      virtual short                  Execute();
 103     virtual void            StartExecuteModal( const Link& rEndDialogHdl );
 104 };
 105 #endif
 106