INTEGRATION: CWS swmailmerge (1.1.2); FILE ADDED

2004/09/03 08:16:46 os 1.1.2.16: #i25107# last fixes
2004/08/20 14:18:50 os 1.1.2.15: #i25107# SMTP after POP added
2004/08/13 11:55:03 os 1.1.2.14: #i25107# dispose of the result set impl.
2004/07/07 09:44:50 os 1.1.2.13: #i25107# syntax error
2004/07/06 11:25:42 os 1.1.2.12: #i25107# weekly check-in
2004/07/02 09:15:17 os 1.1.2.11: #i25107# weekly check-in
2004/06/23 14:06:57 os 1.1.2.10: #i25107# weekly check-in
2004/06/17 07:02:33 os 1.1.2.9: #i25107# weekly check-in
2004/06/08 06:56:25 os 1.1.2.8: #i25107# gender column added
2004/05/28 12:23:44 os 1.1.2.7: #i25107# access to ResultSet and Selection completed
2004/05/18 06:18:35 os 1.1.2.6: #i25107# merging implemented
2004/05/14 13:58:03 os 1.1.2.5: #i25107# weekly check-in
2004/05/10 09:50:34 os 1.1.2.4: #i25107# syntax errors
2004/05/07 09:50:14 os 1.1.2.3: #i25107# single instance configuration; mailer options added
2004/04/30 14:32:32 os 1.1.2.2: #i25107# intermediate check-in
2004/04/16 12:46:29 os 1.1.2.1: #i25107# Mail merge wizard configuration item

1 files changed, 314 insertions, 0 deletions

diff --git a/sw/source/ui/inc/mmconfigitem.hxx b/sw/source/ui/inc/mmconfigitem.hxx
new file mode 100644
index 000000000000..d8b43aca8a0f
--- /dev/null
+++ b/sw/source/ui/inc/mmconfigitem.hxx
@@ -0,0 +1,314 @@
+/*************************************************************************
+ *
+ *  $RCSfile: mmconfigitem.hxx,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: rt $ $Date: 2004-09-20 13:23:00 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 by Sun Microsystems, Inc.
+ *  901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License version 2.1, as published by the Free Software Foundation.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *  MA  02111-1307  USA
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (the "License"); You may not use this file
+ *  except in compliance with the License. You may obtain a copy of the
+ *  License at http://www.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+#ifndef _MMCONFIGITEM_HXX
+#define _MMCONFIGITEM_HXX
+
+#ifndef _COM_SUN_STAR_UNO_SEQUENCE_H_
+#include <com/sun/star/uno/Sequence.h>
+#endif
+#ifndef _COM_SUN_STAR_UNO_REFERENCE_H_
+#include <com/sun/star/uno/Reference.h>
+#endif
+#ifndef _TOOLS_RESARY_HXX
+#include <tools/resary.hxx>
+#endif
+#ifndef _SWDBDATA_HXX
+#include <swdbdata.hxx>
+#endif
+
+namespace com{namespace sun{namespace star{
+    namespace sdbc{
+        class XDataSource;
+        class XConnection;
+        class XResultSet;
+    }
+    namespace sdbcx{
+        class XColumnsSupplier;
+    }
+}}}
+class SwMailMergeConfigItem_Impl;
+class SwView;
+/*-- 06.04.2004 10:43:35---------------------------------------------------
+
+  -----------------------------------------------------------------------*/
+struct SwDocMergeInfo
+{
+    long    nStartPageInTarget;
+    long    nEndPageInTarget;
+    long    nDBRow;
+};
+class SwMailMergeConfigItem
+{
+//    com::sun::star::uno::Sequence< ::rtl::OUString>     m_aSavedDocuments;
+    SwMailMergeConfigItem_Impl*                                 m_pImpl;
+    //session information - not stored in configuration
+    bool                                                        m_bAddressInserted;
+    bool                                                        m_bMergeDone;
+    bool                                                        m_bGreetingInserted;
+    sal_Int32                                                   m_nGreetingMoves;
+    ::rtl::OUString                                             m_rAddressBlockFrame;
+    ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any> m_aSelection;
+
+    USHORT                                                      m_nStartPrint;
+    USHORT                                                      m_nEndPrint;
+
+    ::rtl::OUString                                             m_sSelectedPrinter;
+
+    SwView*                                                     m_pSourceView;
+    SwView*                                                     m_pTargetView;
+public:
+    SwMailMergeConfigItem();
+    ~SwMailMergeConfigItem();
+
+    enum Gender
+    {
+        FEMALE,
+        MALE,
+        NEUTRAL
+    };
+
+    void                Commit();
+
+    const ResStringArray&   GetDefaultAddressHeaders() const;
+
+    void                SetCurrentConnection(
+                            ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XDataSource>          xSource,
+                            ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection>          xConnection,
+                            ::com::sun::star::uno::Reference< ::com::sun::star::sdbcx::XColumnsSupplier>    xColumnsSupplier,
+                            const SwDBData& rDBData);
+
+    ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XDataSource>
+                        GetSource();
+
+    ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection>
+                        GetConnection();
+
+    ::com::sun::star::uno::Reference< ::com::sun::star::sdbcx::XColumnsSupplier>
+                        GetColumnsSupplier();
+
+    ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSet>
+                        GetResultSet();
+
+    void                DisposeResultSet();
+
+    ::rtl::OUString&    GetFilter() const;
+    void                SetFilter(::rtl::OUString&);
+
+    ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any>
+                        GetSelection()const;
+    void                SetSelection(::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any > rSelection);
+
+    void                SetCurrentDBData( const SwDBData& rDBData);
+    const SwDBData&     GetCurrentDBData() const;
+
+    // move absolute, nTarget == -1 -> goto last record
+    sal_Int32           MoveResultSet(sal_Int32 nTarget);
+    sal_Int32           GetResultSetPosition()const;
+    bool                IsResultSetFirstLast(bool& bIsFirst, bool& bIsLast);
+
+    bool                IsRecordExcluded(sal_Int32 nRecord);
+    void                ExcludeRecord(sal_Int32 nRecord, bool bExclude);
+
+    const com::sun::star::uno::Sequence< ::rtl::OUString>&
+                        GetSavedDocuments() const;
+    void                AddSavedDocument(::rtl::OUString rName);
+
+    sal_Bool            IsOutputToLetter()const;
+    void                SetOutputToLetter(sal_Bool bSet);
+
+    sal_Bool            IsAddressBlock()const;
+    void                SetAddressBlock(sal_Bool bSet);
+
+    const com::sun::star::uno::Sequence< ::rtl::OUString>
+                        GetAddressBlocks() const;
+    void                SetAddressBlocks(const com::sun::star::uno::Sequence< ::rtl::OUString>& rBlocks);
+
+
+    sal_Bool            IsIncludeCountry() const;
+    rtl::OUString&      GetExcludeCountry() const;
+    void                SetCountrySettings(sal_Bool bSet, const rtl::OUString& sCountry);
+
+    sal_Bool            IsIndividualGreeting(sal_Bool bInEMail) const;
+    void                SetIndividualGreeting(sal_Bool bSet, sal_Bool bInEMail);
+
+    sal_Bool            IsGreetingLine(sal_Bool bInEMail) const;
+    void                SetGreetingLine(sal_Bool bSet, sal_Bool bInEMail);
+
+    const com::sun::star::uno::Sequence< ::rtl::OUString>
+                        GetGreetings(Gender eType) const;
+    void                SetGreetings(Gender eType, const com::sun::star::uno::Sequence< ::rtl::OUString>& rBlocks);
+
+    sal_Int32           GetCurrentGreeting(Gender eType) const;
+    void                SetCurrentGreeting(Gender eType, sal_Int32 nIndex);
+
+    //the content of the gender column that marks it as female
+    const ::rtl::OUString& GetFemaleGenderValue() const;
+    void                   SetFemaleGenderValue(const ::rtl::OUString rValue);
+
+    //returns the assignment in the order of the default headers (GetDefaultAddressHeaders())
+    com::sun::star::uno::Sequence< ::rtl::OUString >
+                        GetColumnAssignment( const SwDBData& rDBData ) const;
+    void                SetColumnAssignment(
+                            const SwDBData& rDBData,
+                            const com::sun::star::uno::Sequence< ::rtl::OUString>& );
+
+    //e-Mail settings:
+    ::rtl::OUString     GetMailDisplayName() const;
+    void                SetMailDisplayName(const ::rtl::OUString& rName);
+
+    ::rtl::OUString     GetMailAddress() const;
+    void                SetMailAddress(const ::rtl::OUString& rAddress);
+
+    sal_Bool            IsMailReplyTo() const;
+    void                SetMailReplyTo(sal_Bool bSet);
+
+    ::rtl::OUString     GetMailReplyTo() const;
+    void                SetMailReplyTo(const ::rtl::OUString& rReplyTo);
+
+    ::rtl::OUString     GetMailServer() const;
+    void                SetMailServer(const ::rtl::OUString& rAddress);
+
+    sal_Int16           GetMailPort() const;
+    void                SetMailPort(sal_Int16 nSet);
+
+    sal_Bool            IsDefaultPort() const;
+    void                SetPortToDefault();
+
+    sal_Bool            IsSecureConnection() const;
+    void                SetSecureConnection(sal_Bool bSet);
+
+    sal_Bool            IsAuthentication() const;
+    void                SetAuthentication(sal_Bool bSet);
+
+    ::rtl::OUString     GetMailUserName() const;
+    void                SetMailUserName(const ::rtl::OUString& rName);
+
+    ::rtl::OUString     GetMailPassword() const;
+    void                SetMailPassword(const ::rtl::OUString& rPassword);
+
+    sal_Bool            IsSMTPAfterPOP() const;
+    void                SetSMTPAfterPOP(sal_Bool bSet);
+
+    ::rtl::OUString     GetInServerName() const;
+    void                SetInServerName(const ::rtl::OUString& rServer);
+
+    sal_Int16           GetInServerPort() const;
+    void                SetInServerPort(sal_Int16 nSet);
+
+    sal_Bool            IsInServerPOP() const;
+    void                SetInServerPOP(sal_Bool bSet);
+
+    ::rtl::OUString     GetInServerUserName() const;
+    void                SetInServerUserName(const ::rtl::OUString& rName);
+
+    ::rtl::OUString     GetInServerPassword() const;
+    void                SetInServerPassword(const ::rtl::OUString& rPassword);
+
+    //session information
+    bool                IsAddressInserted() const { return m_bAddressInserted; }
+    void                SetAddressInserted(const ::rtl::OUString& rFrameName)
+                            { m_bAddressInserted = true;
+                              m_rAddressBlockFrame = rFrameName;
+                            }
+
+    bool                IsGreetingInserted() const { return m_bGreetingInserted; }
+    void                SetGreetingInserted()
+                            { m_bGreetingInserted = true; }
+
+    // counts the moves in the layout page
+    void                MoveGreeting( sal_Int32 nMove) { m_nGreetingMoves += nMove;}
+    sal_Int32           GetGreetingMoves() const { return m_nGreetingMoves;}
+
+    bool                IsMergeDone() const { return m_bMergeDone;}
+    void                SetMergeDone(  ) { m_bMergeDone = true; }
+
+    // new source document - reset some flags
+    void                DocumentReloaded();
+
+    bool                IsMailAvailable() const;
+
+    // notify a completed merge, provid the appropriate e-Mail address if available
+    void                AddMergedDocument(SwDocMergeInfo& rInfo);
+    //returns the page and database cursor information of each merged document
+    SwDocMergeInfo&     GetDocumentMergeInfo(sal_uInt32 nDocument);
+    sal_uInt32          GetMergedDocumentCount() const;
+
+    void                SetPrintRange( USHORT nStartDocument, USHORT nEndDocument)
+                            {m_nStartPrint = nStartDocument; m_nEndPrint = nEndDocument;}
+    USHORT              GetPrintRangeStart() const  {return m_nStartPrint;}
+    USHORT              GetPrintRangeEnd() const {return m_nEndPrint;}
+
+    const ::rtl::OUString&  GetSelectedPrinter() const {return m_sSelectedPrinter;}
+    void                    SetSelectedPrinter(const ::rtl::OUString& rSet )
+                                    {m_sSelectedPrinter = rSet;}
+
+
+    SwView*             GetTargetView();
+    void                SetTargetView(SwView* pView);
+
+    SwView*             GetSourceView();
+    void                SetSourceView(SwView* pView) {m_pSourceView = pView;}
+
+    //helper methods
+    ::rtl::OUString     GetAssignedColumn(sal_uInt32 nColumn)const;
+};
+#endif
+