sw/source/ui/inc/mailmergehelper.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: mailmergehelper.hxx,v $
  10  * $Revision: 1.11 $
  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 _MAILMERGEHELPER_HXX
  31 #define _MAILMERGEHELPER_HXX
  32
  33 #include <svtools/stdctrl.hxx>
  34 #include <unotools/configitem.hxx>
  35 #include <com/sun/star/uno/Sequence.h>
  36 #include "com/sun/star/mail/XAuthenticator.hpp"
  37 #include "com/sun/star/mail/XConnectionListener.hpp"
  38 #include "com/sun/star/uno/XCurrentContext.hpp"
  39 #include "com/sun/star/mail/XMailMessage.hpp"
  40 #include "com/sun/star/datatransfer/XTransferable.hpp"
  41 #include <com/sun/star/beans/XPropertySet.hpp>
  42 #include <cppuhelper/implbase1.hxx>
  43 #include <cppuhelper/compbase1.hxx>
  44 #include <cppuhelper/compbase2.hxx>
  45 #include <vcl/scrbar.hxx>
  46 #include "swdllapi.h"
  47
  48
  49 class SwMailMergeConfigItem;
  50 namespace com{ namespace sun{ namespace star{
  51     namespace uno{
  52         class XComponentContext;
  53     }
  54     namespace lang{
  55         class XMultiServiceFactory;
  56     }
  57     namespace mail{
  58         class XSmtpService;
  59         class XMailService;
  60     }
  61 }}}
  62 /*-- 14.06.2004 12:27:42---------------------------------------------------
  63
  64   -----------------------------------------------------------------------*/
  65 namespace SwMailMergeHelper
  66 {
  67     SW_DLLPUBLIC String  CallSaveAsDialog(String& rFilter);
  68     SW_DLLPUBLIC bool    CheckMailAddress( const ::rtl::OUString& rMailAddress );
  69     SW_DLLPUBLIC com::sun::star::uno::Reference< com::sun::star::mail::XSmtpService >
  70                          ConnectToSmtpServer( SwMailMergeConfigItem& rConfigItem,
  71                             com::sun::star::uno::Reference< com::sun::star::mail::XMailService >&  xInMailService,
  72                             const String& rInMailServerPassword,
  73                             const String& rOutMailServerPassword,
  74                             Window* pDialogParentWindow = 0 );
  75 }
  76 /* -----------------06.04.2004 10:29-----------------
  77
  78  --------------------------------------------------*/
  79 class SW_DLLPUBLIC SwBoldFixedInfo : public FixedInfo
  80 {
  81 public:
  82     SwBoldFixedInfo(Window* pParent, const ResId& rResId);
  83     ~SwBoldFixedInfo();
  84 };
  85 struct SwAddressPreview_Impl;
  86 namespace com{namespace sun{namespace star{
  87     namespace container{
  88         class XNameAccess;
  89     }
  90 }}}
  91
  92 /*-- 27.04.2004 13:20:00---------------------------------------------------
  93     Preview window used to show the possible selection of address blocks
  94     and also the resulting address filled with database data
  95   -----------------------------------------------------------------------*/
  96 class SW_DLLPUBLIC SwAddressPreview : public Window
  97 {
  98     ScrollBar               aVScrollBar;
  99     SwAddressPreview_Impl*  pImpl;
 100     Link                    m_aSelectHdl;
 101
 102     void DrawText_Impl( const ::rtl::OUString& rAddress, const Point& rTopLeft, const Size& rSize, bool bIsSelected);
 103
 104     virtual void        Paint(const Rectangle&);
 105     virtual void        MouseButtonDown( const MouseEvent& rMEvt );
 106     virtual void        KeyInput( const KeyEvent& rKEvt );
 107     virtual void        StateChanged( StateChangedType nStateChange );
 108     void                UpdateScrollBar();
 109
 110     DECL_LINK(ScrollHdl, ScrollBar*);
 111
 112 public:
 113     SwAddressPreview(Window* pParent, const ResId rResId);
 114     ~SwAddressPreview();
 115
 116     /** The address string is a list of address elements separated by spaces
 117     and breaks. The addresses fit into the given layout. If more addresses then
 118     rows/columns should be used a scrollbar will be added.
 119
 120      AddAddress appends the new address to the already added ones.
 121      Initially the first added address will be selected
 122     */
 123     void                    AddAddress(const ::rtl::OUString& rAddress);
 124     //  for preview mode - replaces the currently used address by the given one
 125     void                    SetAddress(const ::rtl::OUString& rAddress);
 126     // removes all addresses
 127     void                    Clear();
 128
 129     // returns the selected address
 130     sal_uInt16              GetSelectedAddress() const;
 131     void                    SelectAddress(sal_uInt16 nSelect);
 132     void                    ReplaceSelectedAddress(const ::rtl::OUString&);
 133     void                    RemoveSelectedAddress();
 134
 135     // set the number of rows and columns of addresses
 136     void                    SetLayout(sal_uInt16 nRows, sal_uInt16 nColumns);
 137     void                    EnableScrollBar(bool bEnable = true);
 138
 139     // fill the actual data into a string (address block or greeting)
 140     static String FillData(
 141             const ::rtl::OUString& rAddress,
 142             SwMailMergeConfigItem& rConfigItem,
 143             const ::com::sun::star::uno::Sequence< ::rtl::OUString>* pAssignments = 0);
 144
 145     void    SetSelectHdl (const Link& rLink) {m_aSelectHdl = rLink;}
 146 };
 147
 148 /*-- 11.05.2004 15:39:59---------------------------------------------------
 149     iterate over an address block or a greeting line
 150     the iterator returns the parts either as pure string
 151     or as column
 152   -----------------------------------------------------------------------*/
 153 struct SwMergeAddressItem
 154 {
 155     String  sText;
 156     bool    bIsColumn;
 157     bool    bIsReturn;
 158     SwMergeAddressItem() :
 159         bIsColumn(false),
 160         bIsReturn(false) {}
 161 };
 162 class SW_DLLPUBLIC   SwAddressIterator
 163 {
 164     String sAddress;
 165 public:
 166     SwAddressIterator(const String& rAddress) :
 167         sAddress(rAddress){}
 168
 169     SwMergeAddressItem  Next();
 170     bool                HasMore() const{return sAddress.Len() > 0;}
 171 };
 172
 173 /*-- 21.05.2004 10:31:15---------------------------------------------------
 174
 175   -----------------------------------------------------------------------*/
 176 class SW_DLLPUBLIC SwAuthenticator :
 177     public cppu::WeakImplHelper1< ::com::sun::star::mail::XAuthenticator>
 178 {
 179     ::rtl::OUString m_aUserName;
 180     ::rtl::OUString m_aPassword;
 181     Window*         m_pParentWindow;
 182 public:
 183     SwAuthenticator() : m_pParentWindow(0) {}
 184     SwAuthenticator(const ::rtl::OUString& username, const ::rtl::OUString& password, Window* pParent) :
 185         m_aUserName(username),
 186         m_aPassword(password),
 187         m_pParentWindow( pParent )
 188     {}
 189     ~SwAuthenticator();
 190
 191     virtual ::rtl::OUString SAL_CALL getUserName( ) throw (::com::sun::star::uno::RuntimeException);
 192     virtual ::rtl::OUString SAL_CALL getPassword(  ) throw (::com::sun::star::uno::RuntimeException);
 193
 194 };
 195 /*-- 25.08.2004 12:48:47---------------------------------------------------
 196
 197   -----------------------------------------------------------------------*/
 198 class SW_DLLPUBLIC SwConnectionContext :
 199     public cppu::WeakImplHelper1< ::com::sun::star::uno::XCurrentContext >
 200 {
 201     ::rtl::OUString     m_sMailServer;
 202     sal_Int16           m_nPort;
 203     ::rtl::OUString     m_sConnectionType;
 204
 205 public:
 206     SwConnectionContext(const ::rtl::OUString& rMailServer, sal_Int16 nPort, const ::rtl::OUString& rConnectionType);
 207     ~SwConnectionContext();
 208
 209     virtual ::com::sun::star::uno::Any SAL_CALL     getValueByName( const ::rtl::OUString& Name )
 210                                                             throw (::com::sun::star::uno::RuntimeException);
 211 };
 212 /*-- 21.05.2004 10:39:20---------------------------------------------------
 213
 214   -----------------------------------------------------------------------*/
 215 class SwMutexBase
 216 {
 217 public:
 218     osl::Mutex m_aMutex;
 219 };
 220 /*-- 21.05.2004 10:39:20---------------------------------------------------
 221
 222   -----------------------------------------------------------------------*/
 223 class SW_DLLPUBLIC SwConnectionListener :
 224         public SwMutexBase,
 225         public cppu::WeakComponentImplHelper1< ::com::sun::star::mail::XConnectionListener >
 226 {
 227     using cppu::WeakComponentImplHelperBase::disposing;
 228
 229 public:
 230     SwConnectionListener() :
 231         cppu::WeakComponentImplHelper1< ::com::sun::star::mail::XConnectionListener>(m_aMutex)
 232     {}
 233     ~SwConnectionListener();
 234
 235     virtual void SAL_CALL connected(const ::com::sun::star::lang::EventObject& aEvent)
 236         throw (::com::sun::star::uno::RuntimeException);
 237
 238     virtual void SAL_CALL disconnected(const ::com::sun::star::lang::EventObject& aEvent)
 239         throw (::com::sun::star::uno::RuntimeException);
 240
 241     virtual void SAL_CALL disposing(const com::sun::star::lang::EventObject& aEvent)
 242         throw(com::sun::star::uno::RuntimeException);
 243 };
 244
 245 /*-- 13.07.2004 09:02:12---------------------------------------------------
 246
 247   -----------------------------------------------------------------------*/
 248 class SwMailTransferable :
 249         public SwMutexBase,
 250         public cppu::WeakComponentImplHelper2
 251         <
 252             ::com::sun::star::datatransfer::XTransferable,
 253             ::com::sun::star::beans::XPropertySet
 254         >
 255 {
 256     rtl::OUString  m_aMimeType;
 257     rtl::OUString  m_sBody;
 258     rtl::OUString  m_aURL;
 259     rtl::OUString  m_aName;
 260     bool           m_bIsBody;
 261
 262     public:
 263     SwMailTransferable(const rtl::OUString& rURL, const rtl::OUString& rName, const rtl::OUString& rMimeType);
 264     SwMailTransferable(const rtl::OUString& rBody, const rtl::OUString& rMimeType);
 265     ~SwMailTransferable();
 266     virtual ::com::sun::star::uno::Any SAL_CALL
 267                         getTransferData( const ::com::sun::star::datatransfer::DataFlavor& aFlavor )
 268                             throw (::com::sun::star::datatransfer::UnsupportedFlavorException, ::com::sun::star::io::IOException, ::com::sun::star::uno::RuntimeException);
 269     virtual ::com::sun::star::uno::Sequence< ::com::sun::star::datatransfer::DataFlavor > SAL_CALL
 270                         getTransferDataFlavors(  )
 271                             throw (::com::sun::star::uno::RuntimeException) ;
 272     virtual ::sal_Bool SAL_CALL
 273                         isDataFlavorSupported( const ::com::sun::star::datatransfer::DataFlavor& aFlavor )
 274                             throw (::com::sun::star::uno::RuntimeException);
 275
 276     //XPropertySet
 277     virtual ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo(  ) throw(::com::sun::star::uno::RuntimeException);
 278     virtual void SAL_CALL setPropertyValue( const ::rtl::OUString& aPropertyName, const ::com::sun::star::uno::Any& aValue ) throw(::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::beans::PropertyVetoException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
 279     virtual ::com::sun::star::uno::Any SAL_CALL getPropertyValue( const ::rtl::OUString& PropertyName ) throw(::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
 280     virtual void SAL_CALL addPropertyChangeListener( const ::rtl::OUString& aPropertyName, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener >& xListener ) throw(::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
 281     virtual void SAL_CALL removePropertyChangeListener( const ::rtl::OUString& aPropertyName, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener >& aListener ) throw(::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
 282     virtual void SAL_CALL addVetoableChangeListener( const ::rtl::OUString& PropertyName, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XVetoableChangeListener >& aListener ) throw(::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
 283     virtual void SAL_CALL removeVetoableChangeListener( const ::rtl::OUString& PropertyName, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XVetoableChangeListener >& aListener ) throw(::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
 284
 285 };
 286
 287 /*-- 22.06.2004 16:38:34---------------------------------------------------
 288
 289   -----------------------------------------------------------------------*/
 290 class SwMailMessage :
 291         public SwMutexBase,
 292         public cppu::WeakComponentImplHelper1< ::com::sun::star::mail::XMailMessage >
 293 {
 294     ::rtl::OUString                                                                         m_sSenderName;
 295     ::rtl::OUString                                                                         m_sSenderAddress;
 296     ::rtl::OUString                                                                         m_sReplyToAddress;
 297     ::rtl::OUString                                                                         m_sSubject;
 298
 299     ::com::sun::star::uno::Reference< ::com::sun::star::datatransfer::XTransferable>        m_xBody;
 300 //    ::com::sun::star::mail::MailMessageBody                                                 m_aBody;
 301
 302     ::com::sun::star::uno::Sequence< ::rtl::OUString >                                      m_aRecipients;
 303     ::com::sun::star::uno::Sequence< ::rtl::OUString >                                      m_aCcRecipients;
 304     ::com::sun::star::uno::Sequence< ::rtl::OUString >                                      m_aBccRecipients;
 305 //    ::com::sun::star::uno::Sequence< ::com::sun::star::mail::MailAttachmentDescriptor >     m_aAttachments;
 306     ::com::sun::star::uno::Sequence<  ::com::sun::star::mail::MailAttachment >              m_aAttachments;
 307 public:
 308     SwMailMessage();
 309     ~SwMailMessage();
 310
 311     // Attributes
 312     virtual ::rtl::OUString SAL_CALL    getSenderName() throw (::com::sun::star::uno::RuntimeException);
 313     virtual ::rtl::OUString SAL_CALL    getSenderAddress() throw (::com::sun::star::uno::RuntimeException);
 314     virtual ::rtl::OUString SAL_CALL    getReplyToAddress() throw (::com::sun::star::uno::RuntimeException);
 315     virtual void SAL_CALL               setReplyToAddress( const ::rtl::OUString& _replytoaddress ) throw (::com::sun::star::uno::RuntimeException);
 316     virtual ::rtl::OUString SAL_CALL    getSubject() throw (::com::sun::star::uno::RuntimeException);
 317     virtual void SAL_CALL               setSubject( const ::rtl::OUString& _subject ) throw (::com::sun::star::uno::RuntimeException);
 318
 319     virtual ::com::sun::star::uno::Reference< ::com::sun::star::datatransfer::XTransferable > SAL_CALL
 320                                         getBody()
 321                                                 throw (::com::sun::star::uno::RuntimeException);
 322     virtual void SAL_CALL               setBody( const ::com::sun::star::uno::Reference< ::com::sun::star::datatransfer::XTransferable >& _body )
 323                                                 throw (::com::sun::star::uno::RuntimeException);
 324
 325     // Methods
 326     virtual void SAL_CALL               addRecipient( const ::rtl::OUString& sRecipientAddress ) throw (::com::sun::star::uno::RuntimeException);
 327     virtual void SAL_CALL               addCcRecipient( const ::rtl::OUString& sRecipientAddress ) throw (::com::sun::star::uno::RuntimeException);
 328     virtual void SAL_CALL               addBccRecipient( const ::rtl::OUString& sRecipientAddress ) throw (::com::sun::star::uno::RuntimeException);
 329     virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL
 330                                         getRecipients(  ) throw (::com::sun::star::uno::RuntimeException);
 331     virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL
 332                                         getCcRecipients(  ) throw (::com::sun::star::uno::RuntimeException);
 333     virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL
 334                                         getBccRecipients(  ) throw (::com::sun::star::uno::RuntimeException);
 335     virtual void SAL_CALL               addAttachment( const ::com::sun::star::mail::MailAttachment& aMailAttachment )
 336                                             throw (::com::sun::star::uno::RuntimeException);
 337     virtual ::com::sun::star::uno::Sequence< ::com::sun::star::mail::MailAttachment > SAL_CALL
 338                                         getAttachments(  ) throw (::com::sun::star::uno::RuntimeException);
 339     void                                SetSenderName(const ::rtl::OUString& rSenderName)
 340                                                 {m_sSenderName = rSenderName;}
 341     void                                SetSenderAddress(const ::rtl::OUString& rSenderAddress)
 342                                                 {m_sSenderAddress = rSenderAddress;}
 343 };
 344 /*-- 21.05.2004 10:17:22---------------------------------------------------
 345
 346   -----------------------------------------------------------------------*/
 347 SW_DLLPUBLIC ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext>
 348         getCurrentCmpCtx(
 349             ::com::sun::star::uno::Reference<
 350                 ::com::sun::star::lang::XMultiServiceFactory> rSrvMgr);
 351 #endif
 352