Difference between revisions of "Uno/Cpp/Spec/FreeReference"

From Apache OpenOffice Wiki
< Uno‎ | Cpp‎ | Spec
Jump to: navigation, search
(Renamed to FreeReference.)
m (API: Fixed <code> tag ...)
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
State:  draft          <br>
+
Type: Specification State: Evolving  Availability: URE 1.3 (SRC680_m212)
Type:   specification <br>
+
  
==Free Reference==
+
==Feature==
 +
A free reference, ensuring that the managing environment has always been entered when calling an object.
  
===Feature===
+
==API==
A free reference. Ensuring that the owning environment has always been entered when calling an object.
+
<source lang="cpp">
 
+
cppu/FreeReference.hxx
===API===
+
<pre>
+
cppu/FreeReference.hxx
+
  
 
   template<class T> FreeReference
 
   template<class T> FreeReference
Line 33: Line 30:
  
 
     bool operator != (FreeReference const & rOther) const
 
     bool operator != (FreeReference const & rOther) const
</pre>
+
</source>
 +
 
 +
==Usage Example==
 +
{{:Uno/Cpp/Snippet/FreeReference}}
 +
 
 +
More Examples:
 +
* [[Uno/Cpp/Snippet/Function always returning an appropriate object]]
  
===Dependencies===
+
==Dependencies==
* C++ uno::Environment
+
* [[Uno/Cpp/Spec/Environment]]
* Stacked Environments
+
* [[Uno/Cpp/Spec/Environment Stack]]
  
  
[[Category:Uno:Cpp:Spec]]
+
[[Category:Evolving]]
[[Category:Uno:draft]]
+
[[Category:Spec]]
 +
[[Category:Uno]]
 +
[[Category:Uno:Cpp]]

Latest revision as of 12:32, 12 March 2009

Type: Specification State: Evolving Availability: URE 1.3 (SRC680_m212)

Feature

A free reference, ensuring that the managing environment has always been entered when calling an object.

API

cppu/FreeReference.hxx
 
  template<class T> FreeReference
    FreeReference() {}
    FreeReference(cssuno::Reference<T> const & xRef)
    FreeReference(EnvAwareReference<T> const & rOther)
 
    cssuno::Reference<T> get() const throw (cssuno::RuntimeException)
 
    operator cssuno::Reference<T> () const throw (cssuno::RuntimeException)
 
    T * operator -> () const throw (cssuno::RuntimeException)
 
    bool is() const throw (cssuno::RuntimeException)
 
    void clear()
 
    FreeReference<T> & operator = (FreeReference<T> const & rOther)
 
    void set(cssuno::Reference<T> const & xRef)
 
    bool operator == (FreeReference const & rOther) const
 
    bool operator != (FreeReference const & rOther) const

Usage Example

#include <cppu/EnvGuards.hxx>
...
{ 
  com::sun::star::uno::Reference<XFoo> ref(...)
  ...
  cppu::FreeReference<XFoo> free_xFoo(xFoo);
  cppu::EnvGuard otherEnv(cppu::Environment("just another env"));
 
  free_xFoo->doSomething(); // the free reference ensures that the correct environment etc. gets activated before invokation
  ...
}

More Examples:

Dependencies

Personal tools