LibreOffice
LibreOffice 5.3 SDK C/C++ API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
com::sun::star::uno::Mapping Class Reference

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

#include <mapping.hxx>

Public Member Functions

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

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() 
)
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() 
)
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() 
)
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 = NULL)
inline

Constructor.

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

Copy constructor.

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

Destructor.

Member Function Documentation

void com::sun::star::uno::Mapping::clear ( )
inline

Releases a set mapping.

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

Provides a pointer to the C mapping.

The returned mapping is NOT acquired!

Returns
UNacquired C mapping
bool com::sun::star::uno::Mapping::is ( ) const
inline

Tests if a mapping is set.

Returns
true if a mapping is set
void * com::sun::star::uno::Mapping::mapInterface ( void *  pInterface,
typelib_InterfaceTypeDescription pTypeDescr 
) const
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,
typelib_TypeDescription pTypeDescr 
) const
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 css::uno::Type &  rType 
) const
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,
typelib_InterfaceTypeDescription pTypeDescr 
) const
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
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,
const css::uno::Type &  rType 
) const
inline

Maps an interface from one environment to another.

Parameters
ppOutinout mapped interface
pInterfacesource interface
rTypetype of interface to be mapped
Mapping & com::sun::star::uno::Mapping::operator= ( uno_Mapping pMapping)
inline

Sets a given mapping.

Parameters
pMappinganother mapping
Returns
this mapping
Mapping& com::sun::star::uno::Mapping::operator= ( const Mapping rMapping)
inline

Sets a given mapping.

Parameters
rMappinganother mapping
Returns
this mapping

The documentation for this class was generated from the following file: