Difference between revisions of "Uno/Cpp/Spec/Mapping"
From Apache OpenOffice Wiki
m (Splitted categories.) |
|||
Line 150: | Line 150: | ||
− | [[Category:Uno: | + | [[Category:Spec]] |
+ | [[Category:Uno]] | ||
+ | [[Category:Uno:Cpp]] |
Latest revision as of 08:24, 29 November 2006
Type: Specification State: final
Feature
Accessing mappings in C++.
API
[cpp]
uno/mapping.hxx
namespace = com::sun::star::uno;
class Mapping { public: /** Holds a mapping from the specified source to the specified destination by environment type names. @param rFrom type name of source environment @param rTo type name of destination environment @param rAddPurpose additional purpose */ inline Mapping( const ::rtl::OUString & rFrom, const ::rtl::OUString & rTo, const ::rtl::OUString & rAddPurpose = ::rtl::OUString() ) SAL_THROW( () );
/** Holds a mapping from the specified source to the specified destination. @param pFrom source environment @param pTo destination environment @param rAddPurpose additional purpose */ inline Mapping( uno_Environment * pFrom, uno_Environment * pTo, const ::rtl::OUString & rAddPurpose = ::rtl::OUString() ) SAL_THROW( () );
/** Holds a mapping from the specified source to the specified destination environment.
@param from source environment @param to destination environment @param rAddPurpose additional purpose
@since UDK ???? - yet to come */ inline Mapping( const Environment & rFrom, const Environment & rTo, const ::rtl::OUString & rAddPurpose = ::rtl::OUString() ) SAL_THROW( () );
/** Constructor. @param pMapping another mapping */ inline Mapping( uno_Mapping * pMapping = 0 ) SAL_THROW( () );
/** Copy constructor. @param rMapping another mapping */ inline Mapping( const Mapping & rMapping ) SAL_THROW( () );
/** Destructor. */ inline ~Mapping() SAL_THROW( () );
/** Sets a given mapping. @param pMapping another mapping @return this mapping */ inline Mapping & SAL_CALL operator = ( uno_Mapping * pMapping ) SAL_THROW( () );
/** Sets a given mapping. @param rMapping another mapping @return this mapping */ inline Mapping & SAL_CALL operator = ( const Mapping & rMapping ) SAL_THROW( () );
/** Provides a pointer to the C mapping. The returned mapping is NOT acquired! @return UNacquired C mapping */ inline uno_Mapping * SAL_CALL get() const SAL_THROW( () );
/** Tests if a mapping is set. @return true if a mapping is set */ inline sal_Bool SAL_CALL is() const SAL_THROW( () );
/** Releases a set mapping. */ inline void SAL_CALL clear() SAL_THROW( () );
/** Maps an interface from one environment to another. @param pInterface source interface @param pTypeDescr type description of interface @return mapped interface */ inline void * SAL_CALL mapInterface( void * pInterface, typelib_InterfaceTypeDescription * pTypeDescr ) const SAL_THROW( () );
/** Maps an interface from one environment to another. @param pInterface source interface @param pTypeDescr type description of interface @return mapped interface */ inline void * SAL_CALL mapInterface( void * pInterface, typelib_TypeDescription * pTypeDescr ) const SAL_THROW( () );
/** Maps an interface from one environment to another. @param pInterface source interface @param rType type of interface @return mapped interface */ inline void * SAL_CALL mapInterface(void * pInterface, const ::com::sun::star::uno::Type & rType ) const SAL_THROW( () );
/** Maps an interface from one environment to another. @param ppOut inout mapped interface @param pInterface source interface @param pTypeDescr type description of interface */ inline void SAL_CALL mapInterface( void ** ppOut, void * pInterface, typelib_InterfaceTypeDescription * pTypeDescr ) const SAL_THROW( () );
/** Maps an interface from one environment to another. @param ppOut inout mapped interface @param pInterface source interface @param pTypeDescr type description of interface */ inline void SAL_CALL mapInterface( void ** ppOut, void * pInterface, typelib_TypeDescription * pTypeDescr ) const SAL_THROW( () );
/** Maps an interface from one environment to another. @param ppOut inout mapped interface @param pInterface source interface @param rType type of interface to be mapped */ inline void SAL_CALL mapInterface( void ** ppOut, void * pInterface, const ::com::sun::star::uno::Type & rType ) const SAL_THROW( () );
};