(incubating) | The Free and Open Productivity Suite
Announcing Apache OpenOffice 3.4
 Overview   Namespace   Class   Index   Help 
PUBLIC MEMBERS:  CLASSES | STRUCTS | UNIONS | ENUMS | TYPEDEFS | METHODS | STATIC METHODS | DATA | STATIC DATA
PRIVATE MEMBERS:  CLASSES | STRUCTS | UNIONS | ENUMS | TYPEDEFS | METHODS | STATIC METHODS | DATA | STATIC DATA
:: com :: sun :: star :: uno ::

template< typename interface_type >

class Reference

Base Classes
BaseReference (public)
  |  
  +--Reference
Known Derived Classes
None.

virtual abstract interface template
NO NO NO YES
Description
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.
File
Reference.h

Public Members

Methods

~Reference( ) throw( );		 Destructor: Releases interface if set.

Reference( ) throw( );		 Default Constructor: Sets null reference.

Reference( const Reference< interface_type > & rRef ) throw( );		 Copy constructor: Copies interface reference.

Reference( interface_type * pInterface ) throw( );		 Constructor: Sets given interface pointer.

Reference( interface_type * pInterface, __sal_NoAcquire ) throw( );		 Constructor: Sets given interface pointer without acquiring it.

Reference( interface_type * pInterface, __UnoReference_NoAcquire ) throw( );		 Constructor: Sets given interface pointer without acquiring it. Deprecated, please use SAL_NO_ACQUIRE version.

Reference( const BaseReference & rRef, __UnoReference_Query ) throw( RuntimeException );		 Constructor: Queries given interface for reference interface type (interface_type).

Reference( XInterface * pInterface, __UnoReference_Query ) throw( RuntimeException );		 Constructor: Queries given interface for reference interface type (interface_type).

Reference( const Any & rAny, __UnoReference_Query ) throw( RuntimeException );		 Constructor: Queries given any for reference interface type (interface_type).

operator const Reference< XInterface > &( ) const throw( );
interface_type *
operator->( ) const throw( );		 Dereference operator: Used to call interface methods.
interface_type *
get( ) const throw( );		 Gets interface pointer. This call does not acquire the interface.
void
clear( ) throw( );		 Clears reference, i.e. releases interface. Reference is null after clear() call.
sal_Bool
set( const Reference< interface_type > & rRef ) throw( );		 Sets the given interface. An interface already set will be released.
sal_Bool
set( interface_type * pInterface ) throw( );		 Sets the given interface. An interface already set will be released.
sal_Bool
set( interface_type * pInterface, __sal_NoAcquire ) throw( );		 Sets interface pointer without acquiring it. An interface already set will be released.
sal_Bool
set( interface_type * pInterface, __UnoReference_NoAcquire ) throw( );		 Sets interface pointer without acquiring it. An interface already set will be released. Deprecated, please use SAL_NO_ACQUIRE version.
sal_Bool
set( XInterface * pInterface, __UnoReference_Query ) throw( RuntimeException );		 Queries given interface for reference interface type (interface_type) and sets it. An interface already set will be released.
sal_Bool
set( const BaseReference & rRef, __UnoReference_Query ) throw( RuntimeException );		 Queries given interface for reference interface type (interface_type) and sets it. An interface already set will be released.
Reference< interface_type > &
operator=( interface_type * pInterface ) throw( );		 Assignment operator: Acquires given interface pointer and sets reference. An interface already set will be released.
Reference< interface_type > &
operator=( const Reference< interface_type > & rRef ) throw( );		 Assignment operator: Acquires given interface reference and sets reference. An interface already set will be released.

Static Methods
static Reference< interface_type >
query( const BaseReference & rRef ) throw( RuntimeException );		 Queries given interface reference for type interface_type.
static Reference< interface_type >
query( XInterface * pInterface ) throw( RuntimeException );		 Queries given interface for type interface_type.

Private Members

Static Methods
static interface_type *
__query( XInterface * pInterface ) throw( RuntimeException );		 Queries given interface reference for type interface_type.
Top of Page

Copyright 2002 Sun Microsystems, Inc., 901 San Antonio Road, Palo Alto, CA 94303 USA.

Apache Feather

Copyright & License | Privacy | Contact Us

Apache and the Apache feather logos are trademarks of The Apache Software Foundation. OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.

Apache OpenOffice is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.