extensions/source/abpilot/abspilot.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: abspilot.hxx,v $
  10  * $Revision: 1.8 $
  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
  31 #ifndef EXTENSIONS_ABSPILOT_HXX
  32 #define EXTENSIONS_ABSPILOT_HXX
  33
  34 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  35 #include <svtools/roadmapwizard.hxx>
  36 #include "addresssettings.hxx"
  37 #include <vcl/fixed.hxx>
  38 #include "datasourcehandling.hxx"
  39
  40 //.........................................................................
  41 namespace abp
  42 {
  43 //.........................................................................
  44
  45     //=====================================================================
  46     //= OAddessBookSourcePilot
  47     //=====================================================================
  48     typedef ::svt::RoadmapWizard OAddessBookSourcePilot_Base;
  49     class OAddessBookSourcePilot : public OAddessBookSourcePilot_Base
  50     {
  51     protected:
  52         ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >
  53                                 m_xORB;
  54         AddressSettings                 m_aSettings;
  55
  56         ODataSource                             m_aNewDataSource;
  57         AddressSourceType               m_eNewDataSourceType;
  58
  59     public:
  60         /// ctor
  61         OAddessBookSourcePilot(
  62             Window* _pParent,
  63             const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxORB);
  64
  65         /// get the service factory which was used to create the dialog
  66         ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >
  67                                 getORB() { return m_xORB; }
  68         AddressSettings&                getSettings() { return m_aSettings; }
  69         const AddressSettings&  getSettings() const { return m_aSettings; }
  70
  71         const ODataSource&              getDataSource() const { return m_aNewDataSource; }
  72
  73         sal_Bool                                connectToDataSource( sal_Bool _bForceReConnect );
  74
  75         void                                    travelNext( ) { OAddessBookSourcePilot_Base::travelNext(); }
  76
  77         /// to be called when the selected type changed
  78         void                    typeSelectionChanged( AddressSourceType _eType );
  79
  80     protected:
  81         // OWizardMachine overridables
  82         virtual ::svt::OWizardPage* createPage( WizardState _nState );
  83         virtual void                enterState( WizardState _nState );
  84         virtual sal_Bool            prepareLeaveCurrentState( CommitPageReason _eReason );
  85         virtual sal_Bool            onFinish( sal_Int32 _nResult );
  86
  87         // RoadmapWizard
  88         virtual String              getStateDisplayName( WizardState _nState ) const;
  89
  90         virtual BOOL    Close();
  91
  92     private:
  93         DECL_LINK( OnCancelClicked, void* );
  94
  95         /** creates a new data source of the type indicated by m_aSettings
  96             <p>If another data source has been created before, this one is deleted.</p>
  97         */
  98         void implCreateDataSource();
  99
 100         /// does an automatic field mapping (possible for all types except AST_OTHER)
 101         void implDoAutoFieldMapping();
 102
 103         /// guesses a default for the table name, if no valid table is selected
 104         void implDefaultTableName();
 105
 106         inline sal_Bool needAdminInvokationPage( AddressSourceType _eType ) const
 107         {
 108             return      (       ( AST_LDAP == _eType )
 109                     ||  ( AST_OTHER == _eType )
 110                     );
 111         }
 112         /// check if with the current settings, we would need to invoke he administration dialog for more details about the data source
 113         inline sal_Bool needAdminInvokationPage() const
 114         {
 115             return      needAdminInvokationPage( m_aSettings.eType );
 116         }
 117
 118         inline sal_Bool needManualFieldMapping( AddressSourceType _eType ) const
 119         {
 120             return  ( AST_OTHER == _eType ) || ( AST_KAB == _eType ) ||
 121                     ( AST_EVOLUTION == _eType ) || ( AST_EVOLUTION_GROUPWISE == _eType ) ||
 122                     ( AST_EVOLUTION_LDAP == _eType );
 123         }
 124         /// checks if we need a manual (user-guided) field mapping
 125         inline sal_Bool needManualFieldMapping() const
 126         {
 127             return needManualFieldMapping( m_aSettings.eType );
 128         }
 129
 130         /// determines whether the given address book type does provide one table only
 131         inline bool needTableSelection( AddressSourceType _eType ) const
 132         {
 133             return  ( AST_LDAP != _eType ) && ( AST_KAB != _eType );
 134         }
 135
 136         inline bool needTableSelection() const
 137         {
 138             return needTableSelection( m_aSettings.eType );
 139         }
 140
 141         void implCleanup();
 142         void implCommitAll();
 143
 144         void impl_updateRoadmap( AddressSourceType _eType );
 145     };
 146
 147 //.........................................................................
 148 }       // namespace abp
 149 //.........................................................................
 150
 151 #endif // EXTENSIONS_ABSPILOT_HXX
 152