1 files changed, 118 insertions, 0 deletions
diff --git a/offapi/com/sun/star/frame/XUntitledNumbers.idl b/offapi/com/sun/star/frame/XUntitledNumbers.idl
new file mode 100644
index 000000000000..e2864d709c2f
--- /dev/null
+++ b/offapi/com/sun/star/frame/XUntitledNumbers.idl
@@ -0,0 +1,118 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org.  If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+#ifndef __com_sun_star_frame_XUntitledNumbers_idl__
+#define __com_sun_star_frame_XUntitledNumbers_idl__
+
+#ifndef __com_sun_star_uno_XInterface_idl__
+#include <com/sun/star/uno/XInterface.idl>
+#endif
+
+#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+#endif
+
+//=============================================================================
+
+ module com {  module sun {  module star {  module frame {
+
+constants UntitledNumbersConst
+{
+    const long INVALID_NUMBER = 0;
+};
+
+//=============================================================================
+/** knows all currently used and all free numbers for using with untitled
+    but counted objects.
+ */
+interface XUntitledNumbers : com::sun::star::uno::XInterface
+{
+    //-------------------------------------------------------------------------
+    /** calli has to lease a number befor he can use it within in its own title.
+
+        Such number must be freed after using e.g. while the object was closed or
+        get's another title (e.g. by saving a document to a real location on disc).
+
+        @param  xComponent
+                the component which has to be registered for the leased number.
+
+        @return the new number for these object or 0 if no further numbers are available.
+
+        @throws [IllegalArgumentException]
+                if an invalid object reference was provided to this method.
+     */
+    long leaseNumber ( [in] com::sun::star::uno::XInterface xComponent )
+        raises (com::sun::star::lang::IllegalArgumentException);
+
+    //-------------------------------------------------------------------------
+    /** has to be used to mark those number as "free for using".
+
+        If the reqistered component does not use such leased number any longer
+        it has to be released so it can be used for new components.
+
+        Note: calling this method with an unknown (but normaly valid number)
+              has to be ignored. No exceptions - no errors.
+
+        @param  nNumber
+                specify number for release.
+
+        @throws [IllegalArgumentException]
+                if the given number is the special value 0.
+     */
+    void releaseNumber ( [in] long nNumber )
+        raises (com::sun::star::lang::IllegalArgumentException);
+
+    //-------------------------------------------------------------------------
+    /** does the same then releaseNumber () but it searches the corresponding
+        number for the specified component and deregister it.
+
+        @param  xComponent
+                the component for deregistration.
+
+        @throws [IllegalArgumentException]
+                if an invalid object reference was provided to this method.
+     */
+    void releaseNumberForComponent ( [in] com::sun::star::uno::XInterface xComponent )
+        raises (com::sun::star::lang::IllegalArgumentException);
+
+    //-------------------------------------------------------------------------
+    /** returns the localized string value to be used for untitles objects in
+        combination with the leased number.
+
+        Note: Such string already contains leading spaces/tabs etcpp. !
+        The only thing which an outside code has todo then ... adding a leased number
+        to the string.
+
+        @return the localized string for untitled components.
+     */
+    string getUntitledPrefix ();
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif