xref: /aoo41x/main/offapi/com/sun/star/util/XChainable.idl (revision cdf0e10c)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_util_XChainable_idl__
28#define __com_sun_star_util_XChainable_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
35#include <com/sun/star/lang/IllegalArgumentException.idl>
36#endif
37
38
39//=============================================================================
40
41module com {  module sun {  module star {  module util {
42
43//=============================================================================
44
45/** enables the object to be a member of a chain.
46 */
47published interface XChainable: com::sun::star::uno::XInterface
48{
49	//-------------------------------------------------------------------------
50	/** @returns
51				the previous object in this chain or NULL, if this is the first
52				object of this chain.
53	 */
54	com::sun::star::util::XChainable getPredecessor();
55
56	//-------------------------------------------------------------------------
57	/** @returns
58				the next object in this chain or NULL, if this is the last
59				object in this chain.
60	 */
61	com::sun::star::util::XChainable getSuccessor();
62
63	//-------------------------------------------------------------------------
64	/** connects the specified object to this object as the successor in a chain.
65
66		<p>This implies that this object will become the predecessor of
67		<var>xChainable</var>.  </p>
68	 */
69	void setSuccessor( [in] com::sun::star::util::XChainable xChainable )
70			raises( com::sun::star::lang::IllegalArgumentException );
71
72	//-------------------------------------------------------------------------
73	/** checks if the specified object can be linked to this.
74	 */
75	boolean isChainable( [in] com::sun::star::util::XChainable xChainable );
76
77};
78
79//=============================================================================
80
81}; }; }; };
82
83#endif
84