interface XConnectionPoint in module com::sun::star::lang::

(Global Index)

Syntax

interface XConnectionPoint : com::sun::star::uno::XInterface ;

Description

supports connection points for connectable objects.

Connectable objects support the following features:

When to Implement?

To create a connectable object, you need to implement objects that provide two related interfaces:

The XConnectionPointContainer interface is implemented on the connectable object to indicate the existence of the outgoing interfaces. It provides a sequence of sub-objects. It also provides access to all the connection point sub-objects, each of which implements the XConnectionPoint interface. The XConnectionPoint interface provides a sequence of sub-objects.

Each connection point is a separate sub-object to avoid circular reference counting problems. A connection point controls how many connections (one or more) it will allow in its implementation of XConnectionPoint::advise() .

When to use?

A client can use the XConnectionPointContainer interface:

See also

XConnectionPointContainer

Method 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

Method Details



getConnectionType

Syntax

type getConnectionType ();

Description

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

IConnectionPointContainer::FindConnectionPoint

getConnectionPointContainer

Syntax

com::sun::star::lang::XConnectionPointContainer getConnectionPointContainer ();

Description

Returns

the XConnectionPointContainer interface on the parent connectable object.

See also

IConnectionPointContainer

advise

Syntax

void advise (
com::sun::star::uno::XInterface xListener )
raises ( com::sun::star::lang::ListenerExistException , com::sun::star::lang::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 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

Syntax

void unadvise (
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 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

Syntax

sequence< com::sun::star::uno::XInterface > getConnections ();

Description

Returns

a sequence of all currently advised connections.
Top of Page