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 INCLUDED_EXTENSIONS_SOURCE_ABPILOT_FIELDMAPPINGIMPL_HXX
  21 #define INCLUDED_EXTENSIONS_SOURCE_ABPILOT_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 namespace vcl { class Window; }
  40
  41
  42 namespace abp
  43 {
  44
  45
  46     namespace fieldmapping
  47     {
  48
  49
  50         /** invokes the field mapping dialog
  51             @param _rxORB
  52                 service factory to use for creating UNO services
  53             @param _pParent
  54                 window to use as parent for the dialog and error messages
  55             @param _rSettings
  56                 current settings. Upon return, the field mapping member of this
  57                 structure will be filled with the settings the user did in the
  58                 field mapping dialog.
  59         */
  60         bool invokeDialog(
  61             const css::uno::Reference< css::uno::XComponentContext >& _rxORB,
  62             class vcl::Window* _pParent,
  63             const css::uno::Reference< css::beans::XPropertySet >& _rxDataSource,
  64             AddressSettings& _rSettings
  65         );
  66
  67
  68         /** creates a default field mapping for usage with the address book SDBC driver
  69             <p>The column names as used by the SDBC driver for address books is stored in the configuration,
  70             and this function creates a mapping which uses this configuration information.</p>
  71         */
  72         void defaultMapping(
  73             const css::uno::Reference< css::uno::XComponentContext >& _rxContext,
  74             MapString2String& /* [out] */ _rFieldAssignment
  75         );
  76
  77
  78         /** writes a field mapping for the template document address source
  79         */
  80         void writeTemplateAddressFieldMapping(
  81             const css::uno::Reference< css::uno::XComponentContext >& _rxContext,
  82             const MapString2String& _rFieldAssignment
  83         );
  84
  85
  86     }   // namespace fieldmapping
  87
  88
  89     namespace addressconfig
  90     {
  91
  92
  93         /** writes the data source / table name given into the configuration, to where the template documents
  94             expect it.
  95         */
  96         void writeTemplateAddressSource(
  97             const css::uno::Reference< css::uno::XComponentContext >& _rxContext,
  98             const OUString& _rDataSourceName,
  99             const OUString& _rTableName
 100         );
 101
 102         /** writes the configuration entry which states the pilot has been completed successfully
 103         */
 104         void markPilotSuccess(
 105             const css::uno::Reference< css::uno::XComponentContext >& _rxContext
 106         );
 107
 108
 109     }   // namespace addressconfig
 110
 111
 112 }   // namespace abp
 113
 114
 115 #endif // INCLUDED_EXTENSIONS_SOURCE_ABPILOT_FIELDMAPPINGIMPL_HXX
 116
 117 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */