1d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5d1766043SAndrew Rist * distributed with this work for additional information 6d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10d1766043SAndrew Rist * 11d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12d1766043SAndrew Rist * 13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14d1766043SAndrew Rist * software distributed under the License is distributed on an 15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17d1766043SAndrew Rist * specific language governing permissions and limitations 18d1766043SAndrew Rist * under the License. 19d1766043SAndrew Rist * 20d1766043SAndrew Rist *************************************************************/ 21d1766043SAndrew Rist 22d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_frame_XUntitledNumbers_idl__ 24cdf0e10cSrcweir#define __com_sun_star_frame_XUntitledNumbers_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 31cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir//============================================================================= 35cdf0e10cSrcweir 36cdf0e10cSrcweir module com { module sun { module star { module frame { 37cdf0e10cSrcweir 38cdf0e10cSrcweir//============================================================================= 39cdf0e10cSrcweir/** knows all currently used and all free numbers for using with untitled 40cdf0e10cSrcweir but counted objects. 41cdf0e10cSrcweir */ 42cdf0e10cSrcweirinterface XUntitledNumbers : com::sun::star::uno::XInterface 43cdf0e10cSrcweir{ 44cdf0e10cSrcweir //------------------------------------------------------------------------- 45cdf0e10cSrcweir /** calli has to lease a number befor he can use it within in its own title. 46cdf0e10cSrcweir 47cdf0e10cSrcweir Such number must be freed after using e.g. while the object was closed or 48cdf0e10cSrcweir get's another title (e.g. by saving a document to a real location on disc). 49cdf0e10cSrcweir 50cdf0e10cSrcweir @param xComponent 51cdf0e10cSrcweir the component which has to be registered for the leased number. 52cdf0e10cSrcweir 53cdf0e10cSrcweir @return the new number for these object or 0 if no further numbers are available. 54cdf0e10cSrcweir 55cdf0e10cSrcweir @throws [IllegalArgumentException] 56cdf0e10cSrcweir if an invalid object reference was provided to this method. 57cdf0e10cSrcweir */ 58cdf0e10cSrcweir long leaseNumber ( [in] com::sun::star::uno::XInterface xComponent ) 59cdf0e10cSrcweir raises (com::sun::star::lang::IllegalArgumentException); 60cdf0e10cSrcweir 61cdf0e10cSrcweir //------------------------------------------------------------------------- 62cdf0e10cSrcweir /** has to be used to mark those number as "free for using". 63cdf0e10cSrcweir 64cdf0e10cSrcweir If the reqistered component does not use such leased number any longer 65cdf0e10cSrcweir it has to be released so it can be used for new components. 66cdf0e10cSrcweir 67*e9faf1d9Smseidel Note: calling this method with an unknown (but normally valid number) 68cdf0e10cSrcweir has to be ignored. No exceptions - no errors. 69cdf0e10cSrcweir 70cdf0e10cSrcweir @param nNumber 71cdf0e10cSrcweir specify number for release. 72cdf0e10cSrcweir 73cdf0e10cSrcweir @throws [IllegalArgumentException] 74cdf0e10cSrcweir if the given number is the special value 0. 75cdf0e10cSrcweir */ 76cdf0e10cSrcweir void releaseNumber ( [in] long nNumber ) 77cdf0e10cSrcweir raises (com::sun::star::lang::IllegalArgumentException); 78cdf0e10cSrcweir 79cdf0e10cSrcweir //------------------------------------------------------------------------- 80cdf0e10cSrcweir /** does the same then releaseNumber () but it searches the corresponding 81cdf0e10cSrcweir number for the specified component and deregister it. 82cdf0e10cSrcweir 83cdf0e10cSrcweir @param xComponent 84cdf0e10cSrcweir the component for deregistration. 85cdf0e10cSrcweir 86cdf0e10cSrcweir @throws [IllegalArgumentException] 87cdf0e10cSrcweir if an invalid object reference was provided to this method. 88cdf0e10cSrcweir */ 89cdf0e10cSrcweir void releaseNumberForComponent ( [in] com::sun::star::uno::XInterface xComponent ) 90cdf0e10cSrcweir raises (com::sun::star::lang::IllegalArgumentException); 91cdf0e10cSrcweir 92cdf0e10cSrcweir //------------------------------------------------------------------------- 93cdf0e10cSrcweir /** returns the localized string value to be used for untitles objects in 94cdf0e10cSrcweir combination with the leased number. 95cdf0e10cSrcweir 96cdf0e10cSrcweir Note: Such string already contains leading spaces/tabs etcpp. ! 97cdf0e10cSrcweir The only thing which an outside code has todo then ... adding a leased number 98cdf0e10cSrcweir to the string. 99cdf0e10cSrcweir 100cdf0e10cSrcweir @return the localized string for untitled components. 101cdf0e10cSrcweir */ 102cdf0e10cSrcweir string getUntitledPrefix (); 103cdf0e10cSrcweir}; 104cdf0e10cSrcweir 105cdf0e10cSrcweir//============================================================================= 106cdf0e10cSrcweir 107cdf0e10cSrcweir}; }; }; }; 108cdf0e10cSrcweir 109cdf0e10cSrcweir#endif 110