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