offapi/com/sun/star/document/XActionLockable.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_document_XActionLockable_idl__
  20 #define __com_sun_star_document_XActionLockable_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24
  25
  26 module com {   module sun {   module star {   module document {
  27
  28
  29 /** makes it possible to prevent object internal updates for a certain period
  30     to be able to quickly change multiple parts of the objects, where the
  31     updates would invalidate each other, anyway.
  32  */
  33 published interface XActionLockable: com::sun::star::uno::XInterface
  34 {
  35     /** @returns
  36             `TRUE` if at least one lock exists.
  37      */
  38     boolean isActionLocked();
  39
  40     /** increments the lock count of the object by one.
  41      */
  42     void addActionLock();
  43
  44     /** decrements the lock count of the object by one.
  45      */
  46     void removeActionLock();
  47
  48     /** sets the locking level.
  49
  50         <p>This method is used for debugging purposes. The programming
  51         environment can restore the locking after a break of a debug
  52         session.</p>
  53      */
  54     void setActionLocks( [in] short nLock );
  55
  56     /** resets the locking level.
  57
  58         <p>This method is used for debugging purposes. The debugging
  59         environment of a programming language can reset the locks
  60         to allow refreshing of the view if a breakpoint is reached or
  61         step execution is used. </p>
  62      */
  63     short resetActionLocks();
  64
  65 };
  66
  67
  68 }; }; }; };
  69
  70 #endif
  71
  72 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */