Files
libreoffice/extensions/source/abpilot/fieldmappingimpl.hxx
Jens-Heiner Rechtien 67d167539c INTEGRATION: CWS dba201b (1.2.470); FILE MERGED
2005/09/21 06:41:37 oj 1.2.470.2: RESYNC: (1.2-1.3); FILE MERGED
2005/07/18 10:51:13 fs 1.2.470.1: #i51833# also pass the XDataSource object around - the field mapping dialog needs it, since the data source is not registered at the database context
2005-09-23 11:49:35 +00:00

143 lines
5.7 KiB
C++

/*************************************************************************
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: fieldmappingimpl.hxx,v $
*
* $Revision: 1.4 $
*
* last change: $Author: hr $ $Date: 2005-09-23 12:49:35 $
*
* The Contents of this file are made available subject to
* the terms of GNU Lesser General Public License Version 2.1.
*
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2005 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
************************************************************************/
#ifndef EXTENSIONS_ABP_FIELDMAPPINGIMPL_HXX
#define EXTENSIONS_ABP_FIELDMAPPINGIMPL_HXX
#ifndef _RTL_USTRING_HXX_
#include <rtl/ustring.hxx>
#endif
#ifndef EXTENSIONS_ABP_ABPTYPES_HXX
#include "abptypes.hxx"
#endif
#ifndef _COM_SUN_STAR_UNO_REFERENCE_HXX_
#include <com/sun/star/uno/Reference.hxx>
#endif
#ifndef EXTENSIONS_ABP_ADDRESSSETTINGS_HXX
#include "addresssettings.hxx"
#endif
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 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