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