/************************************************************** * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * *************************************************************/ #ifndef EXTENSIONS_ABP_FIELDMAPPINGIMPL_HXX #define EXTENSIONS_ABP_FIELDMAPPINGIMPL_HXX #include <rtl/ustring.hxx> #include "abptypes.hxx" #include <com/sun/star/uno/Reference.hxx> #include "addresssettings.hxx" namespace com { namespace sun { namespace star { namespace lang { class XMultiServiceFactory; } namespace beans { class XPropertySet; } } } } class Window; //......................................................................... namespace abp { //......................................................................... //..................................................................... namespace fieldmapping { //..................................................................... //----------------------------------------------------------------- /** invokes the field mapping dialog @param _rxORB service factory to use for creating UNO services @param _pParent window to use as parent for the dialog and error messages @param _rSettings current settings. Upon return, the field mapping member of this structure will be filled with the settings the user did in the field mapping dialog. */ sal_Bool invokeDialog( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxORB, class Window* _pParent, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxDataSource, AddressSettings& _rSettings ) SAL_THROW ( ( ) ); //----------------------------------------------------------------- /** creates a default field mapping for usage with the address book SDBC driver <p>The column names as used by the SDBC driver for address books is stored in the configuration, and this function creates a mapping which uses this configuration information.</p> */ void defaultMapping( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxORB, MapString2String& /* [out] */ _rFieldAssignment ) SAL_THROW ( ( ) ); //----------------------------------------------------------------- /** writes a field mapping for the template document address source */ void writeTemplateAddressFieldMapping( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxORB, const MapString2String& _rFieldAssignment ) SAL_THROW ( ( ) ); //..................................................................... } // namespace fieldmapping //..................................................................... //..................................................................... namespace addressconfig { //..................................................................... //----------------------------------------------------------------- /** writes the data source / table name given into the configuration, to where the template documents expect it. */ void writeTemplateAddressSource( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxORB, const ::rtl::OUString& _rDataSourceName, const ::rtl::OUString& _rTableName ) SAL_THROW ( ( ) ); /** writes the configuration entry which states the pilot has been completed successfully */ void markPilotSuccess( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxORB ) SAL_THROW ( ( ) ); //..................................................................... } // namespace addressconfig //..................................................................... //......................................................................... } // namespace abp //......................................................................... #endif // EXTENSIONS_ABP_FIELDMAPPINGIMPL_HXX