<html> <head> <title>class Reference</title> <link rel="stylesheet" type="text/css" href="../../../../../cpp.css"> </head> <body> <div id="adc-cppref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="1" cellspacing="0"> <tr align="center" valign="top"> <td class="navimain"> <a href="../../../../../index.html">Overview</a> </td> <td class="navimain"> <a href="index.html">Namespace</a> </td> <td class="navimainself"> Class </td> <td class="navimain"> <a href="../../../../../index-files/index-1.html">Index</a> </td> <td class="navimain"> <a href="../../../../../help.html">Help</a> </td> </tr> </table> <table class="navisub" cellpadding="0" cellspacing="3"> <tr> <td width="20%"><font size="-2">PUBLIC MEMBERS:</font></td> <td> <font size="-2">CLASSES</font> | <font size="-2">STRUCTS</font> | <font size="-2">UNIONS</font> | <font size="-2">ENUMS</font> | <font size="-2">TYPEDEFS</font> | <a href="#publ_ops"><font size="-2"><b>METHODS</b></font></a> | <a href="#publ_static_ops"><font size="-2"><b>STATIC METHODS</b></font></a> | <font size="-2">DATA</font> | <font size="-2">STATIC DATA</font></td> </tr> <tr> <td width="20%"><font size="-2">PRIVATE MEMBERS:</font></td> <td> <font size="-2">CLASSES</font> | <font size="-2">STRUCTS</font> | <font size="-2">UNIONS</font> | <font size="-2">ENUMS</font> | <font size="-2">TYPEDEFS</font> | <font size="-2">METHODS</font> | <a href="#priv_static_ops"><font size="-2"><b>STATIC METHODS</b></font></a> | <font size="-2">DATA</font> | <font size="-2">STATIC DATA</font></td> </tr> </table> <hr> <a href="../../../../../names/index.html" alt="Global Namespace in C++"><font size="+1"><b>::</b></font></a> <a href="../../../index.html" alt="namespace"><font size="+1"><b>com</b></font></a><font size="+1"> :: </font><a href="../../index.html" alt="namespace"><font size="+1"><b>sun</b></font></a><font size="+1"> :: </font><a href="../index.html" alt="namespace"><font size="+1"><b>star</b></font></a><font size="+1"> :: </font><a href="index.html" alt="namespace"><font size="+1"><b>uno</b></font></a><font size="+1"> :: </font><br> <p><strong>template< typename interface_type ></strong></p> <div class="title"><h2>class Reference</h2> </div><hr> <dl> <dt>Base Classes</dt> <dd><pre style="font-family:monospace;"> <span class="btpubl"><a href="c-BaseReference.html">BaseReference</a> (public)</span> | +--<span class="btself">Reference</span> </pre></dd> </dl> <dl> <dt>Known Derived Classes</dt> <dd>None.</dd> </dl> <br> <table class="flag-table" border="1" cellspacing="0"> <tr> <td width="25%" class="flagname">virtual</td> <td width="25%" class="flagname">abstract</td> <td width="25%" class="flagname">interface</td> <td width="25%" class="flagname">template</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <dl> <dt>Description</dt> <dd>Template reference class for interface type derived from BaseReference. A special constructor given the UNO_QUERY or UNO_REF_QUERY identifier queries interfaces for reference type. </dd> </dl> <dl> <dt>File</dt> <dd>Reference.h</dd> </dl> <hr> <dl> <dt class="subtitle"><a name="publ_"><h3>Public Members</h3> </a></dt> <dd><a name="publ_ops"> </a><table class="childlist" border="1" cellpadding="5" cellspacing="0" width="100%"> <tr class="subtitle"> <td colspan="2"><h4>Methods</h4> </td> </tr> <tr> <td> <br> <a href="Reference/o.html#~Reference-2661">~Reference</a>( ) throw( );</td> <td width="50%"> Destructor: Releases interface if set. </td> </tr> <tr> <td> <br> <a href="Reference/o.html#Reference-2662">Reference</a>( ) throw( );</td> <td width="50%"> Default Constructor: Sets null reference. </td> </tr> <tr> <td> <br> <a href="Reference/o.html#Reference-2663">Reference</a>( const Reference< interface_type > & rRef ) throw( );</td> <td width="50%"> Copy constructor: Copies interface reference. </td> </tr> <tr> <td> <br> <a href="Reference/o.html#Reference-2664">Reference</a>( interface_type * pInterface ) throw( );</td> <td width="50%"> Constructor: Sets given interface pointer. </td> </tr> <tr> <td> <br> <a href="Reference/o.html#Reference-2665">Reference</a>( interface_type * pInterface, __sal_NoAcquire ) throw( );</td> <td width="50%"> Constructor: Sets given interface pointer without acquiring it. </td> </tr> <tr> <td> <br> <a href="Reference/o.html#Reference-2666">Reference</a>( interface_type * pInterface, UnoReference_NoAcquire ) throw( );</td> <td width="50%"> Constructor: Sets given interface pointer without acquiring it. Deprecated, please use SAL_NO_ACQUIRE version. </td> </tr> <tr> <td> <br> <a href="Reference/o.html#Reference-2667">Reference</a>( const BaseReference & rRef, UnoReference_Query ) throw( RuntimeException );</td> <td width="50%"> Constructor: Queries given interface for reference interface type (interface_type). </td> </tr> <tr> <td> <br> <a href="Reference/o.html#Reference-2668">Reference</a>( XInterface * pInterface, UnoReference_Query ) throw( RuntimeException );</td> <td width="50%"> Constructor: Queries given interface for reference interface type (interface_type). </td> </tr> <tr> <td> <br> <a href="Reference/o.html#Reference-2669">Reference</a>( const Any & rAny, UnoReference_Query ) throw( RuntimeException );</td> <td width="50%"> Constructor: Queries given any for reference interface type (interface_type). </td> </tr> <tr> <td> <br> <a href="Reference/o.html#Reference-2670">Reference</a>( const BaseReference & rRef, UnoReference_QueryThrow ) throw( RuntimeException );</td> <td width="50%"> Constructor: Queries given interface for reference interface type (interface_type). Throws a RuntimeException if the demanded interface cannot be queried. </td> </tr> <tr> <td> <br> <a href="Reference/o.html#Reference-2671">Reference</a>( XInterface * pInterface, UnoReference_QueryThrow ) throw( RuntimeException );</td> <td width="50%"> Constructor: Queries given interface for reference interface type (interface_type). Throws a RuntimeException if the demanded interface cannot be queried. </td> </tr> <tr> <td> <br> <a href="Reference/o.html#Reference-2672">Reference</a>( const Any & rAny, UnoReference_QueryThrow ) throw( RuntimeException );</td> <td width="50%"> Constructor: Queries given any for reference interface type (interface_type). Throws a RuntimeException if the demanded interface cannot be queried. </td> </tr> <tr> <td> <br> <a href="Reference/o.html#Reference-2673">Reference</a>( const Reference< interface_type > & rRef, UnoReference_SetThrow ) throw( RuntimeException );</td> <td width="50%"> Constructor: assigns from the given interface of the same type. Throws a RuntimeException if the source interface is <NULL/>. </td> </tr> <tr> <td> <br> <a href="Reference/o.html#Reference-2674">Reference</a>( interface_type * pInterface, UnoReference_SetThrow ) throw( RuntimeException );</td> <td width="50%"> Constructor: assigns from the given interface of the same type. Throws a RuntimeException if the source interface is <NULL/>. </td> </tr> <tr> <td> <br> <a href="Reference/o.html#operator const Reference< XInterface > &-2675">operator const Reference< XInterface > &</a>( ) const throw( );</td> <td width="50%"> </td> </tr> <tr> <td>interface_type * <br> <a href="Reference/o.html#operator->-2676">operator-></a>( ) const throw( );</td> <td width="50%"> Dereference operator: Used to call interface methods. </td> </tr> <tr> <td>interface_type * <br> <a href="Reference/o.html#get-2677">get</a>( ) const throw( );</td> <td width="50%"> Gets interface pointer. This call does not acquire the interface. </td> </tr> <tr> <td>void <br> <a href="Reference/o.html#clear-2678">clear</a>( ) throw( );</td> <td width="50%"> Clears reference, i.e. releases interface. Reference is null after clear() call. </td> </tr> <tr> <td>sal_Bool <br> <a href="Reference/o.html#set-2679">set</a>( const Reference< interface_type > & rRef ) throw( );</td> <td width="50%"> Sets the given interface. An interface already set will be released. </td> </tr> <tr> <td>sal_Bool <br> <a href="Reference/o.html#set-2680">set</a>( interface_type * pInterface ) throw( );</td> <td width="50%"> Sets the given interface. An interface already set will be released. </td> </tr> <tr> <td>sal_Bool <br> <a href="Reference/o.html#set-2681">set</a>( interface_type * pInterface, __sal_NoAcquire ) throw( );</td> <td width="50%"> Sets interface pointer without acquiring it. An interface already set will be released. </td> </tr> <tr> <td>sal_Bool <br> <a href="Reference/o.html#set-2682">set</a>( interface_type * pInterface, UnoReference_NoAcquire ) throw( );</td> <td width="50%"> Sets interface pointer without acquiring it. An interface already set will be released. Deprecated, please use SAL_NO_ACQUIRE version. </td> </tr> <tr> <td>sal_Bool <br> <a href="Reference/o.html#set-2683">set</a>( XInterface * pInterface, UnoReference_Query ) throw( RuntimeException );</td> <td width="50%"> Queries given interface for reference interface type (interface_type) and sets it. An interface already set will be released. </td> </tr> <tr> <td>sal_Bool <br> <a href="Reference/o.html#set-2684">set</a>( const BaseReference & rRef, UnoReference_Query ) throw( RuntimeException );</td> <td width="50%"> Queries given interface for reference interface type (interface_type) and sets it. An interface already set will be released. </td> </tr> <tr> <td>bool <br> <a href="Reference/o.html#set-2685">set</a>( const Any & rAny, UnoReference_Query );</td> <td width="50%"> Queries given any for reference interface type (interface_type) and sets it. An interface already set will be released. </td> </tr> <tr> <td>void <br> <a href="Reference/o.html#set-2686">set</a>( XInterface * pInterface, UnoReference_QueryThrow ) throw( RuntimeException );</td> <td width="50%"> </td> </tr> <tr> <td>void <br> <a href="Reference/o.html#set-2687">set</a>( const BaseReference & rRef, UnoReference_QueryThrow ) throw( RuntimeException );</td> <td width="50%"> </td> </tr> <tr> <td>void <br> <a href="Reference/o.html#set-2688">set</a>( const Any & rAny, UnoReference_QueryThrow );</td> <td width="50%"> </td> </tr> <tr> <td>void <br> <a href="Reference/o.html#set-2689">set</a>( interface_type * pInterface, UnoReference_SetThrow ) throw( RuntimeException );</td> <td width="50%"> </td> </tr> <tr> <td>void <br> <a href="Reference/o.html#set-2690">set</a>( const Reference< interface_type > & rRef, UnoReference_SetThrow ) throw( RuntimeException );</td> <td width="50%"> </td> </tr> <tr> <td>Reference< interface_type > & <br> <a href="Reference/o.html#operator=-2691">operator=</a>( interface_type * pInterface ) throw( );</td> <td width="50%"> Assignment operator: Acquires given interface pointer and sets reference. An interface already set will be released. </td> </tr> <tr> <td>Reference< interface_type > & <br> <a href="Reference/o.html#operator=-2692">operator=</a>( const Reference< interface_type > & rRef ) throw( );</td> <td width="50%"> Assignment operator: Acquires given interface reference and sets reference. An interface already set will be released. </td> </tr> </table> <hr> <a name="publ_static_ops"> </a><table class="childlist" border="1" cellpadding="5" cellspacing="0" width="100%"> <tr class="subtitle"> <td colspan="2"><h4>Static Methods</h4> </td> </tr> <tr> <td>static Reference< interface_type > <br> <a href="Reference/o.html#query-2693">query</a>( const BaseReference & rRef ) throw( RuntimeException );</td> <td width="50%"> Queries given interface reference for type interface_type. </td> </tr> <tr> <td>static Reference< interface_type > <br> <a href="Reference/o.html#query-2694">query</a>( XInterface * pInterface ) throw( RuntimeException );</td> <td width="50%"> Queries given interface for type interface_type. </td> </tr> </table> <hr> </dd> </dl> <dl> <dt class="subtitle"><a name="priv_"><h3>Private Members</h3> </a></dt> <dd><a name="priv_static_ops"> </a><table class="childlist" border="1" cellpadding="5" cellspacing="0" width="100%"> <tr class="subtitle"> <td colspan="2"><h4>Static Methods</h4> </td> </tr> <tr> <td>static XInterface * <br> <a href="Reference/o.html#iquery-2652">iquery</a>( XInterface * pInterface ) throw( RuntimeException );</td> <td width="50%"> Queries given interface for type interface_type. </td> </tr> <tr> <td>static XInterface * <br> <a href="Reference/o.html#iquery_throw-2653">iquery_throw</a>( XInterface * pInterface ) throw( RuntimeException );</td> <td width="50%"> Queries given interface for type interface_type. Throws a RuntimeException if the demanded interface cannot be queried. </td> </tr> <tr> <td>static interface_type * <br> <a href="Reference/o.html#iset_throw-2654">iset_throw</a>( interface_type * pInterface ) throw( RuntimeException );</td> <td width="50%"> Returns the given interface if it is not <NULL/>, throws a RuntimeException otherwise. </td> </tr> <tr> <td>static interface_type * <br> <a href="Reference/o.html#castFromXInterface-2655">castFromXInterface</a>( XInterface * p );</td> <td width="50%"> Cast from an "interface pointer" (e.g., BaseReference::_pInterface) to a pointer to this interface_type. </td> </tr> <tr> <td>static XInterface * <br> <a href="Reference/o.html#castToXInterface-2656">castToXInterface</a>( interface_type * p );</td> <td width="50%"> Cast from a pointer to this interface_type to an "interface pointer" (e.g., BaseReference::_pInterface). </td> </tr> </table> <hr> </dd> </dl> <a href="#_top_" class="objchapter">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-cppref" --> </body> </html>
