Uno/Cpp/Spec/Environment

Type: Specification State: final

Feature

Accessing environemts in C++.

API

uno/environment.hxx

  namespace = com::sun::star::uno;
  class Environment
  {
public:
    /** Constructor: acquires given environment

        @param pEnv environment
    */
    inline Environment( uno_Environment * pEnv = 0 ) SAL_THROW( () );
	
    /** Gets a specific environment. If the specified environment does not exist, then a default one
        is created and registered.

        @param envTypeName  type name of the environment
        @param pContext     context pointer

        @since URE ???? - yet to come!
    */
    inline Environment( rtl::OUString const & envEypeName, void * pContext = NULL ) SAL_THROW( () );

    /** Copy constructor: acquires given environment
        
        @param rEnv another environment
    */
    inline Environment( const Environment & rEnv ) SAL_THROW( () );

    /** Destructor: releases a set environment.
    */
    inline ~Environment() SAL_THROW( () );
	
    /** Sets a given environment, i.e. acquires given one and releases a set one.
        
        @param pEnv  another environment
        @return      this environment
    */
    inline Environment & SAL_CALL operator = ( uno_Environment * pEnv ) SAL_THROW( () );

    /** Sets a given environment, i.e. acquires given one and releases a set one.
        
        @param rEnv   another environment
        @return this  environment
    */
    inline Environment & SAL_CALL operator = ( const Environment & rEnv ) SAL_THROW( () );
	
    /** Provides UNacquired pointer to the set C environment.
        
        @return UNacquired pointer to the C environment struct
    */
    inline uno_Environment * SAL_CALL get() const SAL_THROW( () );
	
    /** Gets type name of set environment.
        
        @return type name of set environment
    */
    inline ::rtl::OUString SAL_CALL getTypeName() const SAL_THROW( () );

    /** Gets free context pointer of set environment.
        
        @return  free context pointer of set environment
    */
    inline void * SAL_CALL getContext() const SAL_THROW( () );
	
    /** Tests if a environment is set.
        
        @return  true, if a environment is set, false otherwise
    */
    inline sal_Bool SAL_CALL is() const SAL_THROW( () );
	
    /** Releases a set environment.
    */
    inline void SAL_CALL clear() SAL_THROW( () );
};

Dependencies

• Uno/Binary/Spec/Environment