xref: /aoo42x/main/offapi/com/sun/star/util/XChainable.idl (revision d1766043)
1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*d1766043SAndrew Rist *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*d1766043SAndrew Rist *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19*d1766043SAndrew Rist *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_util_XChainable_idl__
24cdf0e10cSrcweir#define __com_sun_star_util_XChainable_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__
27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
31cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl>
32cdf0e10cSrcweir#endif
33cdf0e10cSrcweir
34cdf0e10cSrcweir
35cdf0e10cSrcweir//=============================================================================
36cdf0e10cSrcweir
37cdf0e10cSrcweirmodule com {  module sun {  module star {  module util {
38cdf0e10cSrcweir
39cdf0e10cSrcweir//=============================================================================
40cdf0e10cSrcweir
41cdf0e10cSrcweir/** enables the object to be a member of a chain.
42cdf0e10cSrcweir */
43cdf0e10cSrcweirpublished interface XChainable: com::sun::star::uno::XInterface
44cdf0e10cSrcweir{
45cdf0e10cSrcweir	//-------------------------------------------------------------------------
46cdf0e10cSrcweir	/** @returns
47cdf0e10cSrcweir				the previous object in this chain or NULL, if this is the first
48cdf0e10cSrcweir				object of this chain.
49cdf0e10cSrcweir	 */
50cdf0e10cSrcweir	com::sun::star::util::XChainable getPredecessor();
51cdf0e10cSrcweir
52cdf0e10cSrcweir	//-------------------------------------------------------------------------
53cdf0e10cSrcweir	/** @returns
54cdf0e10cSrcweir				the next object in this chain or NULL, if this is the last
55cdf0e10cSrcweir				object in this chain.
56cdf0e10cSrcweir	 */
57cdf0e10cSrcweir	com::sun::star::util::XChainable getSuccessor();
58cdf0e10cSrcweir
59cdf0e10cSrcweir	//-------------------------------------------------------------------------
60cdf0e10cSrcweir	/** connects the specified object to this object as the successor in a chain.
61cdf0e10cSrcweir
62cdf0e10cSrcweir		<p>This implies that this object will become the predecessor of
63cdf0e10cSrcweir		<var>xChainable</var>.  </p>
64cdf0e10cSrcweir	 */
65cdf0e10cSrcweir	void setSuccessor( [in] com::sun::star::util::XChainable xChainable )
66cdf0e10cSrcweir			raises( com::sun::star::lang::IllegalArgumentException );
67cdf0e10cSrcweir
68cdf0e10cSrcweir	//-------------------------------------------------------------------------
69cdf0e10cSrcweir	/** checks if the specified object can be linked to this.
70cdf0e10cSrcweir	 */
71cdf0e10cSrcweir	boolean isChainable( [in] com::sun::star::util::XChainable xChainable );
72cdf0e10cSrcweir
73cdf0e10cSrcweir};
74cdf0e10cSrcweir
75cdf0e10cSrcweir//=============================================================================
76cdf0e10cSrcweir
77cdf0e10cSrcweir}; }; }; };
78cdf0e10cSrcweir
79cdf0e10cSrcweir#endif
80