UDK 3.2.7 C/C++ API Reference
Public Member Functions
com::sun::star::uno::Mapping Class Reference

C++ wrapper for C uno_Mapping. More...

#include <mapping.hxx>

List of all members.

Public Member Functions

 Mapping (const ::rtl::OUString &rFrom, const ::rtl::OUString &rTo, const ::rtl::OUString &rAddPurpose=::rtl::OUString()) throw ()
 Holds a mapping from the specified source to the specified destination by environment type names.
 Mapping (uno_Environment *pFrom, uno_Environment *pTo, const ::rtl::OUString &rAddPurpose=::rtl::OUString()) throw ()
 Holds a mapping from the specified source to the specified destination.
 Mapping (const Environment &rFrom, const Environment &rTo, const ::rtl::OUString &rAddPurpose=::rtl::OUString()) throw ()
 Holds a mapping from the specified source to the specified destination environment.
 Mapping (uno_Mapping *pMapping=0) throw ()
 Constructor.
 Mapping (const Mapping &rMapping) throw ()
 Copy constructor.
 ~Mapping () throw ()
 Destructor.
Mappingoperator= (uno_Mapping *pMapping) throw ()
 Sets a given mapping.
Mappingoperator= (const Mapping &rMapping) throw ()
 Sets a given mapping.
uno_Mappingget () const throw ()
 Provides a pointer to the C mapping.
sal_Bool is () const throw ()
 Tests if a mapping is set.
void clear () throw ()
 Releases a set mapping.
void * mapInterface (void *pInterface, typelib_InterfaceTypeDescription *pTypeDescr) const throw ()
 Maps an interface from one environment to another.
void * mapInterface (void *pInterface, typelib_TypeDescription *pTypeDescr) const throw ()
 Maps an interface from one environment to another.
void * mapInterface (void *pInterface, const ::com::sun::star::uno::Type &rType) const throw ()
 Maps an interface from one environment to another.
void mapInterface (void **ppOut, void *pInterface, typelib_InterfaceTypeDescription *pTypeDescr) const throw ()
 Maps an interface from one environment to another.
void mapInterface (void **ppOut, void *pInterface, typelib_TypeDescription *pTypeDescr) const throw ()
 Maps an interface from one environment to another.
void mapInterface (void **ppOut, void *pInterface, const ::com::sun::star::uno::Type &rType) const throw ()
 Maps an interface from one environment to another.

Detailed Description

C++ wrapper for C uno_Mapping.

See also:
uno_Mapping

Constructor & Destructor Documentation

com::sun::star::uno::Mapping::Mapping ( const ::rtl::OUString rFrom,
const ::rtl::OUString rTo,
const ::rtl::OUString rAddPurpose = ::rtl::OUString() 
) throw () [inline]

Holds a mapping from the specified source to the specified destination by environment type names.

Parameters:
rFromtype name of source environment
rTotype name of destination environment
rAddPurposeadditional purpose
com::sun::star::uno::Mapping::Mapping ( uno_Environment pFrom,
uno_Environment pTo,
const ::rtl::OUString rAddPurpose = ::rtl::OUString() 
) throw () [inline]

Holds a mapping from the specified source to the specified destination.

Parameters:
pFromsource environment
pTodestination environment
rAddPurposeadditional purpose
com::sun::star::uno::Mapping::Mapping ( const Environment rFrom,
const Environment rTo,
const ::rtl::OUString rAddPurpose = ::rtl::OUString() 
) throw () [inline]

Holds a mapping from the specified source to the specified destination environment.

Parameters:
rFromsource environment
rTodestination environment
rAddPurposeadditional purpose
com::sun::star::uno::Mapping::Mapping ( uno_Mapping pMapping = 0) throw () [inline]

Constructor.

Parameters:
pMappinganother mapping
com::sun::star::uno::Mapping::Mapping ( const Mapping rMapping) throw () [inline]

Copy constructor.

Parameters:
rMappinganother mapping
com::sun::star::uno::Mapping::~Mapping ( ) throw () [inline]

Destructor.


Member Function Documentation

void com::sun::star::uno::Mapping::clear ( ) throw () [inline]

Releases a set mapping.

uno_Mapping* com::sun::star::uno::Mapping::get ( ) const throw () [inline]

Provides a pointer to the C mapping.

The returned mapping is NOT acquired!

Returns:
UNacquired C mapping
sal_Bool com::sun::star::uno::Mapping::is ( ) const throw () [inline]

Tests if a mapping is set.

Returns:
true if a mapping is set
void com::sun::star::uno::Mapping::mapInterface ( void **  ppOut,
void *  pInterface,
typelib_InterfaceTypeDescription pTypeDescr 
) const throw () [inline]

Maps an interface from one environment to another.

Parameters:
ppOutinout mapped interface
pInterfacesource interface
pTypeDescrtype description of interface
void com::sun::star::uno::Mapping::mapInterface ( void **  ppOut,
void *  pInterface,
typelib_TypeDescription pTypeDescr 
) const throw () [inline]

Maps an interface from one environment to another.

Parameters:
ppOutinout mapped interface
pInterfacesource interface
pTypeDescrtype description of interface
void* com::sun::star::uno::Mapping::mapInterface ( void *  pInterface,
typelib_TypeDescription pTypeDescr 
) const throw () [inline]

Maps an interface from one environment to another.

Parameters:
pInterfacesource interface
pTypeDescrtype description of interface
Returns:
mapped interface
void * com::sun::star::uno::Mapping::mapInterface ( void *  pInterface,
const ::com::sun::star::uno::Type rType 
) const throw () [inline]

Maps an interface from one environment to another.

Parameters:
pInterfacesource interface
rTypetype of interface
Returns:
mapped interface
void com::sun::star::uno::Mapping::mapInterface ( void **  ppOut,
void *  pInterface,
const ::com::sun::star::uno::Type rType 
) const throw () [inline]

Maps an interface from one environment to another.

Parameters:
ppOutinout mapped interface
pInterfacesource interface
rTypetype of interface to be mapped
void * com::sun::star::uno::Mapping::mapInterface ( void *  pInterface,
typelib_InterfaceTypeDescription pTypeDescr 
) const throw () [inline]

Maps an interface from one environment to another.

Parameters:
pInterfacesource interface
pTypeDescrtype description of interface
Returns:
mapped interface
Mapping& com::sun::star::uno::Mapping::operator= ( const Mapping rMapping) throw () [inline]

Sets a given mapping.

Parameters:
rMappinganother mapping
Returns:
this mapping
Mapping & com::sun::star::uno::Mapping::operator= ( uno_Mapping pMapping) throw () [inline]

Sets a given mapping.

Parameters:
pMappinganother mapping
Returns:
this mapping

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines