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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_util_XChainable_idl__
  20 #define __com_sun_star_util_XChainable_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/lang/IllegalArgumentException.idl>
  25
  26
  27
  28 module com {  module sun {  module star {  module util {
  29
  30
  31 /** enables the object to be a member of a chain.
  32  */
  33 published interface XChainable: com::sun::star::uno::XInterface
  34 {
  35     /** @returns
  36                 the previous object in this chain or NULL, if this is the first
  37                 object of this chain.
  38      */
  39     com::sun::star::util::XChainable getPredecessor();
  40
  41     /** @returns
  42                 the next object in this chain or NULL, if this is the last
  43                 object in this chain.
  44      */
  45     com::sun::star::util::XChainable getSuccessor();
  46
  47     /** connects the specified object to this object as the successor in a chain.
  48
  49         <p>This implies that this object will become the predecessor of
  50         <var>xChainable</var>.  </p>
  51      */
  52     void setSuccessor( [in] com::sun::star::util::XChainable xChainable )
  53             raises( com::sun::star::lang::IllegalArgumentException );
  54
  55     /** checks if the specified object can be linked to this.
  56      */
  57     boolean isChainable( [in] com::sun::star::util::XChainable xChainable );
  58
  59 };
  60
  61
  62 }; }; }; };
  63
  64 #endif
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */