extensions/source/abpilot/fieldmappingimpl.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef EXTENSIONS_ABP_FIELDMAPPINGIMPL_HXX
  21 #define EXTENSIONS_ABP_FIELDMAPPINGIMPL_HXX
  22
  23 #include <rtl/ustring.hxx>
  24 #include "abptypes.hxx"
  25 #include <com/sun/star/uno/Reference.hxx>
  26 #include "addresssettings.hxx"
  27
  28 namespace com { namespace sun { namespace star {
  29     namespace lang {
  30         class XMultiServiceFactory;
  31     }
  32     namespace uno {
  33         class XComponentContext;
  34     }
  35     namespace beans {
  36         class XPropertySet;
  37     }
  38 } } }
  39 class Window;
  40
  41 //.........................................................................
  42 namespace abp
  43 {
  44 //.........................................................................
  45
  46     //.....................................................................
  47     namespace fieldmapping
  48     {
  49     //.....................................................................
  50
  51         //-----------------------------------------------------------------
  52         /** invokes the field mapping dialog
  53             @param _rxORB
  54                 service factory to use for creating UNO services
  55             @param _pParent
  56                 window to use as parent for the dialog and error messages
  57             @param _rSettings
  58                 current settings. Upon return, the field mapping member of this
  59                 structure will be filled with the settings the user did in the
  60                 field mapping dialog.
  61         */
  62         sal_Bool invokeDialog(
  63             const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& _rxORB,
  64             class Window* _pParent,
  65             const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxDataSource,
  66             AddressSettings& _rSettings
  67         ) SAL_THROW ( ( ) );
  68
  69         //-----------------------------------------------------------------
  70         /** creates a default field mapping for usage with the address book SDBC driver
  71             <p>The column names as used by the SDBC driver for address books is stored in the configuration,
  72             and this function creates a mapping which uses this configuration information.</p>
  73         */
  74         void defaultMapping(
  75             const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& _rxContext,
  76             MapString2String& /* [out] */ _rFieldAssignment
  77         ) SAL_THROW ( ( ) );
  78
  79         //-----------------------------------------------------------------
  80         /** writes a field mapping for the template document address source
  81         */
  82         void writeTemplateAddressFieldMapping(
  83             const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& _rxContext,
  84             const MapString2String& _rFieldAssignment
  85         ) SAL_THROW ( ( ) );
  86
  87     //.....................................................................
  88     }   // namespace fieldmapping
  89     //.....................................................................
  90
  91     //.....................................................................
  92     namespace addressconfig
  93     {
  94     //.....................................................................
  95
  96         //-----------------------------------------------------------------
  97         /** writes the data source / table name given into the configuration, to where the template documents
  98             expect it.
  99         */
 100         void writeTemplateAddressSource(
 101             const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& _rxContext,
 102             const OUString& _rDataSourceName,
 103             const OUString& _rTableName
 104         ) SAL_THROW ( ( ) );
 105
 106         /** writes the configuration entry which states the pilot has been completed successfully
 107         */
 108         void markPilotSuccess(
 109             const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& _rxContext
 110         ) SAL_THROW ( ( ) );
 111
 112     //.....................................................................
 113     }   // namespace addressconfig
 114     //.....................................................................
 115
 116 //.........................................................................
 117 }   // namespace abp
 118 //.........................................................................
 119
 120 #endif // EXTENSIONS_ABP_FIELDMAPPINGIMPL_HXX
 121
 122 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */