offapi/com/sun/star/frame/XUntitledNumbers.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XUntitledNumbers.idl,v $
  10  *
  11  * $Revision: 1.3 $
  12  *
  13  * This file is part of OpenOffice.org.
  14  *
  15  * OpenOffice.org is free software: you can redistribute it and/or modify
  16  * it under the terms of the GNU Lesser General Public License version 3
  17  * only, as published by the Free Software Foundation.
  18  *
  19  * OpenOffice.org is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU Lesser General Public License version 3 for more details
  23  * (a copy is included in the LICENSE file that accompanied this code).
  24  *
  25  * You should have received a copy of the GNU Lesser General Public License
  26  * version 3 along with OpenOffice.org.  If not, see
  27  * <http://www.openoffice.org/license.html>
  28  * for a copy of the LGPLv3 License.
  29  *
  30  ************************************************************************/
  31 #ifndef __com_sun_star_frame_XUntitledNumbers_idl__
  32 #define __com_sun_star_frame_XUntitledNumbers_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  39 #include <com/sun/star/lang/IllegalArgumentException.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module frame {
  45
  46 constants UntitledNumbersConst
  47 {
  48     const long INVALID_NUMBER = 0;
  49 };
  50
  51 //=============================================================================
  52 /** knows all currently used and all free numbers for using with untitled
  53     but counted objects.
  54  */
  55 interface XUntitledNumbers : com::sun::star::uno::XInterface
  56 {
  57     //-------------------------------------------------------------------------
  58     /** calli has to lease a number befor he can use it within in its own title.
  59
  60         Such number must be freed after using e.g. while the object was closed or
  61         get's another title (e.g. by saving a document to a real location on disc).
  62
  63         @param  xComponent
  64                 the component which has to be registered for the leased number.
  65
  66         @return the new number for these object or 0 if no further numbers are available.
  67
  68         @throws [IllegalArgumentException]
  69                 if an invalid object reference was provided to this method.
  70      */
  71     long leaseNumber ( [in] com::sun::star::uno::XInterface xComponent )
  72         raises (com::sun::star::lang::IllegalArgumentException);
  73
  74     //-------------------------------------------------------------------------
  75     /** has to be used to mark those number as "free for using".
  76
  77         If the reqistered component does not use such leased number any longer
  78         it has to be released so it can be used for new components.
  79
  80         Note: calling this method with an unknown (but normaly valid number)
  81               has to be ignored. No exceptions - no errors.
  82
  83         @param  nNumber
  84                 specify number for release.
  85
  86         @throws [IllegalArgumentException]
  87                 if the given number is the special value 0.
  88      */
  89     void releaseNumber ( [in] long nNumber )
  90         raises (com::sun::star::lang::IllegalArgumentException);
  91
  92     //-------------------------------------------------------------------------
  93     /** does the same then releaseNumber () but it searches the corresponding
  94         number for the specified component and deregister it.
  95
  96         @param  xComponent
  97                 the component for deregistration.
  98
  99         @throws [IllegalArgumentException]
 100                 if an invalid object reference was provided to this method.
 101      */
 102     void releaseNumberForComponent ( [in] com::sun::star::uno::XInterface xComponent )
 103         raises (com::sun::star::lang::IllegalArgumentException);
 104
 105     //-------------------------------------------------------------------------
 106     /** returns the localized string value to be used for untitles objects in
 107         combination with the leased number.
 108
 109         Note: Such string already contains leading spaces/tabs etcpp. !
 110         The only thing which an outside code has todo then ... adding a leased number
 111         to the string.
 112
 113         @return the localized string for untitled components.
 114      */
 115     string getUntitledPrefix ();
 116 };
 117
 118 //=============================================================================
 119
 120 }; }; }; };
 121
 122 #endif