sfx2/inc/mailmodelapi.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: mailmodelapi.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 #ifndef INCLUDED_SFX_MAILMODEL_HXX
  31 #define INCLUDED_SFX_MAILMODEL_HXX
  32
  33 #include <vector>
  34 #include <com/sun/star/frame/XFrame.hpp>
  35 #include <com/sun/star/frame/XModel.hpp>
  36 #include "tools/link.hxx"
  37 #include <tools/string.hxx>
  38 #include "sfx2/dllapi.h"
  39
  40 // class SfxMailModel_Impl -----------------------------------------------
  41
  42 class AddressList_Impl;
  43
  44 class SFX2_DLLPUBLIC SfxMailModel
  45 {
  46 public:
  47     enum MailPriority
  48     {
  49         PRIO_HIGHEST,
  50         PRIO_HIGH,
  51         PRIO_NORMAL,
  52         PRIO_LOW,
  53         PRIO_LOWEST
  54     };
  55
  56     enum AddressRole
  57     {
  58         ROLE_TO,
  59         ROLE_CC,
  60         ROLE_BCC
  61     };
  62
  63     enum MailDocType
  64     {
  65         TYPE_SELF,
  66         TYPE_ASPDF
  67     };
  68
  69 private:
  70     enum SaveResult
  71     {
  72         SAVE_SUCCESSFULL,
  73         SAVE_CANCELLED,
  74         SAVE_ERROR
  75     };
  76
  77     ::std::vector< ::rtl::OUString > maAttachedDocuments;
  78     AddressList_Impl*   mpToList;
  79     AddressList_Impl*   mpCcList;
  80     AddressList_Impl*   mpBccList;
  81     String                              maFromAddress;
  82     String                              maSubject;
  83     MailPriority                mePriority;
  84
  85     sal_Bool                    mbLoadDone;
  86
  87     void                                ClearList( AddressList_Impl* pList );
  88     void                                MakeValueList( AddressList_Impl* pList, String& rValueList );
  89     SaveResult                  SaveDocumentAsFormat( const rtl::OUString& aSaveFileName,
  90                                               const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& xFrameOrModel,
  91                                               const rtl::OUString& rType,
  92                                               rtl::OUString& rFileNamePath );
  93     SaveResult          ShowFilterOptionsDialog( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory > xSMGR,
  94                                                  const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel > xModel,
  95                                                  const ::rtl::OUString& rFilterName,
  96                                                  const ::rtl::OUString& rType,
  97                                                  bool bModified,
  98                                                  sal_Int32& rNumArgs,
  99                                                  ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& rArgs );
 100
 101     DECL_LINK( DoneHdl, void* );
 102
 103 public:
 104     enum SendMailResult
 105     {
 106         SEND_MAIL_OK,
 107         SEND_MAIL_CANCELLED,
 108         SEND_MAIL_ERROR
 109     };
 110
 111     SfxMailModel();
 112     ~SfxMailModel();
 113
 114     void                                AddAddress( const String& rAddress, AddressRole eRole );
 115     void                                SetFromAddress( const String& rAddress )        { maFromAddress = rAddress; }
 116     void                                SetSubject( const String& rSubject )            { maSubject = rSubject; }
 117     void                                SetPriority( MailPriority ePrio )                       { mePriority = ePrio; }
 118
 119     /** attaches a document to the current attachment list, can be called more than once.
 120     *   at the moment there will be a dialog for export executed for every model which is going to be attached.
 121     *
 122     * \param sDocumentType
 123         The doc type to export. PDF will be at the moment only a direct export (no dialog).
 124     * \param xModel
 125         The current model to attach
 126     * \param sAttachmentTitle
 127         The title which will be used as attachment title
 128     * \return @see error code
 129     */
 130     SendMailResult      AttachDocument( const ::rtl::OUString& sDocumentType,
 131                                         const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& xFrameOrModel,
 132                                         const ::rtl::OUString& sAttachmentTitle );
 133
 134     SendMailResult              SaveAndSend( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >& xFrame,
 135                                      const rtl::OUString& rType );
 136     SendMailResult      Send( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >& xFrame );
 137
 138     sal_Int32                   GetCount() const;
 139     sal_Bool                    IsEmpty() const;
 140 };
 141
 142 BOOL CreateFromAddress_Impl( String& rFrom );
 143
 144 #endif // INCLUDED_SFX_MAILMODEL_HXX