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_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 38cdf0e10cSrcweirconstants UntitledNumbersConst 39cdf0e10cSrcweir{ 40cdf0e10cSrcweir const long INVALID_NUMBER = 0; 41cdf0e10cSrcweir}; 42cdf0e10cSrcweir 43cdf0e10cSrcweir//============================================================================= 44cdf0e10cSrcweir/** knows all currently used and all free numbers for using with untitled 45cdf0e10cSrcweir but counted objects. 46cdf0e10cSrcweir */ 47cdf0e10cSrcweirinterface XUntitledNumbers : com::sun::star::uno::XInterface 48cdf0e10cSrcweir{ 49cdf0e10cSrcweir //------------------------------------------------------------------------- 50cdf0e10cSrcweir /** calli has to lease a number befor he can use it within in its own title. 51cdf0e10cSrcweir 52cdf0e10cSrcweir Such number must be freed after using e.g. while the object was closed or 53cdf0e10cSrcweir get's another title (e.g. by saving a document to a real location on disc). 54cdf0e10cSrcweir 55cdf0e10cSrcweir @param xComponent 56cdf0e10cSrcweir the component which has to be registered for the leased number. 57cdf0e10cSrcweir 58cdf0e10cSrcweir @return the new number for these object or 0 if no further numbers are available. 59cdf0e10cSrcweir 60cdf0e10cSrcweir @throws [IllegalArgumentException] 61cdf0e10cSrcweir if an invalid object reference was provided to this method. 62cdf0e10cSrcweir */ 63cdf0e10cSrcweir long leaseNumber ( [in] com::sun::star::uno::XInterface xComponent ) 64cdf0e10cSrcweir raises (com::sun::star::lang::IllegalArgumentException); 65cdf0e10cSrcweir 66cdf0e10cSrcweir //------------------------------------------------------------------------- 67cdf0e10cSrcweir /** has to be used to mark those number as "free for using". 68cdf0e10cSrcweir 69cdf0e10cSrcweir If the reqistered component does not use such leased number any longer 70cdf0e10cSrcweir it has to be released so it can be used for new components. 71cdf0e10cSrcweir 72cdf0e10cSrcweir Note: calling this method with an unknown (but normaly valid number) 73cdf0e10cSrcweir has to be ignored. No exceptions - no errors. 74cdf0e10cSrcweir 75cdf0e10cSrcweir @param nNumber 76cdf0e10cSrcweir specify number for release. 77cdf0e10cSrcweir 78cdf0e10cSrcweir @throws [IllegalArgumentException] 79cdf0e10cSrcweir if the given number is the special value 0. 80cdf0e10cSrcweir */ 81cdf0e10cSrcweir void releaseNumber ( [in] long nNumber ) 82cdf0e10cSrcweir raises (com::sun::star::lang::IllegalArgumentException); 83cdf0e10cSrcweir 84cdf0e10cSrcweir //------------------------------------------------------------------------- 85cdf0e10cSrcweir /** does the same then releaseNumber () but it searches the corresponding 86cdf0e10cSrcweir number for the specified component and deregister it. 87cdf0e10cSrcweir 88cdf0e10cSrcweir @param xComponent 89cdf0e10cSrcweir the component for deregistration. 90cdf0e10cSrcweir 91cdf0e10cSrcweir @throws [IllegalArgumentException] 92cdf0e10cSrcweir if an invalid object reference was provided to this method. 93cdf0e10cSrcweir */ 94cdf0e10cSrcweir void releaseNumberForComponent ( [in] com::sun::star::uno::XInterface xComponent ) 95cdf0e10cSrcweir raises (com::sun::star::lang::IllegalArgumentException); 96cdf0e10cSrcweir 97cdf0e10cSrcweir //------------------------------------------------------------------------- 98cdf0e10cSrcweir /** returns the localized string value to be used for untitles objects in 99cdf0e10cSrcweir combination with the leased number. 100cdf0e10cSrcweir 101cdf0e10cSrcweir Note: Such string already contains leading spaces/tabs etcpp. ! 102cdf0e10cSrcweir The only thing which an outside code has todo then ... adding a leased number 103cdf0e10cSrcweir to the string. 104cdf0e10cSrcweir 105cdf0e10cSrcweir @return the localized string for untitled components. 106cdf0e10cSrcweir */ 107cdf0e10cSrcweir string getUntitledPrefix (); 108cdf0e10cSrcweir}; 109cdf0e10cSrcweir 110cdf0e10cSrcweir//============================================================================= 111cdf0e10cSrcweir 112cdf0e10cSrcweir}; }; }; }; 113cdf0e10cSrcweir 114cdf0e10cSrcweir#endif 115