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