offapi/com/sun/star/util/XLockable.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
  20 #ifndef __com_sun_star_util_XLockable_idl__
  21 #define __com_sun_star_util_XLockable_idl__
  22
  23 #include <com/sun/star/util/NotLockedException.idl>
  24
  25
  26 module com { module sun { module star { module util {
  27
  28
  29 /** allows locking a component
  30
  31     <p><code>lock</code> and <code>unlock</code> calls can be nested. However, they must be in
  32     pairs. As long as there has been one more call to <code>lock</code> than to <code>unlock</code>, the
  33     component is considered locked, which is reflected by isLocked() returning `TRUE`.</p>
  34  */
  35 interface XLockable
  36 {
  37     /** locks</a> the component
  38
  39         @see unlock
  40         @see isLocked
  41     */
  42     void    lock();
  43
  44     /** unlocks the component
  45
  46         @throws NotLockedException
  47             if the component is not currently locked.
  48
  49         @see lock
  50         @see isLocked
  51     */
  52     void    unlock()
  53         raises  (   NotLockedException
  54                 );
  55
  56     /** determines whether the component is currently locked.
  57
  58         @see lock
  59         @see unlock
  60     */
  61     boolean isLocked();
  62 };
  63
  64
  65 }; }; }; };
  66
  67
  68 #endif
  69
  70 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */