:: com :: sun :: star :: lang ::

interface XConnectionPoint

Methods' Summary
getConnectionType  
getConnectionPointContainer  
advise creates a connection between a connection point and a client's sink, where the sink implements the outgoing interface supported by this connection point.  
unadvise terminates a notification previously set up with advise.  
getConnections  
Methods' Details
getConnectionType
type
getConnectionType();

Returns
the type of the outgoing interface managed by this connection point.

Using the XConnectionPointContainer::getConnectionPoints method, a client can obtain an XConnectionPoint interface. Using that interface and this method, the client can determine the type of each connection point enumerated. The type returned from this method must enable the caller to access this same connection point through XConnectionPointContainer::findConnectionPoint.

See also
XConnectionPointContainer::findConnectionPoint
getConnectionPointContainer
XConnectionPointContainer
getConnectionPointContainer();

Returns
the XConnectionPointContainer interface on the parent connectable object.
See also
XConnectionPointContainer
advise
void
advise( [in] ::com::sun::star::uno::XInterface  xListener )
raises( ListenerExistException,
InvalidListenerException );

Description
creates a connection between a connection point and a client's sink, where the sink implements the outgoing interface supported by this connection point.

A few add...Listener methods need additional parameters to add listeners or throw exceptions. One of these methods is ::com::sun::star::beans::XPropertySet::addPropertyChangeListener. We ignore the problem in this interface. A solution must be provided in an additional XConnectionPoint interface.

Parameter xListener
specifies the listener interface on the client's advise sink. The client's sink receives outgoing calls from the connection point container.
Throws
ListenerExistException if it is a unicast broadcaster and a listener is already set.
Throws
InvalidListenerException if the listener does not supply the needed interfaces.
See also
::com::sun::star::beans::XPropertySet::addPropertyChangeListener
unadvise
void
unadvise( [in] ::com::sun::star::uno::XInterface  xListener );

Description
terminates a notification previously set up with advise.

A few remove...Listener methods need additional parameters to add listeners or throw exceptions. One of these methods is ::com::sun::star::beans::XPropertySet::removePropertyChangeListener. We ignore the problem in this interface. A solution must be provided in an additional XConnectionPoint interface.

Parameter listener
specifies the listener interface on the client's advise sink.
See also
::com::sun::star::beans::XPropertySet::removePropertyChangeListener
getConnections
sequence< ::com::sun::star::uno::XInterface >
getConnections();

Returns
a sequence of all currently advised connections.
Top of Page