/************************************************************************* * * $RCSfile: XConnectionPoint.idl,v $ * * $Revision: 1.10 $ * * last change: $Author: mi $ $Date: 2002-12-11 13:32:37 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses * * - GNU Lesser General Public License Version 2.1 * - Sun Industry Standards Source License Version 1.1 * * Sun Microsystems Inc., October, 2000 * * GNU Lesser General Public License Version 2.1 * ============================================= * Copyright 2000 by Sun Microsystems, Inc. * 901 San Antonio Road, Palo Alto, CA 94303, USA * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License version 2.1, as published by the Free Software Foundation. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, * MA 02111-1307 USA * * * Sun Industry Standards Source License Version 1.1 * ================================================= * The contents of this file are subject to the Sun Industry Standards * Source License Version 1.1 (the "License"); You may not use this file * except in compliance with the License. You may obtain a copy of the * License at http://www.openoffice.org/license.html. * * Software provided under this License is provided on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. * See the License for the specific provisions governing your rights and * obligations concerning the Software. * * The Initial Developer of the Original Code is: Sun Microsystems, Inc. * * Copyright: 2000 by Sun Microsystems, Inc. * * All Rights Reserved. * * Contributor(s): _______________________________________ * * ************************************************************************/ #ifndef __com_sun_star_lang_XConnectionPoint_idl__ #define __com_sun_star_lang_XConnectionPoint_idl__ #ifndef __com_sun_star_uno_XInterface_idl__ #include #endif #ifndef __com_sun_star_reflection_XIdlClass_idl__ #include #endif #ifndef __com_sun_star_lang_XConnectionPointContainer_idl__ #include #endif #ifndef __com_sun_star_lang_ListenerExistException_idl__ #include #endif #ifndef __com_sun_star_lang_InvalidListenerException_idl__ #include #endif //============================================================================= module com { module sun { module star { module lang { //============================================================================= // DocMerge from idl: interface com::sun::star::lang::XConnectionPoint /** supports connection points for connectable objects.

Connectable objects support the following features:

  • outgoing interfaces, such as event sets;
  • the ability to enumerate the types of the outgoing interfaces;
  • the ability to connect and disconnect sinks to the object for those outgoing types;
  • the ability to enumerate the connections that exist to a particular outgoing interface.

When to Implement?

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

  • XConnectionPointContainer
  • XConnectionPoint

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:

  • to get a sequence of connection points for each outgoing type.
  • to obtain access to connection point sub-objects with the XConnectionPoint interface for each outgoing type. Through the XConnectionPoint interface, a client starts or terminates an advisory loop with the connectable object and the client's own sink. The client can also use the XConnectionPoint interface to get a sequence of the connections that it knows about.
@see XConnectionPointContainer */ interface XConnectionPoint: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- // DocMerge from idl: method com::sun::star::lang::XConnectionPoint::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 XConnectionPointContainer::findConnectionPoint */ type getConnectionType(); //------------------------------------------------------------------------- // DocMerge from idl: method com::sun::star::lang::XConnectionPoint::getConnectionPointContainer /** @returns the XConnectionPointContainer interface on the parent connectable object. @see XConnectionPointContainer */ com::sun::star::lang::XConnectionPointContainer getConnectionPointContainer(); //------------------------------------------------------------------------- // DocMerge from idl: method com::sun::star::lang::XConnectionPoint::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.

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.

@param 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 com::sun::star::beans::XPropertySet::addPropertyChangeListener */ void advise( [in] com::sun::star::uno::XInterface xListener ) raises( com::sun::star::lang::ListenerExistException, com::sun::star::lang::InvalidListenerException ); //------------------------------------------------------------------------- // DocMerge from idl: method com::sun::star::lang::XConnectionPoint::unadvise /** 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.

@param listener specifies the listener interface on the client's advise sink. @see com::sun::star::beans::XPropertySet::removePropertyChangeListener */ void unadvise( [in] com::sun::star::uno::XInterface xListener ); //------------------------------------------------------------------------- // DocMerge from idl: method com::sun::star::lang::XConnectionPoint::getConnections /** @returns a sequence of all currently advised connections. */ sequence getConnections(); }; //============================================================================= }; }; }; }; #endif lo_contract34185 LibreOffice 核心代码仓库文档基金会
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHans-Joachim Lankenau <hjs@openoffice.org>2010-01-15 14:55:12 +0100
committerHans-Joachim Lankenau <hjs@openoffice.org>2010-01-15 14:55:12 +0100
commitb29bb2dbee8137ef5ff240588cf2269edc9428fd (patch)
tree3aaa726f6611e592ea05082f67898fbde91ccaad /external/glibc
parentda42440ee30c2a15803fe159855f64dec97ad45a (diff)