summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/document
diff options
context:
space:
mode:
authorMichael Stahl <mstahl@redhat.com>2012-11-22 11:26:49 +0100
committerMichael Stahl <mstahl@redhat.com>2012-11-26 23:14:33 +0100
commite6f81b1898a59280f41177206b777a7a0d32f3fc (patch)
treec8047f94d0e647630ce45f8159600fdad7ebad48 /offapi/com/sun/star/document
parent31170413ae3786bf44564e813d7291354e939a77 (diff)
API CHANGE: remove com.sun.star.document.XDocumentInfo
The following badly designed interfaces and services were deprecated in OpenOffice.org 3.0 and are now remove from the API: com.sun.star.document.DocumentInfo com.sun.star.document.StandaloneDocumentInfo com.sun.star.document.XDocumentInfo com.sun.star.document.XDocumentInfoSupplier com.sun.star.document.XStandaloneDocumentInfo The supported replacements for these have been introduced in OOo 3.0: com.sun.star.document.XDocumentProperties com.sun.star.document.XDocumentPropertiesSupplier com.sun.star.document.DocumentProperties http://www.mail-archive.com/interface-announce@openoffice.org/msg00432.html Remove the implementation of these interfaces and services in sfx2 (SfxBaseModel, objuno.cxx) Also remove unit tests for these services in qadevOOo and sfx2. Conflicts: offapi/type_reference/types.rdb Change-Id: Ib0b48a4e53a8079c82fac3bb49a829812f8e5256
Diffstat (limited to 'offapi/com/sun/star/document')
-rw-r--r--offapi/com/sun/star/document/DocumentInfo.idl214
-rw-r--r--offapi/com/sun/star/document/OfficeDocument.idl12
-rw-r--r--offapi/com/sun/star/document/StandaloneDocumentInfo.idl63
-rw-r--r--offapi/com/sun/star/document/XDocumentInfo.idl128
-rw-r--r--offapi/com/sun/star/document/XDocumentInfoSupplier.idl59
-rw-r--r--offapi/com/sun/star/document/XStandaloneDocumentInfo.idl89
6 files changed, 0 insertions, 565 deletions
diff --git a/offapi/com/sun/star/document/DocumentInfo.idl b/offapi/com/sun/star/document/DocumentInfo.idl
deleted file mode 100644
index 7570b00100f6..000000000000
--- a/offapi/com/sun/star/document/DocumentInfo.idl
+++ /dev/null
@@ -1,214 +0,0 @@
-/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
-/*
- * This file is part of the LibreOffice project.
- *
- * This Source Code Form is subject to the terms of the Mozilla Public
- * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at http://mozilla.org/MPL/2.0/.
- *
- * This file incorporates work covered by the following license notice:
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed
- * with this work for additional information regarding copyright
- * ownership. The ASF licenses this file to you under the Apache
- * License, Version 2.0 (the "License"); you may not use this file
- * 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_document_DocumentInfo_idl__
-#define __com_sun_star_document_DocumentInfo_idl__
-
-#include <com/sun/star/document/XDocumentInfo.idl>
-#include <com/sun/star/lang/XComponent.idl>
-#include <com/sun/star/beans/XPropertySet.idl>
-#include <com/sun/star/beans/XFastPropertySet.idl>
-#include <com/sun/star/beans/XPropertyContainer.idl>
-#include <com/sun/star/beans/NamedValue.idl>
-#include <com/sun/star/util/DateTime.idl>
-#include <com/sun/star/lang/Locale.idl>
-
-
- module com { module sun { module star { module document {
-
-/** this service provides document-specific information like the
- author, creation date and user fields
-
- <p>
- Contrary to the service <type>StandaloneDocumentInfo</type> the document - which
- contains such informations - must be loaded completely. As a result of that this
- DocumentInfo service is available on an open document via the interface
- <type>XDocumentInfoSupplier</type> only.
- </p>
-
- @deprecated Use <type>DocumentProperties</type> instead.
-
- @see StandaloneDocumentInfo
- @see XDocumentInfoSupplier
- */
-published service DocumentInfo
-{
- /** provides access to the user fields for the information regarding the
- document
-
- <p>
- These fields are additional to normal properties.
- (see below)
- </p>
- */
- interface XDocumentInfo;
-
- /** necessary to support normal properties
- */
- interface com::sun::star::beans::XPropertySet;
-
- /** supports faster access on well known properties by using index
- */
- interface com::sun::star::beans::XFastPropertySet;
-
- /** provides access to the user fields, which (instead to the user fields set
- by the interface XDocumentInfo) will be typesafe.
-
- <p>
- These fields are additional to normal properties (see below) and
- additional to the user fields set by the interface XDocumentInfo (see before).
- </p>
- */
- [optional] interface com::sun::star::beans::XPropertyContainer;
-
- /** contains the initial author of the document
- */
- [property] string Author;
-
- /** @deprecated
- */
- [property] boolean AutoloadEnabled;
-
- /** contains the number of seconds after which a specified
- URL is to be loaded after the document is loaded into a desktop
- frame
- */
- [property] long AutoloadSecs;
-
- /** contains the URL to load automatically after a
- specified time after the document is loaded into a desktop frame
- */
- [property] string AutoloadURL;
-
- /** contains the date and time of the first time the
- document was stored
- */
- [property] com::sun::star::util::DateTime CreationDate;
-
- /** contains the name of the default frame into which
- links should be loaded if no target is specified
-
- <p>
- This applies to the autoload feature too, but to others as well.
- </p>
- */
- [property] string DefaultTarget;
-
- /** contains a multi-line comment of the document
-
- <p>
- Line delimiters can be UNIX, Macintosh or DOS style.
- </p>
- */
- [property] string Description;
-
- /** contains some statistics about the document
-
- <p>
- The exact name and type of the values depends on the document type
- </p>
- */
- [property] sequence< com::sun::star::beans::NamedValue > DocumentStatistic;
-
- /** describes how often the document was edited and saved
- */
- [property] short EditingCycles;
-
- /** contains the net time of editing the document (in seconds)
- */
- [property] long EditingDuration;
-
- /** identifies application was used to create or last modify the document
- */
- [property] string Generator;
-
- /** contains a comma separated list of keywords for
- the document
- */
- [property] string Keywords;
-
- /** contains the MIME-type of the document's resource
-
- <p>
- The MIME-type is neither stored in the document information nor in
- the document; it is sent within a protocol header or is
- detected, thus it cannot be changed.
- </p>
- */
- [readonly, property] string MIMEType;
-
- /** default language of the document
- */
- [property] com::sun::star::lang::Locale Language;
-
- /** contains the name of the editor who was the last
- person to store this document
- */
- [property] string ModifiedBy;
-
- /** contains the date and time of the last time the
- document was stored
- */
- [property] com::sun::star::util::DateTime ModifyDate;
-
- /** contains the date and time of when the document was
- last printed
- */
- [property] com::sun::star::util::DateTime PrintDate;
-
- /** contains the name of the editor who was the last
- person to print the document
- */
- [property] string PrintedBy;
-
- /** subject of document
- */
- [property] string Subject;
-
- /** contains logical name of the template from
- which the document was created
-
- <p>
- The value is an empty string if the document was not created
- from a template or if it was detached from the template.
- </p>
- */
- [property] string Template;
-
- /** contains the file path name of the template from
- which the document was created
- */
- [property] string TemplateFileName;
-
- /** contains the date and time of when the document
- was created or updated from the template
- */
- [property] com::sun::star::util::DateTime TemplateDate;
-
- /** contains the title of the document
- */
- [property] string Title;
-
-};
-
-
-}; }; }; };
-
-#endif
-
-/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/OfficeDocument.idl b/offapi/com/sun/star/document/OfficeDocument.idl
index e6f2f6f1a174..96de71875c5b 100644
--- a/offapi/com/sun/star/document/OfficeDocument.idl
+++ b/offapi/com/sun/star/document/OfficeDocument.idl
@@ -26,7 +26,6 @@
#include <com/sun/star/view/XPrintJobBroadcaster.idl>
#include <com/sun/star/document/XEventBroadcaster.idl>
#include <com/sun/star/document/XEventsSupplier.idl>
-#include <com/sun/star/document/XDocumentInfoSupplier.idl>
#include <com/sun/star/document/XViewDataSupplier.idl>
#include <com/sun/star/document/XDocumentEventBroadcaster.idl>
#include <com/sun/star/document/XEmbeddedScripts.idl>
@@ -104,17 +103,6 @@ published service OfficeDocument
*/
[optional] interface XEventsSupplier;
- /** document can provide a <type>DocumentInfo</type>
-
- <p>
- Instead of the <type>StandaloneDocumentInfo</type> service the <type>DocumentInfo</type>
- will be available on an already opened document only.
- </p>
-
- @deprecated Use <type>XDocumentPropertiesSupplier</type> instead.
- */
- [optional] interface XDocumentInfoSupplier;
-
/** access to some properties describing all open views to a document
*/
[optional] interface XViewDataSupplier;
diff --git a/offapi/com/sun/star/document/StandaloneDocumentInfo.idl b/offapi/com/sun/star/document/StandaloneDocumentInfo.idl
deleted file mode 100644
index 04084eafb5c2..000000000000
--- a/offapi/com/sun/star/document/StandaloneDocumentInfo.idl
+++ /dev/null
@@ -1,63 +0,0 @@
-/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
-/*
- * This file is part of the LibreOffice project.
- *
- * This Source Code Form is subject to the terms of the Mozilla Public
- * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at http://mozilla.org/MPL/2.0/.
- *
- * This file incorporates work covered by the following license notice:
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed
- * with this work for additional information regarding copyright
- * ownership. The ASF licenses this file to you under the Apache
- * License, Version 2.0 (the "License"); you may not use this file
- * 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_document_StandaloneDocumentInfo_idl__
-#define __com_sun_star_document_StandaloneDocumentInfo_idl__
-
-#include <com/sun/star/document/DocumentInfo.idl>
-#include <com/sun/star/document/XStandaloneDocumentInfo.idl>
-
-
- module com { module sun { module star { module document {
-
-/** extends the service <type>DocumentInfo</type> to have access on such
- document properties without loading the whole document
-
- <p>
- First action on this service must be to specify which document should be handled.
- Otherwise all supported properties of <type>DocumentInfo</type> will be set to
- void values. Loading of a document doesn't mean - loading all. It means reading
- of special part only, which includes searched information. Same procedure for saving
- of may changed values back to the document.
- </p>
-
- @deprecated Use <type>DocumentProperties</type> instead.
-
- @see DocumentInfo
- */
-published service StandaloneDocumentInfo
-{
- /** use it to specify resource or target of document info data
-
- <p>
- Must be the first action on this service. Otherwise all properties will be void.
- </p>
- */
- interface XStandaloneDocumentInfo;
-
- /** access to document info data
- */
- service DocumentInfo;
-};
-
-
-}; }; }; };
-
-#endif
-
-/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XDocumentInfo.idl b/offapi/com/sun/star/document/XDocumentInfo.idl
deleted file mode 100644
index b43bab79f212..000000000000
--- a/offapi/com/sun/star/document/XDocumentInfo.idl
+++ /dev/null
@@ -1,128 +0,0 @@
-/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
-/*
- * This file is part of the LibreOffice project.
- *
- * This Source Code Form is subject to the terms of the Mozilla Public
- * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at http://mozilla.org/MPL/2.0/.
- *
- * This file incorporates work covered by the following license notice:
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed
- * with this work for additional information regarding copyright
- * ownership. The ASF licenses this file to you under the Apache
- * License, Version 2.0 (the "License"); you may not use this file
- * 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_document_XDocumentInfo_idl__
-#define __com_sun_star_document_XDocumentInfo_idl__
-
-#include <com/sun/star/uno/XInterface.idl>
-#include <com/sun/star/lang/ArrayIndexOutOfBoundsException.idl>
-
-
-module com { module sun { module star { module document {
-
-/** provides access to the user fields for the information regarding the
- document
-
- <p>
- These fields are special one of the set of available document properties.
- Other ones are accessed as properties (by using the interface
- <type scope="com::sun::star::beans">XPropertySet</type>) of service
- <type>DocumentInfo</type>.
- </p>
-
- @deprecated Use <type>XDocumentProperties</type> instead.
-
- @see DocumentInfo
- @see StandaloneDocumentInfo
- @see com::sun::star::beans::XPropertySet
- */
-published interface XDocumentInfo: com::sun::star::uno::XInterface
-{
- /** provides information about count of available fields
-
- <p>
- This count marks the top range of possible requests for get/set
- any of these fields. Range = [0..count-1]
- </p>
-
- @returns
- current count
- */
- short getUserFieldCount();
-
- /** returns the name of an user field
-
- @param Index
- specifies the position of requested field
- Range = [0..count-1]
-
- @returns
- the name of the requested field
-
- @throws com::sun::star::lang::ArrayIndexOutOfBoundsException
- if <var>Index</var> don't fit range of [0..count-1]
- */
- string getUserFieldName( [in] short Index )
- raises( com::sun::star::lang::ArrayIndexOutOfBoundsException );
-
- /** returns the value of an user field
-
- @param Index
- specifies the position of requested field
- Range = [0..count-1]
-
- @returns
- the value of the requested field
-
- @throws com::sun::star::lang::ArrayIndexOutOfBoundsException
- if <var>Index</var> don't fit range of [0..count-1]
- */
- string getUserFieldValue( [in] short Index )
- raises( com::sun::star::lang::ArrayIndexOutOfBoundsException );
-
- /** changes the name of one of the user fields
-
- @param Index
- specifies the position of requested field
- Range = [0..count-1]
-
- @param Name
- the new name for this field to be set
-
- @throws com::sun::star::lang::ArrayIndexOutOfBoundsException
- if <var>Index</var> don't fit range of [0..count-1]
- */
- void setUserFieldName(
- [in] short Index ,
- [in] string Name )
- raises( com::sun::star::lang::ArrayIndexOutOfBoundsException );
-
- /** changes the value of one of the user fields
-
- @param Index
- specifies the position of requested field
- Range = [0..count-1]
-
- @param Value
- the new value for this field to be set
-
- @throws com::sun::star::lang::ArrayIndexOutOfBoundsException
- if <var>Index</var> don't fit range of [0..count-1]
- */
- void setUserFieldValue(
- [in] short Index ,
- [in] string Value )
- raises( com::sun::star::lang::ArrayIndexOutOfBoundsException );
-};
-
-
-}; }; }; };
-
-#endif
-
-/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XDocumentInfoSupplier.idl b/offapi/com/sun/star/document/XDocumentInfoSupplier.idl
deleted file mode 100644
index 295d431dca04..000000000000
--- a/offapi/com/sun/star/document/XDocumentInfoSupplier.idl
+++ /dev/null
@@ -1,59 +0,0 @@
-/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
-/*
- * This file is part of the LibreOffice project.
- *
- * This Source Code Form is subject to the terms of the Mozilla Public
- * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at http://mozilla.org/MPL/2.0/.
- *
- * This file incorporates work covered by the following license notice:
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed
- * with this work for additional information regarding copyright
- * ownership. The ASF licenses this file to you under the Apache
- * License, Version 2.0 (the "License"); you may not use this file
- * 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_document_XDocumentInfoSupplier_idl__
-#define __com_sun_star_document_XDocumentInfoSupplier_idl__
-
-#include <com/sun/star/uno/XInterface.idl>
-#include <com/sun/star/document/XDocumentInfo.idl>
-
-
-module com { module sun { module star { module document {
-
-/** through this interface documents can provide a <type>DocumentInfo</type>
-
- <p>
- A <type>DocumentInfo</type> is available on already opened documents only
- and must be provides by this supplier interface.
- Instead of that you can use the service <type>StandaloneDocumentInfo</type>
- to have access to such informations without opening the whole file.
- It read/write parts of the document, which include the required informations,
- only.
- </p>
-
- @deprecated Use <type>XDocumentPropertiesSupplier</type> instead.
-
- @see DocumentInfo
- @see StandaloneDocumentInfo
- */
-published interface XDocumentInfoSupplier: com::sun::star::uno::XInterface
-{
- /** provides the document information object
-
- @returns
- an object of type <type>DocumentInfo</type>
- */
- XDocumentInfo getDocumentInfo();
-};
-
-
-}; }; }; };
-
-#endif
-
-/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XStandaloneDocumentInfo.idl b/offapi/com/sun/star/document/XStandaloneDocumentInfo.idl
deleted file mode 100644
index da5ae47406e8..000000000000
--- a/offapi/com/sun/star/document/XStandaloneDocumentInfo.idl
+++ /dev/null
@@ -1,89 +0,0 @@
-/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
-/*
- * This file is part of the LibreOffice project.
- *
- * This Source Code Form is subject to the terms of the Mozilla Public
- * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at http://mozilla.org/MPL/2.0/.
- *
- * This file incorporates work covered by the following license notice:
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed
- * with this work for additional information regarding copyright
- * ownership. The ASF licenses this file to you under the Apache
- * License, Version 2.0 (the "License"); you may not use this file
- * 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_document_XStandaloneDocumentInfo_idl__
-#define __com_sun_star_document_XStandaloneDocumentInfo_idl__
-
-#include <com/sun/star/document/XDocumentInfo.idl>
-#include <com/sun/star/io/IOException.idl>
-
-
-module com { module sun { module star { module document {
-
-/** makes it possible to load document information from
- a resource specified by a URL and to store it into a resource also
- specified by a URL
-
- <p>
- Only the document information part of the resource is transferred.
- Instead of <type>DocumentInfo</type> not the whole document will be opened.
- Note: Without specifying the source or target of this info (the document)
- nothing can work and will be handled as void (for reading) or ignored (for writing).
- After specifying the source/target by using this interface,
- the interface <type>XDocumentInfo</type> (which must be implemented on same
- object then this one!) provides access to the info properties.
- </p>
-
- @deprecated Use <type>XDocumentProperties</type> instead.
-
- @see DocumentInfo
- @see StandaloneDocumentInfo
- @see XDocumentInfo
- */
-published interface XStandaloneDocumentInfo: XDocumentInfo
-{
- /** loads the document information from a file referred by an URL
-
- <p>
- After an unsuccessful call the contents of the document
- information are undefined (void).
- This method only works for storage file formats.
- </p>
-
- @param URL
- specifies the source of information
-
- @throws com::sun::star::io::IOException
- if storage couldn't be found or opened
- */
- void loadFromURL( [in] string URL )
- raises( com::sun::star::io::IOException );
-
- /** stores the document information into a file referred by a URL
-
- <p>
- Only the document information part of the document is overwritten.
- This method only works for storage file formats.
- </p>
-
- @param URL
- specifies the target for saving
-
- @throws com::sun::star::io::IOException
- if storage couldn't be found or opened
- */
- void storeIntoURL( [in] string URL )
- raises( com::sun::star::io::IOException );
-};
-
-
-}; }; }; };
-
-#endif
-
-/* vim:set shiftwidth=4 softtabstop=4 expandtab: */