binfilter/inc/bf_sw/dbmgr.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: dbmgr.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 _SWDBMGR_HXX
  31 #define _SWDBMGR_HXX
  32
  33
  34 #ifndef _STRING_HXX //autogen
  35 #include <tools/string.hxx>
  36 #endif
  37
  38 #ifndef _SVARRAY_HXX
  39 #include <bf_svtools/svarray.hxx>
  40 #endif
  41 #ifndef _COM_SUN_STAR_UTIL_DATE_HPP_
  42 #include <com/sun/star/util/Date.hpp>
  43 #endif
  44
  45 #ifndef _SWDBDATA_HXX
  46 #include <swdbdata.hxx>
  47 #endif
  48 #ifndef _COM_SUN_STAR_UNO_REFERENCE_H_
  49 #include <com/sun/star/uno/Reference.h>
  50 #endif
  51 #ifndef _COM_SUN_STAR_UNO_SEQUENCE_H_
  52 #include <com/sun/star/uno/Sequence.h>
  53 #endif
  54 #ifndef _COM_SUN_STAR_LANG_LOCALE_HPP_
  55 #include <com/sun/star/lang/Locale.hpp>
  56 #endif
  57
  58 namespace com{namespace sun{namespace star{
  59     namespace sdbc{
  60         class XConnection;
  61         class XStatement;
  62         class XDataSource;
  63         class XResultSet;
  64     }
  65     namespace beans{
  66
  67         class XPropertySet;
  68         struct PropertyValue;
  69     }
  70     namespace sdbcx{
  71         class XColumnsSupplier;
  72     }
  73     namespace util{
  74         class XNumberFormatter;
  75     }
  76 }}}
  77 class ListBox;
  78 class Button;
  79 namespace binfilter {
  80 class SvNumberFormatter;
  81 namespace svx {
  82     class ODataAccessDescriptor;
  83 }
  84
  85 struct SwDBFormatData
  86 {
  87     ::com::sun::star::util::Date aNullDate;
  88     ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatter> xFormatter;
  89     ::com::sun::star::lang::Locale aLocale;
  90 };
  91
  92 class SwView;
  93 class SwWrtShell;
  94 class SwPrtOptions;
  95 class SfxProgress;
  96
  97 class SwMailMergeDlg;
  98 class SwDbtoolsClient;
  99 class SwXMailMerge;
 100
 101 // -----------------------------------------------------------------------
 102
 103 enum DBMgrOptions
 104 {
 105     DBMGR_MERGE,                        // Datensaetze in Felder
 106     DBMGR_INSERT,                       // Datensaetze in Text
 107     DBMGR_MERGE_MAILMERGE,      // Serienbriefe drucken
 108     DBMGR_MERGE_MAILING,        // Serienbriefe als email versenden
 109     DBMGR_MERGE_MAILFILES       // Serienbriefe als Datei(en) speichern
 110 };
 111
 112 // -----------------------------------------------------------------------
 113
 114 /*--------------------------------------------------------------------
 115      Beschreibung: (neue) Logische Datenbanken verwalten
 116  --------------------------------------------------------------------*/
 117 #define SW_DB_SELECT_UNKNOWN    0
 118 #define SW_DB_SELECT_TABLE              1
 119 #define SW_DB_SELECT_QUERY      2
 120
 121 struct SwDSParam : public SwDBData
 122 {
 123     ::com::sun::star::util::Date        aNullDate;
 124
 125     ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatter>         xFormatter;
 126     ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection>              xConnection;
 127     ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XStatement>               xStatement;
 128     ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSet>       xResultSet;
 129     ::com::sun::star::uno::Sequence<  ::com::sun::star::uno::Any >                              aSelection;
 130     BOOL bScrollable;
 131     BOOL bEndOfDB;
 132     BOOL bAfterSelection;
 133     long nSelectionIndex;
 134
 135     SwDSParam(const SwDBData& rData) :
 136         SwDBData(rData),
 137         bScrollable(FALSE),
 138         bEndOfDB(FALSE),
 139         bAfterSelection(FALSE),
 140         nSelectionIndex(0)
 141         {}
 142
 143     SwDSParam(const SwDBData& rData,
 144         const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSet>&    xResSet,
 145         const ::com::sun::star::uno::Sequence<  ::com::sun::star::uno::Any >&   rSelection) :
 146         SwDBData(rData),
 147         bScrollable(TRUE),
 148         bEndOfDB(FALSE),
 149         bAfterSelection(FALSE),
 150         nSelectionIndex(0),
 151         xResultSet(xResSet),
 152         aSelection(rSelection)
 153         {}
 154
 155         void CheckEndOfDB()
 156         {
 157             if(bEndOfDB)
 158                 bAfterSelection = TRUE;
 159         }
 160 };
 161 typedef SwDSParam* SwDSParamPtr;
 162 SV_DECL_PTRARR_DEL(SwDSParamArr, SwDSParamPtr, 0, 5)
 163
 164 struct SwNewDBMgr_Impl;
 165 class SwConnectionDisposedListener_Impl;
 166 class SwNewDBMgr
 167 {
 168 friend class SwConnectionDisposedListener_Impl;
 169
 170     static SwDbtoolsClient* pDbtoolsClient;
 171
 172     String              sEMailAddrFld;  // Mailing: Spaltenname der E-Mail Adresse
 173     String                              sSubject;               // Mailing: Subject
 174     String                              sAttached;              // Mailing: Attachte Files
 175     USHORT                              nMergeType;
 176     BOOL                                bInitDBFields : 1;      // TRUE: Datenbank an Feldern beim Mergen
 177     BOOL                                bSingleJobs : 1;        // Einzelne Druckjobs bei Aufruf aus Basic
 178     BOOL                                bCancel : 1;            // Serienbrief-Save abgebrochen
 179
 180     BOOL                                bInMerge        : 1;    //merge process active
 181     BOOL                bMergeSilent : 1;   // suppress display of dialogs/boxes (used when called over API)
 182     BOOL                bMergeLock : 1;     // prevent update of database fields while document is
 183                                             // actually printed at the ViewShell
 184     SwDSParamArr                aDataSourceParams;
 185     SwNewDBMgr_Impl*    pImpl;
 186     const SwXMailMerge* pMergeEvtSrc;   // != 0 if mail merge events are to be send
 187
 188     SwDSParam*          pMergeData;
 189     SwMailMergeDlg*             pMergeDialog;
 190
 191     SwDSParam*          FindDSData(const SwDBData& rData, BOOL bCreate);
 192     SwDSParam*          FindDSConnection(const ::rtl::OUString& rSource, BOOL bCreate);
 193
 194
 195
 196     // Datensaetze als Text ins Dokument einfuegen
 197
 198     // Einzelnen Datensatz als Text ins Dokument einfuegen
 199
 200     // Mischen von Datensaetzen in Felder, dann per email versenden
 201     // Mischen von Datensaetzen in Felder, dann als Datei abspeichern
 202     BOOL            ToNextRecord(SwDSParam* pParam);
 203
 204 public:
 205     SwNewDBMgr();
 206     ~SwNewDBMgr();
 207
 208     // Art des aktellen Mergens. Siehe DBMgrOptions-enum
 209     inline USHORT       GetMergeType() const                    { return nMergeType; }
 210     inline void         SetMergeType( USHORT nTyp )     { nMergeType = nTyp; }
 211
 212     // MailMergeEvent source
 213     const SwXMailMerge *    GetMailMergeEvtSrc() const  { return pMergeEvtSrc; }
 214     void SetMailMergeEvtSrc( const SwXMailMerge *pSrc ) { pMergeEvtSrc = pSrc; }
 215
 216     inline BOOL     IsMergeSilent() const           { return bMergeSilent != 0; }
 217     inline void     SetMergeSilent( BOOL bVal )     { bMergeSilent = bVal; }
 218
 219     // Mischen von Datensaetzen in Felder, dann drucken
 220     // Datenbankfelder mit fehlendem Datenbankname initialisieren
 221     inline BOOL         IsInitDBFields() const  { return bInitDBFields; }
 222     inline void         SetInitDBFields(BOOL b) { bInitDBFields = b;    }
 223
 224     // Serienbriefe einzelnd oder alle zusammen drucken/speichern
 225     inline BOOL         IsSingleJobs() const    { return bSingleJobs;   }
 226     inline void         SetSingleJobs(BOOL b)   { bSingleJobs = b;      }
 227
 228     // Mailing
 229     // email-Daten setzen
 230     inline void         SetEMailColumn(const String& sColName) { sEMailAddrFld = sColName; }
 231     inline void         SetSubject(const String& sSbj) { sSubject = sSbj; }
 232     inline void         SetAttachment(const String& sAtt) { sAttached = sAtt; }
 233
 234
 235     // Listbox mit allen Tabellennamen einer Datenbank fuellen
 236
 237     // Listbox mit allen Spaltennamen einer Datenbanktabelle fuellen
 238
 239
 240
 241     inline BOOL         IsInMerge() const       { return bInMerge; }
 242
 243     // check if a data source is open
 244     BOOL            IsDataSourceOpen(const String& rDataSource,
 245                                     const String& rTableOrQuery, sal_Bool bMergeOnly);
 246
 247     // add data source information to the data source array - was PreInitDBData
 248     void            AddDSData(const SwDBData& rData, long nSelStart, long nSelEnd);
 249     void            GetDSSelection(const SwDBData& rData, long& rSelStart, long& rSelEnd);
 250
 251     // open the source while fields are updated - for the calculator only!
 252     BOOL            OpenDataSource(const String& rDataSource, const String& rTableOrQuery, sal_Int32 nCommandType = -1);
 253     sal_uInt32      GetSelectedRecordId(const String& rDataSource, const String& rTableOrQuery, sal_Int32 nCommandType = -1);
 254     BOOL                        GetColumnCnt(const String& rSourceName, const String& rTableName,
 255                             const String& rColumnName, sal_uInt32 nAbsRecordId, long nLanguage,
 256                             String& rResult, double* pNumber);
 257     //create and store or find an already stored connection to a data source for use
 258     //in SwFldMgr and SwDBTreeList
 259     ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection>
 260                     RegisterConnection(::rtl::OUString& rSource);
 261
 262     const SwDSParam* CreateDSData(const SwDBData& rData)
 263                         {return FindDSData(rData, TRUE);}
 264     const SwDSParamArr& GetDSParamArray() const {return aDataSourceParams;}
 265
 266
 267     //close all data sources - after fields were updated
 268     void                        CloseAll(BOOL bIncludingMerge = TRUE);
 269
 270     BOOL            ToNextRecord(const String& rDataSource, const String& rTableOrQuery, sal_Int32 nCommandType = -1);
 271
 272     sal_uInt32          GetSelectedRecordId();
 273     sal_Bool            ToRecordId(sal_Int32 nSet);
 274
 275     const SwDBData&     GetAddressDBName();
 276
 277
 278     static ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection>
 279             GetConnection(const String& rDataSource,
 280                 ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XDataSource>& rxSource);
 281 };
 282
 283 } //namespace binfilter
 284 #endif
 285