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