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