summaryrefslogtreecommitdiff
path: root/offapi
diff options
context:
space:
mode:
authorNorbert Thiebaud <nthiebaud@gmail.com>2012-11-07 12:22:41 -0600
committerNorbert Thiebaud <nthiebaud@gmail.com>2012-11-07 14:00:52 -0600
commitfa0db4b951878aad26aeae4eb2e2e18d0ccce1d3 (patch)
treed97f8ce18f514b37fed8a70439363eb8a0ebb26f /offapi
parenta80b3c06ee0457d536071d770ae4c16fcaf3ff05 (diff)
rebase XUntitledNumbers
Change-Id: I59c62bb5a8cad34a1da3e118a23f9e7320e44a06
Diffstat (limited to 'offapi')
-rw-r--r--offapi/com/sun/star/frame/UntitledNumbersConst.idl42
-rw-r--r--offapi/com/sun/star/frame/XUntitledNumbers.idl33
2 files changed, 24 insertions, 51 deletions
diff --git a/offapi/com/sun/star/frame/UntitledNumbersConst.idl b/offapi/com/sun/star/frame/UntitledNumbersConst.idl
deleted file mode 100644
index 645ea37588d7..000000000000
--- a/offapi/com/sun/star/frame/UntitledNumbersConst.idl
+++ /dev/null
@@ -1,42 +0,0 @@
-/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
-/*************************************************************************
- *
- * 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_UntitledNumbersConst_idl__
-#define __com_sun_star_frame_UntitledNumbersConst_idl__
-
- module com { module sun { module star { module frame {
-
-constants UntitledNumbersConst
-{
- const long INVALID_NUMBER = 0;
-};
-
-}; }; }; };
-
-#endif
-
-/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/frame/XUntitledNumbers.idl b/offapi/com/sun/star/frame/XUntitledNumbers.idl
index 231707b5e7b2..a9a4169a9e84 100644
--- a/offapi/com/sun/star/frame/XUntitledNumbers.idl
+++ b/offapi/com/sun/star/frame/XUntitledNumbers.idl
@@ -1,4 +1,3 @@
-/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
@@ -16,24 +15,38 @@
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
+
#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
{
- /** callee has to lease a number before he can use it within in its own title.
+ //-------------------------------------------------------------------------
+ /** 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
- gets another title (e.g. by saving a document to a real location on disc).
+ 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.
@@ -46,12 +59,13 @@ interface XUntitledNumbers : com::sun::star::uno::XInterface
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 registered component does not use such leased number any longer
+ 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 normally valid number)
+ Note: calling this method with an unknown (but normaly valid number)
has to be ignored. No exceptions - no errors.
@param nNumber
@@ -63,6 +77,7 @@ interface XUntitledNumbers : com::sun::star::uno::XInterface
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.
@@ -75,10 +90,11 @@ interface XUntitledNumbers : com::sun::star::uno::XInterface
void releaseNumberForComponent ( [in] com::sun::star::uno::XInterface xComponent )
raises (com::sun::star::lang::IllegalArgumentException);
- /** returns the localized string value to be used for untitled objects in
+ //-------------------------------------------------------------------------
+ /** 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 etc. !
+ 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.
@@ -87,9 +103,8 @@ interface XUntitledNumbers : com::sun::star::uno::XInterface
string getUntitledPrefix ();
};
+//=============================================================================
}; }; }; };
#endif
-
-/* vim:set shiftwidth=4 softtabstop=4 expandtab: */