offapi/com/sun/star/util/XChainable.idl

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