1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_document_XActionLockable_idl__ 24cdf0e10cSrcweir#define __com_sun_star_document_XActionLockable_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir 31cdf0e10cSrcweir//============================================================================= 32cdf0e10cSrcweir 33cdf0e10cSrcweirmodule com { module sun { module star { module document { 34cdf0e10cSrcweir 35cdf0e10cSrcweir//============================================================================= 36cdf0e10cSrcweir 37cdf0e10cSrcweir/** makes it possible to prevent object internal updates for a certain period 38cdf0e10cSrcweir to be able to quickly change multiple parts of the objects, where the 39cdf0e10cSrcweir updates would invalidate each other, anyway. 40cdf0e10cSrcweir */ 41cdf0e10cSrcweirpublished interface XActionLockable: com::sun::star::uno::XInterface 42cdf0e10cSrcweir{ 43cdf0e10cSrcweir //------------------------------------------------------------------------- 44cdf0e10cSrcweir /** @returns 45cdf0e10cSrcweir <TRUE/> if at least one lock exists. 46cdf0e10cSrcweir */ 47cdf0e10cSrcweir boolean isActionLocked(); 48cdf0e10cSrcweir 49cdf0e10cSrcweir //------------------------------------------------------------------------- 50cdf0e10cSrcweir /** increments the lock count of the object by one. 51cdf0e10cSrcweir */ 52cdf0e10cSrcweir void addActionLock(); 53cdf0e10cSrcweir 54cdf0e10cSrcweir //------------------------------------------------------------------------- 55cdf0e10cSrcweir /** decrements the lock count of the object by one. 56cdf0e10cSrcweir */ 57cdf0e10cSrcweir void removeActionLock(); 58cdf0e10cSrcweir 59cdf0e10cSrcweir //------------------------------------------------------------------------- 60cdf0e10cSrcweir /** sets the locking level. 61cdf0e10cSrcweir 62cdf0e10cSrcweir <p>This method is used for debugging purposes. The programming 63cdf0e10cSrcweir environment can restore the locking after a break of a debug 64cdf0e10cSrcweir session.</p> 65cdf0e10cSrcweir */ 66cdf0e10cSrcweir void setActionLocks( [in] short nLock ); 67cdf0e10cSrcweir 68cdf0e10cSrcweir //------------------------------------------------------------------------- 69cdf0e10cSrcweir /** resets the locking level. 70cdf0e10cSrcweir 71cdf0e10cSrcweir <p>This method is used for debugging purposes. The debugging 72cdf0e10cSrcweir environment of a programming language can reset the locks 73cdf0e10cSrcweir to allow refreshing of the view if a breakpoint is reached or 74cdf0e10cSrcweir step execution is used. </p> 75cdf0e10cSrcweir */ 76cdf0e10cSrcweir short resetActionLocks(); 77cdf0e10cSrcweir 78cdf0e10cSrcweir}; 79cdf0e10cSrcweir 80cdf0e10cSrcweir//============================================================================= 81cdf0e10cSrcweir 82cdf0e10cSrcweir}; }; }; }; 83cdf0e10cSrcweir 84cdf0e10cSrcweir#endif 85