summaryrefslogtreecommitdiff
path: root/offapi
diff options
context:
space:
mode:
authorJens-Heiner Rechtien <hr@openoffice.org>2010-01-29 15:26:37 +0000
committerJens-Heiner Rechtien <hr@openoffice.org>2010-01-29 15:26:37 +0000
commitb3a91e5eadf06589c70e6beff88370465b884c9f (patch)
tree77a0a3e041b8517960ce90ab720fe2ffeb4f17d5 /offapi
parent87ef0fd0ea3493d42637c4a5082a1ccacc703e03 (diff)
parentfecfc136e8d805e349ce68e99999e620cb904852 (diff)
ab71: merge with DEV300_m54
Diffstat (limited to 'offapi')
-rw-r--r--offapi/com/sun/star/awt/KeyModifier.idl5
-rwxr-xr-xoffapi/com/sun/star/awt/MouseWheelBehavior.idl61
-rw-r--r--offapi/com/sun/star/awt/UnoControlComboBoxModel.idl8
-rw-r--r--offapi/com/sun/star/awt/UnoControlCurrencyFieldModel.idl8
-rw-r--r--offapi/com/sun/star/awt/UnoControlDateFieldModel.idl8
-rw-r--r--offapi/com/sun/star/awt/UnoControlFormattedFieldModel.idl8
-rw-r--r--offapi/com/sun/star/awt/UnoControlListBoxModel.idl8
-rw-r--r--offapi/com/sun/star/awt/UnoControlNumericFieldModel.idl8
-rw-r--r--offapi/com/sun/star/awt/UnoControlPatternFieldModel.idl8
-rw-r--r--offapi/com/sun/star/awt/UnoControlSpinButtonModel.idl8
-rw-r--r--offapi/com/sun/star/awt/UnoControlTimeFieldModel.idl8
-rw-r--r--offapi/com/sun/star/awt/XDialog2.idl6
-rw-r--r--offapi/com/sun/star/awt/XUnitConversion.idl38
-rw-r--r--offapi/com/sun/star/awt/makefile.mk1
-rw-r--r--offapi/com/sun/star/chart/BubbleDiagram.idl69
-rw-r--r--offapi/com/sun/star/chart/ChartTwoAxisXSupplier.idl16
-rw-r--r--offapi/com/sun/star/chart/ChartTwoAxisYSupplier.idl16
-rw-r--r--offapi/com/sun/star/chart/makefile.mk1
-rw-r--r--offapi/com/sun/star/chart2/RectangularDataSource.idl89
-rw-r--r--offapi/com/sun/star/chart2/data/DataProvider.idl4
-rw-r--r--offapi/com/sun/star/chart2/data/DataSequence.idl9
-rw-r--r--offapi/com/sun/star/drawing/FillProperties.idl141
-rw-r--r--offapi/com/sun/star/form/XErrorListener.idl1
-rw-r--r--offapi/com/sun/star/form/component/CommandButton.idl37
-rw-r--r--offapi/com/sun/star/linguistic2/Dictionary.idl2
-rw-r--r--offapi/com/sun/star/linguistic2/LinguProperties.idl16
-rw-r--r--offapi/com/sun/star/linguistic2/LinguServiceEventFlags.idl2
-rw-r--r--offapi/com/sun/star/linguistic2/ProofreadingResult.idl2
-rw-r--r--offapi/com/sun/star/linguistic2/SingleProofreadingError.idl2
-rw-r--r--offapi/com/sun/star/linguistic2/XProofreader.idl2
-rw-r--r--offapi/com/sun/star/linguistic2/XProofreadingIterator.idl2
-rw-r--r--offapi/com/sun/star/linguistic2/XSearchableDictionary.idl2
-rw-r--r--offapi/com/sun/star/linguistic2/XSetSpellAlternatives.idl4
-rw-r--r--offapi/com/sun/star/logging/DocumentIOLogRing.idl66
-rw-r--r--offapi/com/sun/star/logging/SimpleLogRing.idl72
-rw-r--r--offapi/com/sun/star/logging/XSimpleLogRing.idl77
-rw-r--r--offapi/com/sun/star/logging/makefile.mk5
-rw-r--r--offapi/com/sun/star/rdf/BlankNode.idl2
-rw-r--r--offapi/com/sun/star/rdf/FileFormat.idl8
-rw-r--r--offapi/com/sun/star/rdf/Statement.idl4
-rw-r--r--offapi/com/sun/star/rdf/URI.idl7
-rw-r--r--offapi/com/sun/star/rdf/URIs.idl277
-rw-r--r--offapi/com/sun/star/rdf/XDocumentMetadataAccess.idl249
-rw-r--r--offapi/com/sun/star/rdf/XDocumentRepository.idl69
-rw-r--r--offapi/com/sun/star/rdf/XMetadatable.idl50
-rw-r--r--offapi/com/sun/star/rdf/XNamedGraph.idl14
-rw-r--r--offapi/com/sun/star/rdf/XQuerySelectResult.idl2
-rw-r--r--offapi/com/sun/star/rdf/XRepository.idl16
-rw-r--r--offapi/com/sun/star/report/XImageControl.idl16
-rw-r--r--offapi/com/sun/star/report/XReportControlFormat.idl33
-rw-r--r--offapi/com/sun/star/report/XReportEngine.idl7
-rw-r--r--offapi/com/sun/star/report/XShape.idl4
-rw-r--r--offapi/com/sun/star/sdb/ErrorCondition.idl31
-rw-r--r--offapi/com/sun/star/sdb/RowSet.idl3
-rw-r--r--offapi/com/sun/star/sdb/XRowSetChangeBroadcaster.idl66
-rw-r--r--offapi/com/sun/star/sdb/XRowSetChangeListener.idl62
-rw-r--r--offapi/com/sun/star/sdb/XRowSetSupplier.idl2
-rw-r--r--offapi/com/sun/star/sdb/application/DefaultViewController.idl2
-rw-r--r--offapi/com/sun/star/sdb/application/XCopyTableWizard.idl8
-rw-r--r--offapi/com/sun/star/sdb/makefile.mk2
-rw-r--r--offapi/com/sun/star/sheet/DDELinkInfo.idl29
-rw-r--r--offapi/com/sun/star/sheet/DataPilotDescriptor.idl13
-rw-r--r--offapi/com/sun/star/sheet/DataPilotField.idl71
-rw-r--r--offapi/com/sun/star/sheet/DataPilotFieldGroup.idl56
-rw-r--r--offapi/com/sun/star/sheet/DataPilotFieldGroupBy.idl97
-rw-r--r--offapi/com/sun/star/sheet/DataPilotFieldGroupEnumeration.idl67
-rw-r--r--offapi/com/sun/star/sheet/DataPilotFieldGroupInfo.idl114
-rw-r--r--offapi/com/sun/star/sheet/DataPilotFieldGroups.idl59
-rw-r--r--offapi/com/sun/star/sheet/DataPilotFieldGroupsEnumeration.idl67
-rw-r--r--offapi/com/sun/star/sheet/DataPilotItem.idl8
-rw-r--r--offapi/com/sun/star/sheet/DataPilotItems.idl4
-rw-r--r--offapi/com/sun/star/sheet/DatabaseRange.idl2
-rw-r--r--offapi/com/sun/star/sheet/ExternalLinkInfo.idl31
-rw-r--r--offapi/com/sun/star/sheet/FilterFormulaParser.idl55
-rw-r--r--offapi/com/sun/star/sheet/FilterOperator2.idl164
-rw-r--r--offapi/com/sun/star/sheet/FormulaMapGroupSpecialOffset.idl53
-rw-r--r--offapi/com/sun/star/sheet/FormulaParser.idl37
-rw-r--r--offapi/com/sun/star/sheet/NamedRange.idl2
-rw-r--r--offapi/com/sun/star/sheet/TableFilterField2.idl106
-rw-r--r--offapi/com/sun/star/sheet/XDataPilotDataLayoutFieldSupplier.idl77
-rw-r--r--offapi/com/sun/star/sheet/XDataPilotDescriptor.idl2
-rw-r--r--offapi/com/sun/star/sheet/XDataPilotFieldGrouping.idl114
-rw-r--r--offapi/com/sun/star/sheet/XFilterFormulaParser.idl62
-rw-r--r--offapi/com/sun/star/sheet/XFormulaOpCodeMapper.idl85
-rw-r--r--offapi/com/sun/star/sheet/XFormulaParser.idl14
-rw-r--r--offapi/com/sun/star/sheet/XSheetFilterDescriptor2.idl79
-rw-r--r--offapi/com/sun/star/sheet/makefile.mk8
-rw-r--r--offapi/com/sun/star/style/Style.idl2
-rw-r--r--offapi/com/sun/star/task/DocumentMSPasswordRequest.idl67
-rw-r--r--offapi/com/sun/star/task/makefile.mk2
-rw-r--r--offapi/com/sun/star/text/DocumentSettings.idl12
-rw-r--r--offapi/com/sun/star/text/NumberingLevel.idl20
-rw-r--r--offapi/com/sun/star/text/ReferenceFieldPart.idl12
-rw-r--r--offapi/com/sun/star/text/TextPortion.idl118
-rw-r--r--offapi/com/sun/star/text/ViewSettings.idl8
-rw-r--r--offapi/com/sun/star/text/XFormField.idl2
-rw-r--r--offapi/com/sun/star/text/XMultiTextMarkup.idl4
-rw-r--r--offapi/com/sun/star/text/XTextTable.idl2
-rw-r--r--offapi/com/sun/star/text/fieldmaster/Bibliography.idl2
-rw-r--r--offapi/com/sun/star/text/fieldmaster/DDE.idl2
-rw-r--r--offapi/com/sun/star/text/fieldmaster/Database.idl4
-rw-r--r--offapi/com/sun/star/text/fieldmaster/SetExpression.idl2
-rw-r--r--offapi/com/sun/star/text/fieldmaster/User.idl2
-rw-r--r--offapi/com/sun/star/ui/dialogs/FilePicker.idl5
-rw-r--r--offapi/com/sun/star/util/MeasureUnit.idl1
-rw-r--r--offapi/com/sun/star/xml/sax/XFastShapeContextHandler.idl4
-rw-r--r--offapi/com/sun/star/xml/sax/XFastTokenHandler.idl2
-rw-r--r--offapi/prj/build.lst2
-rw-r--r--offapi/type_reference/typelibrary_history.txt13
-rw-r--r--offapi/type_reference/types.rdbbin6717440 -> 6717440 bytes
110 files changed, 2705 insertions, 813 deletions
diff --git a/offapi/com/sun/star/awt/KeyModifier.idl b/offapi/com/sun/star/awt/KeyModifier.idl
index ac4622cbd0c7..721f9befc044 100644
--- a/offapi/com/sun/star/awt/KeyModifier.idl
+++ b/offapi/com/sun/star/awt/KeyModifier.idl
@@ -49,7 +49,7 @@ published constants KeyModifier
//-------------------------------------------------------------------------
- /** refers in the most cases to the 'Ctrl' key.
+ /** refers in the most cases to the 'Ctrl' key (Cmd on Mac OS X).
*/
const short MOD1 = 2;
@@ -59,6 +59,9 @@ published constants KeyModifier
*/
const short MOD2 = 4;
+ /** refers in the most cases to the 'Ctrl' key (Mac OS X)
+ */
+ const short MOD3 = 8;
};
//=============================================================================
diff --git a/offapi/com/sun/star/awt/MouseWheelBehavior.idl b/offapi/com/sun/star/awt/MouseWheelBehavior.idl
new file mode 100755
index 000000000000..5a5d03a4c2e8
--- /dev/null
+++ b/offapi/com/sun/star/awt/MouseWheelBehavior.idl
@@ -0,0 +1,61 @@
+/*************************************************************************
+* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+*
+* Copyright 2009 by Sun Microsystems, Inc.
+*
+* 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_awt_MouseWheelBehavior_idl__
+#define __com_sun_star_awt_MouseWheelBehavior_idl__
+
+//=============================================================================
+
+module com { module sun { module star { module awt {
+
+//=============================================================================
+
+/** describes the scroll behavior of the mouse wheel for a control
+ @since OOo 3.2
+ */
+constants MouseWheelBehavior
+{
+ /** defines that the mouse wheel cannot be used to scroll through the control's content
+ */
+ const short SCROLL_DISABLED = 0;
+
+ /** defines that the mouse can only be used to scroll through the control's content if it currently
+ has the focus.
+ */
+ const short SCROLL_FOCUS_ONLY = 1;
+
+ /** defines that the mouse can be used to scroll through the control's content, no matter whether or not
+ it has the focus, as long as the mouse pointer is over the control.
+ */
+ const short SCROLL_ALWAYS = 2;
+};
+
+//=============================================================================
+
+}; }; }; };
+
+//=============================================================================
+
+#endif
diff --git a/offapi/com/sun/star/awt/UnoControlComboBoxModel.idl b/offapi/com/sun/star/awt/UnoControlComboBoxModel.idl
index d33d8f4d71ea..29328056f480 100644
--- a/offapi/com/sun/star/awt/UnoControlComboBoxModel.idl
+++ b/offapi/com/sun/star/awt/UnoControlComboBoxModel.idl
@@ -220,6 +220,14 @@ published service UnoControlComboBoxModel
@since OOo 3.1
*/
[optional, property] short WritingMode;
+
+ /** defines how the mouse wheel can be used to scroll through the control's content.
+
+ <p>Usually, the mouse wheel scrool through the control's entry list. Using this property,
+ and one of the <type>MouseWheelBehavior</type> constants, you can control under which circumstances
+ this is possible.</p>
+ */
+ [optional, property] short MouseWheelBehavior;
};
//=============================================================================
diff --git a/offapi/com/sun/star/awt/UnoControlCurrencyFieldModel.idl b/offapi/com/sun/star/awt/UnoControlCurrencyFieldModel.idl
index 0aa722943e2d..17f72a2be100 100644
--- a/offapi/com/sun/star/awt/UnoControlCurrencyFieldModel.idl
+++ b/offapi/com/sun/star/awt/UnoControlCurrencyFieldModel.idl
@@ -254,6 +254,14 @@ published service UnoControlCurrencyFieldModel
@since OOo 3.1
*/
[optional, property] short WritingMode;
+
+ /** defines how the mouse wheel can be used to scroll through the control's content.
+
+ <p>Usually, the mouse wheel spins the numeric value displayed in the control. Using this property,
+ and one of the <type>MouseWheelBehavior</type> constants, you can control under which circumstances
+ this is possible.</p>
+ */
+ [optional, property] short MouseWheelBehavior;
};
//=============================================================================
diff --git a/offapi/com/sun/star/awt/UnoControlDateFieldModel.idl b/offapi/com/sun/star/awt/UnoControlDateFieldModel.idl
index a636f2f5f6a5..d14f602e817a 100644
--- a/offapi/com/sun/star/awt/UnoControlDateFieldModel.idl
+++ b/offapi/com/sun/star/awt/UnoControlDateFieldModel.idl
@@ -266,6 +266,14 @@ published service UnoControlDateFieldModel
@since OOo 3.1
*/
[optional, property] short WritingMode;
+
+ /** defines how the mouse wheel can be used to scroll through the control's content.
+
+ <p>Usually, the mouse wheel spins the numeric value displayed in the control. Using this property,
+ and one of the <type>MouseWheelBehavior</type> constants, you can control under which circumstances
+ this is possible.</p>
+ */
+ [optional, property] short MouseWheelBehavior;
};
//=============================================================================
diff --git a/offapi/com/sun/star/awt/UnoControlFormattedFieldModel.idl b/offapi/com/sun/star/awt/UnoControlFormattedFieldModel.idl
index 346c76b6d41a..1575e1f6d6a6 100644
--- a/offapi/com/sun/star/awt/UnoControlFormattedFieldModel.idl
+++ b/offapi/com/sun/star/awt/UnoControlFormattedFieldModel.idl
@@ -299,6 +299,14 @@ published service UnoControlFormattedFieldModel
@since OOo 3.1
*/
[optional, property] short WritingMode;
+
+ /** defines how the mouse wheel can be used to scroll through the control's content.
+
+ <p>Usually, the mouse wheel spins the numeric value displayed in the control. Using this property,
+ and one of the <type>MouseWheelBehavior</type> constants, you can control under which circumstances
+ this is possible.</p>
+ */
+ [optional, property] short MouseWheelBehavior;
};
//=============================================================================
diff --git a/offapi/com/sun/star/awt/UnoControlListBoxModel.idl b/offapi/com/sun/star/awt/UnoControlListBoxModel.idl
index 239a00e967f6..56c50b74fe04 100644
--- a/offapi/com/sun/star/awt/UnoControlListBoxModel.idl
+++ b/offapi/com/sun/star/awt/UnoControlListBoxModel.idl
@@ -203,6 +203,14 @@ published service UnoControlListBoxModel
@since OOo 3.1
*/
[optional, property] short WritingMode;
+
+ /** defines how the mouse wheel can be used to scroll through the control's content.
+
+ <p>Usually, the mouse wheel scrool through the control's entry list. Using this property,
+ and one of the <type>MouseWheelBehavior</type> constants, you can control under which circumstances
+ this is possible.</p>
+ */
+ [optional, property] short MouseWheelBehavior;
};
//=============================================================================
diff --git a/offapi/com/sun/star/awt/UnoControlNumericFieldModel.idl b/offapi/com/sun/star/awt/UnoControlNumericFieldModel.idl
index 914c3ed5d6f4..4846980a974c 100644
--- a/offapi/com/sun/star/awt/UnoControlNumericFieldModel.idl
+++ b/offapi/com/sun/star/awt/UnoControlNumericFieldModel.idl
@@ -242,6 +242,14 @@ published service UnoControlNumericFieldModel
@since OOo 3.1
*/
[optional, property] short WritingMode;
+
+ /** defines how the mouse wheel can be used to scroll through the control's content.
+
+ <p>Usually, the mouse wheel spins the numeric value displayed in the control. Using this property,
+ and one of the <type>MouseWheelBehavior</type> constants, you can control under which circumstances
+ this is possible.</p>
+ */
+ [optional, property] short MouseWheelBehavior;
};
//=============================================================================
diff --git a/offapi/com/sun/star/awt/UnoControlPatternFieldModel.idl b/offapi/com/sun/star/awt/UnoControlPatternFieldModel.idl
index cccb61cb5487..b3bb7691e333 100644
--- a/offapi/com/sun/star/awt/UnoControlPatternFieldModel.idl
+++ b/offapi/com/sun/star/awt/UnoControlPatternFieldModel.idl
@@ -201,6 +201,14 @@ published service UnoControlPatternFieldModel
@since OOo 3.1
*/
[optional, property] short WritingMode;
+
+ /** defines how the mouse wheel can be used to scroll through the control's content.
+
+ <p>Usually, the mouse wheel spins the numeric value displayed in the control. Using this property,
+ and one of the <type>MouseWheelBehavior</type> constants, you can control under which circumstances
+ this is possible.</p>
+ */
+ [optional, property] short MouseWheelBehavior;
};
//=============================================================================
diff --git a/offapi/com/sun/star/awt/UnoControlSpinButtonModel.idl b/offapi/com/sun/star/awt/UnoControlSpinButtonModel.idl
index f4170c5a4fd2..696fb5255785 100644
--- a/offapi/com/sun/star/awt/UnoControlSpinButtonModel.idl
+++ b/offapi/com/sun/star/awt/UnoControlSpinButtonModel.idl
@@ -169,6 +169,14 @@ service UnoControlSpinButtonModel
is specified with this property.</p>
*/
[property] long RepeatDelay;
+
+ /** defines how the mouse wheel can be used to scroll through the control's content.
+
+ <p>Usually, the mouse wheel spins the numeric value displayed in the control. Using this property,
+ and one of the <type>MouseWheelBehavior</type> constants, you can control under which circumstances
+ this is possible.</p>
+ */
+ [optional, property] short MouseWheelBehavior;
};
//=============================================================================
diff --git a/offapi/com/sun/star/awt/UnoControlTimeFieldModel.idl b/offapi/com/sun/star/awt/UnoControlTimeFieldModel.idl
index 7b4bbcb5e8fe..79bed704660f 100644
--- a/offapi/com/sun/star/awt/UnoControlTimeFieldModel.idl
+++ b/offapi/com/sun/star/awt/UnoControlTimeFieldModel.idl
@@ -246,6 +246,14 @@ published service UnoControlTimeFieldModel
@since OOo 3.1
*/
[optional, property] short WritingMode;
+
+ /** defines how the mouse wheel can be used to scroll through the control's content.
+
+ <p>Usually, the mouse wheel spins the numeric value displayed in the control. Using this property,
+ and one of the <type>MouseWheelBehavior</type> constants, you can control under which circumstances
+ this is possible.</p>
+ */
+ [optional, property] short MouseWheelBehavior;
};
//=============================================================================
diff --git a/offapi/com/sun/star/awt/XDialog2.idl b/offapi/com/sun/star/awt/XDialog2.idl
index 7cd09c6eeb10..cd42d792cd0a 100644
--- a/offapi/com/sun/star/awt/XDialog2.idl
+++ b/offapi/com/sun/star/awt/XDialog2.idl
@@ -12,7 +12,7 @@ module com { module sun { module star { module awt {
//=============================================================================
-/** Makes it possible to end a dialog.
+/** Makes it possible to end a dialog and set a help id.
@since OOo 3.0
*/
@@ -22,6 +22,10 @@ interface XDialog2: com::sun::star::awt::XDialog
to return with the given result value.
*/
void endDialog ( [in] long Result );
+ /** sets the help id so that the standard help button action will
+ show the appropriate help page.
+ */
+ void setHelpId ( [in] long Id );
};
//=============================================================================
diff --git a/offapi/com/sun/star/awt/XUnitConversion.idl b/offapi/com/sun/star/awt/XUnitConversion.idl
index 6e8d185f2fdc..d94b5f66023a 100644
--- a/offapi/com/sun/star/awt/XUnitConversion.idl
+++ b/offapi/com/sun/star/awt/XUnitConversion.idl
@@ -60,23 +60,55 @@
interface XUnitConversion: com::sun::star::uno::XInterface
{
/** converts the given <type>Point</type>, which is specified in pixels, into the given logical unit
+
+ @param Point
+ A given <type>Point</type> in a well known type
+ @param TargetUnit
+ A type from <type scope="com::sun::star::util">MeasureUnit</type> in which the Point will convert to.
+
+ @return
+ Returns a new <type>Point</type> in the TargetUnit type format.
*/
- com::sun::star::awt::Point convertPointToLogic( [in] com::sun::star::awt::Point aPoint, [in] short TargetUnit )
+ com::sun::star::awt::Point convertPointToLogic( [in] com::sun::star::awt::Point Point, [in] short TargetUnit )
raises ( com::sun::star::lang::IllegalArgumentException );
/** converts the given <type>Point</type>, which is specified in the given logical unit, into pixels
- */
+
+ @param Point
+ A given Point in the SourceUnit type
+ @param SourceUnit
+ The type from <type scope="com::sun::star::util">MeasureUnit</type> of the Point.
+
+ @return
+ Return a new <type>Point</type> in Pixel type format.
+ */
com::sun::star::awt::Point convertPointToPixel( [in] com::sun::star::awt::Point aPoint, [in] short SourceUnit )
raises ( com::sun::star::lang::IllegalArgumentException );
/** converts the given <type>Size</type>, which is specified in pixels, into the given logical unit
+
+ @param aSize
+ A given <type>Size</type> in a well known type
+ @param TargetUnit
+ A type from <type scope="com::sun::star::util">MeasureUnit</type> in which the Size will convert to.
+
+ @return
+ Returns a new <type>Size</type> in the TargetUnit type format.
*/
com::sun::star::awt::Size convertSizeToLogic( [in] com::sun::star::awt::Size aSize, [in] short TargetUnit )
raises ( com::sun::star::lang::IllegalArgumentException );
/** converts the given <type>Size</type>, which is specified in the given logical unit, into pixels
- */
+
+ @param Size
+ A given <type>Size</type> in a well known type
+ @param TargetUnit
+ The type from <type scope="com::sun::star::util">MeasureUnit</type> of the Size.
+
+ @return
+ Returns a new <type>Size</type> in the TargetUnit type format.
+ */
com::sun::star::awt::Size convertSizeToPixel( [in] com::sun::star::awt::Size aSize, [in] short SourceUnit )
raises ( com::sun::star::lang::IllegalArgumentException );
diff --git a/offapi/com/sun/star/awt/makefile.mk b/offapi/com/sun/star/awt/makefile.mk
index ff4d827a298b..c0c501cbe2c5 100644
--- a/offapi/com/sun/star/awt/makefile.mk
+++ b/offapi/com/sun/star/awt/makefile.mk
@@ -127,6 +127,7 @@ IDLFILES=\
MessageBoxCommand.idl\
MouseButton.idl\
MouseEvent.idl\
+ MouseWheelBehavior.idl\
PaintEvent.idl\
Point.idl\
PopupMenuDirection.idl\
diff --git a/offapi/com/sun/star/chart/BubbleDiagram.idl b/offapi/com/sun/star/chart/BubbleDiagram.idl
new file mode 100644
index 000000000000..23a1088db9e6
--- /dev/null
+++ b/offapi/com/sun/star/chart/BubbleDiagram.idl
@@ -0,0 +1,69 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2008 by Sun Microsystems, Inc.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * $RCSfile: BubbleDiagram.idl,v $
+ * $Revision: 1.10 $
+ *
+ * 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_chart_BubbleDiagram_idl__
+#define __com_sun_star_chart_BubbleDiagram_idl__
+
+#ifndef __com_sun_star_chart_Diagram_idl__
+#include <com/sun/star/chart/Diagram.idl>
+#endif
+
+#ifndef __com_sun_star_chart_ChartAxisXSupplier_idl__
+#include <com/sun/star/chart/ChartAxisXSupplier.idl>
+#endif
+
+#ifndef __com_sun_star_chart_ChartTwoAxisYSupplier_idl__
+#include <com/sun/star/chart/ChartTwoAxisYSupplier.idl>
+#endif
+
+#ifndef __com_sun_star_chart_ChartStatistics_idl__
+#include <com/sun/star/chart/ChartStatistics.idl>
+#endif
+
+//=============================================================================
+
+ module com { module sun { module star { module chart {
+
+//=============================================================================
+
+/** a service for bubble diagrams. @since OOo 3.2
+ */
+published service BubbleDiagram
+{
+ service com::sun::star::chart::Diagram;
+ service com::sun::star::chart::ChartAxisXSupplier;
+ service com::sun::star::chart::ChartTwoAxisYSupplier;
+ [optional] service com::sun::star::chart::ChartStatistics;
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif
diff --git a/offapi/com/sun/star/chart/ChartTwoAxisXSupplier.idl b/offapi/com/sun/star/chart/ChartTwoAxisXSupplier.idl
index ba78af5e519b..5a1a5e43b7b2 100644
--- a/offapi/com/sun/star/chart/ChartTwoAxisXSupplier.idl
+++ b/offapi/com/sun/star/chart/ChartTwoAxisXSupplier.idl
@@ -66,11 +66,21 @@ published service ChartTwoAxisXSupplier
//-------------------------------------------------------------------------
- /** determines if the description of the secondary x-axis
- is shown or hidden.
- */
+ /** determines for the secondary x-axis
+ if the labels at the tick marks are shown or hidden.
+ */
[property] boolean HasSecondaryXAxisDescription;
+ //-------------------------------------------------------------------------
+
+ /** determines if the title of the secondary X-axis is shown or hidden.
+
+ @see ChartTitle
+
+ @since OOo 3.0
+ */
+ [optional, property] boolean HasSecondaryXAxisTitle;
+
};
//=============================================================================
diff --git a/offapi/com/sun/star/chart/ChartTwoAxisYSupplier.idl b/offapi/com/sun/star/chart/ChartTwoAxisYSupplier.idl
index 5d4d987e4baa..bc9eff064b0e 100644
--- a/offapi/com/sun/star/chart/ChartTwoAxisYSupplier.idl
+++ b/offapi/com/sun/star/chart/ChartTwoAxisYSupplier.idl
@@ -67,11 +67,21 @@ published service ChartTwoAxisYSupplier
//-------------------------------------------------------------------------
- /** determines if the description of the secondary
- y-axis is shown or hidden.
- */
+ /** determines for the secondary y-axis
+ if the labels at the tick marks are shown or hidden.
+ */
[property] boolean HasSecondaryYAxisDescription;
+ //-------------------------------------------------------------------------
+
+ /** determines if the title of the secondary y-axis is shown or hidden.
+
+ @see ChartTitle
+
+ @since OOo 3.0
+ */
+ [optional, property] boolean HasSecondaryYAxisTitle;
+
};
//=============================================================================
diff --git a/offapi/com/sun/star/chart/makefile.mk b/offapi/com/sun/star/chart/makefile.mk
index 359f07a15224..802c832ea154 100644
--- a/offapi/com/sun/star/chart/makefile.mk
+++ b/offapi/com/sun/star/chart/makefile.mk
@@ -46,6 +46,7 @@ IDLFILES=\
AccessibleChartDocumentView.idl\
AreaDiagram.idl\
BarDiagram.idl\
+ BubbleDiagram.idl\
Chart3DBarProperties.idl\
ChartArea.idl\
ChartAxis.idl\
diff --git a/offapi/com/sun/star/chart2/RectangularDataSource.idl b/offapi/com/sun/star/chart2/RectangularDataSource.idl
deleted file mode 100644
index 1f42b83a8afc..000000000000
--- a/offapi/com/sun/star/chart2/RectangularDataSource.idl
+++ /dev/null
@@ -1,89 +0,0 @@
-/*************************************************************************
- *
- * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
- *
- * Copyright 2008 by Sun Microsystems, Inc.
- *
- * OpenOffice.org - a multi-platform office productivity suite
- *
- * $RCSfile: RectangularDataSource.idl,v $
- * $Revision: 1.3 $
- *
- * 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_chart2_RectangularDataSource_idl
-#define com_sun_star_chart2_RectangularDataSource_idl
-
-#include <com/sun/star/chart/ChartDataRowSource.idl>
-#include <com/sun/star/chart/ChartDataArray.idl>
-
-#include <com/sun/star/chart2/DataSource.idl>
-
-module com
-{
-module sun
-{
-module star
-{
-module chart2
-{
-
-/** describes a data source that bases on a two-dimensional range of
- data, like a cell range in a spreadsheet.
-
- <p>Components supporting this service have the duty to interpret
- the given range in an appropriate way to represent a
- <type>DataSource</type>.</p>
- */
-service RectangularDataSource
-{
- /** A RectangularDataSource is certainly also a DataSource.
- */
- service DataSource;
-
- service ::com::sun::star::chart::ChartDataArray;
-
- /** contains a range string in the format specified by the Office
- XML format for tables, that refers to data in the table of a
- spreadsheet or a text document.
-
- <p>This range is used to determine the rectangular range
- chosen. The <member>DataSequence::SourceRange</member>
- properties of the <type>DataSequence</type>s are ignored for
- this type of <type>DataSource</type>.</p>
- */
- [property] string SourceRange;
-
- /** determines if the data referred to in
- <member>SourceRange</member> is split up into
- <type>DataSequence</type>s using rows
- (<member-scope="com::sun::star::chart">ChartDataRowSource::ROWS</member>)
- or columns
- (<member-scope="com::sun::star::chart">ChartDataRowSource::COLUMNS</member>).
- */
- [property] ::com::sun::star::chart::ChartDataRowSource DataRowSource;
-};
-
-} ; // chart2
-} ; // com
-} ; // sun
-} ; // star
-
-
-#endif
diff --git a/offapi/com/sun/star/chart2/data/DataProvider.idl b/offapi/com/sun/star/chart2/data/DataProvider.idl
index c425cd8867a3..f67a3f7e06d8 100644
--- a/offapi/com/sun/star/chart2/data/DataProvider.idl
+++ b/offapi/com/sun/star/chart2/data/DataProvider.idl
@@ -57,6 +57,10 @@ service DataProvider
internally into valid XML.
*/
[optional] interface ::com::sun::star::chart2::data::XRangeXMLConversion;
+
+ /** If set to false <FALSE/>, values from hidden cells are not returned.
+ */
+ [optional, property] boolean IncludeHiddenCells;
};
} ; // data
diff --git a/offapi/com/sun/star/chart2/data/DataSequence.idl b/offapi/com/sun/star/chart2/data/DataSequence.idl
index e8179185c64a..5a8bd505194b 100644
--- a/offapi/com/sun/star/chart2/data/DataSequence.idl
+++ b/offapi/com/sun/star/chart2/data/DataSequence.idl
@@ -140,14 +140,11 @@ service DataSequence
*/
[property] DataSequenceRole Role;
- /** If <TRUE/>, the values are hidden, and should therefore not be
- used. This may result in omitting a complete data series
- object on rendering.
+ /** If set to false <FALSE/>, values from hidden cells are not returned.
*/
- [optional, property] boolean IsHidden;
+ [optional, property] boolean IncludeHiddenCells;
- /** a sequence of indexes that identify data points that should
- not be rendered, because they are hidden in the underlying
+ /** a sequence of indexes that identify values that are hidden in the underlying
data provider.
*/
[optional, property] sequence< long > HiddenValues;
diff --git a/offapi/com/sun/star/drawing/FillProperties.idl b/offapi/com/sun/star/drawing/FillProperties.idl
index 47749376a7d5..9aaedfed601f 100644
--- a/offapi/com/sun/star/drawing/FillProperties.idl
+++ b/offapi/com/sun/star/drawing/FillProperties.idl
@@ -70,21 +70,21 @@ module com { module sun { module star { module drawing {
published service FillProperties
{
//-------------------------------------------------------------------------
- /** This enumeration selects the style with which the area will be filled.
+ /** This enumeration selects the style the area will be filled with.
*/
- [property] com::sun::star::drawing::FillStyle FillStyle;
+ [property] FillStyle FillStyle;
//-------------------------------------------------------------------------
- /** If the <type>FillStyle</type> is set to <const>FillStyle::SOLID</const>,
- this is the color used.
+ /** If the property <member>FillStyle</member> is set to <const>
+ FillStyle::SOLID</const>, this is the color used.
*/
[property] com::sun::star::util::Color FillColor;
//-------------------------------------------------------------------------
/** This is the transparence of the filled area.
- <p>This property is only valid if <type>FillStyle</type> is set to
- <const>FillStyle::SOLID</const>.
+ <p>This property is only valid if the property <member>FillStyle
+ </member> is set to <const>FillStyle::SOLID</const>.
*/
[property] short FillTransparence;
@@ -103,117 +103,168 @@ published service FillProperties
[optional, property] com::sun::star::awt::Gradient FillTransparenceGradient;
//-------------------------------------------------------------------------
- /** If the <type>FillStyle</type> is set to <const>FillStyle::GRADIENT</const>, this
- is the name of the used fill gradient style.
+ /** If the property <member>FillStyle</member> is set to <const>
+ FillStyle::GRADIENT</const>, this is the name of the used fill
+ gradient style.
*/
[property] string FillGradientName;
//-------------------------------------------------------------------------
- /** If the <type>FillStyle</type> is set to <const>FillStyle::GRADIENT</const>, this
- describes the gradient used.
+ /** If the property <member>FillStyle</member> is set to <const>
+ FillStyle::GRADIENT</const>, this describes the gradient used.
*/
[optional, property] com::sun::star::awt::Gradient FillGradient;
//-------------------------------------------------------------------------
- /** If the <type>FillStyle</type> is set to <const>FillStyle::GRADIENT</const>, this
- is the name of the used fill hatch style.
+ /** If the property <member>FillStyle</member> is set to <const>
+ FillStyle::HATCH</const>, this is the name of the used fill hatch
+ style.
*/
[property] string FillHatchName;
//-------------------------------------------------------------------------
- /** If the <type>FillStyle</type> is set to <const>FillStyle::HATCH</const>, this
- describes the hatch used.
+ /** If the property <member>FillStyle</member> is set to <const>
+ FillStyle::HATCH</const>, this describes the hatch used.
*/
- [optional, property] com::sun::star::drawing::Hatch FillHatch;
+ [optional, property] Hatch FillHatch;
//-------------------------------------------------------------------------
- /** If the <type>FillStyle</type> is set to <const>FillStyle::BITMAP</const>, this is
- the name of the used fill bitmap style.
+ /** if this is <TRUE/>, the transparent background of a
+ hatch filled area is drawn in the current background color.
+ */
+ [property] boolean FillBackground;
+
+ //-------------------------------------------------------------------------
+ /** If the property <memebr>FillStyle</member> is set to <const>
+ FillStyle::BITMAP</const>, this is the name of the used fill bitmap
+ style.
*/
[property] string FillBitmapName;
//-------------------------------------------------------------------------
- /** If the <type>FillStyle</type> is set to <const>FillStyle::BITMAP</const>, this is
- the bitmap used.
+ /** If the property <member>FillStyle</member> is set to <const>
+ FillStyle::BITMAP</const>, this is the bitmap used.
*/
[optional, property] com::sun::star::awt::XBitmap FillBitmap;
//-------------------------------------------------------------------------
- /** If the <type>FillStyle</type> is set to <const>FillStyle::BITMAP</const>, this is
- a URL to the bitmap used.
+ /** If the property <member>FillStyle</member> is set to <const>
+ FillStyle::BITMAP</const>, this is a URL to the bitmap used.
*/
[optional, property] string FillBitmapURL;
//-------------------------------------------------------------------------
/** This is the horizontal offset where the tile starts.
- <p>It is given in percent in relation to the width of the bitmap.
+ <p>It is given in percent in relation to the width of the bitmap.</p>
*/
- [property] short FillBitmapOffsetX;
+ [property] short FillBitmapPositionOffsetX;
//-------------------------------------------------------------------------
/** This is the vertical offset where the tile starts.
- It is given in percent in relation to the width of the bitmap.
+ <p>It is given in percent in relation to the height of the bitmap.</p>
*/
- [property] short FillBitmapOffsetY;
+ [property] short FillBitmapPositionOffsetY;
//-------------------------------------------------------------------------
/** Every second line of tiles is moved the given percent of the
witdh of the bitmap.
*/
- [property] short FillBitmapPositionOffsetX;
+ [property] short FillBitmapOffsetX;
//-------------------------------------------------------------------------
/** Every second row of tiles is moved the given percent of the
- width of the bitmap.
+ height of the bitmap.
*/
- [property] short FillBitmapPositionOffsetY;
+ [property] short FillBitmapOffsetY;
//-------------------------------------------------------------------------
/** The RectanglePoint specifies the position inside of the bitmap to
use as the top left position for rendering.
*/
- [property] com::sun::star::drawing::RectanglePoint FillBitmapRectanglePoint;
+ [property] RectanglePoint FillBitmapRectanglePoint;
//-------------------------------------------------------------------------
- /** specifies if the size is given in percentage or
- as an absolute value.
+ /** specifies if the size is given in percentage or as an absolute value.
- <p>If this is <TRUE/>, the properties FillBitmapSizeX
- and FillBitmapSizeY contain the size of the tile in percent
- of the size of the original bitmap. If this
- is <FALSE/>, the size of the tile is specified
- with 1/100th mm.
+ <p>If this is <TRUE/>, the properties <member>FillBitmapSizeX</member>
+ and <member>FillBitmapSizeY</member> contain the size of the tile in
+ percent of the size of the original bitmap. If this is <FALSE/>, the
+ size of the tile is specified with 1/100th mm.
*/
[property] boolean FillBitmapLogicalSize;
//-------------------------------------------------------------------------
/** This is the width of the tile for filling.
- <p>Depending on the property FillBitmapLogicalSize, this is
- either relative or absolute.
+ <p>Depending on the property <member>FillBitmapLogicalSize</member>,
+ this is either relative or absolute.
*/
[property] long FillBitmapSizeX;
//-------------------------------------------------------------------------
/** This is the height of the tile for filling.
- <p>Depending on the property FillBitmapLogicalSize, this
- is either relative or absolute.
+ <p>Depending on the property <member>FillBitmapLogicalSize</member>,
+ this is either relative or absolute.
*/
[property] long FillBitmapSizeY;
//-------------------------------------------------------------------------
/** this enum selects how a area is filled with a single bitmap.
+
+ <p>This property corresponds to the properties <member>
+ FillBitmapStretch</member> and <member>FillBitmapTile</member>.</p>
+
+ <p>If set to <const>BitmapMode::REPEAT</const>, the property
+ FillBitmapStretch is set to <FALSE/>, and the property FillBitmapTile
+ is set to <TRUE/>.</p>
+
+ <p>If set to <const>BitmapMode::STRETCH</const>, the property
+ FillBitmapStretch is set to <TRUE/>, and the property FillBitmapTile
+ is set to <FALSE/>.</p>
+
+ <p>If set to <const>BitmapMode::NO_REPEAT</const>, both properties
+ FillBitmapStretch and FillBitmapTile are set to <FALSE/>.</p>
*/
- [property] com::sun::star::drawing::BitmapMode FillBitmapMode;
+ [property] BitmapMode FillBitmapMode;
//-------------------------------------------------------------------------
- /** if this is <TRUE/>, the transparent background of a
- hatch filled area is drawn in the current background color
- */
- [property] boolean FillBackground;
+ /** if set, the fill bitmap is stretched to fill the area of the shape.
+
+ <p>This property should not be used anymore and is included here for
+ completeness. The <member>FillBitmapMode</member> property can be used
+ instead to set all supported bitmap modes.</p>
+
+ <p>If set to <TRUE/>, the value of the FillBitmapMode property changes
+ to <const>BitmapMode::STRETCH</const>. BUT: behaviour is undefined, if
+ the property <member>FillBitmapTile</member> is <TRUE/> too.</p>
+
+ <p>If set to <FALSE/>, the value of the FillBitmapMode property
+ changes to <const>BitmapMode::REPEAT</const> or <const>
+ BitmapMode::NO_REPEAT</const>, depending on the current value of the
+ <member>FillBitmapTile</member> property.</p>
+ */
+ [optional, property] boolean FillBitmapStretch;
+
+ //-------------------------------------------------------------------------
+ /** if set, the fill bitmap is repeated to fill the area of the shape.
+
+ <p>This property should not be used anymore and is included here for
+ completeness. The <member>FillBitmapMode</member> property can be used
+ instead to set all supported bitmap modes.</p>
+
+ <p>If set to <TRUE/>, the value of the FillBitmapMode property changes
+ to <const>BitmapMode::REPEAT</const>. BUT: behaviour is undefined, if
+ the property <member>FillBitmapStretch</member> is <TRUE/> too.</p>
+
+ <p>If set to <FALSE/>, the value of the FillBitmapMode property
+ changes to <const>BitmapMode::STRETCH</const> or <const>
+ BitmapMode::NO_REPEAT</const>, depending on the current value of the
+ <member>FillBitmapStretch</member> property.</p>
+ */
+ [optional, property] boolean FillBitmapTile;
//-------------------------------------------------------------------------
};
diff --git a/offapi/com/sun/star/form/XErrorListener.idl b/offapi/com/sun/star/form/XErrorListener.idl
index 3865f8093d8b..9d9905d643f3 100644
--- a/offapi/com/sun/star/form/XErrorListener.idl
+++ b/offapi/com/sun/star/form/XErrorListener.idl
@@ -54,6 +54,7 @@
<p>Please do <em><b>not</b></em> use anymore, this interface is superseeded
by <type scope="com::sun::star::sdb">XSQLErrorListener</type>.</p>
+@since foo
@deprecated
*/
published interface XErrorListener: com::sun::star::lang::XEventListener
diff --git a/offapi/com/sun/star/form/component/CommandButton.idl b/offapi/com/sun/star/form/component/CommandButton.idl
index d39a44ceb96a..ac01ea91c6f8 100644
--- a/offapi/com/sun/star/form/component/CommandButton.idl
+++ b/offapi/com/sun/star/form/component/CommandButton.idl
@@ -30,25 +30,12 @@
#ifndef __com_sun_star_form_component_CommandButton_idl__
#define __com_sun_star_form_component_CommandButton_idl__
-#ifndef __com_sun_star_form_FormControlModel_idl__
#include <com/sun/star/form/FormControlModel.idl>
-#endif
-
-#ifndef __com_sun_star_awt_UnoControlButtonModel_idl__
#include <com/sun/star/awt/UnoControlButtonModel.idl>
-#endif
-
-#ifndef __com_sun_star_form_XImageProducerSupplier_idl__
#include <com/sun/star/form/XImageProducerSupplier.idl>
-#endif
-
-#ifndef __com_sun_star_form_XApproveActionBroadcaster_idl__
#include <com/sun/star/form/XApproveActionBroadcaster.idl>
-#endif
-
-#ifndef __com_sun_star_form_FormButtonType_idl__
#include <com/sun/star/form/FormButtonType.idl>
-#endif
+#include <com/sun/star/form/XReset.idl>
//=============================================================================
@@ -101,6 +88,28 @@ published service CommandButton
@see com::sun::star::form::FormButtonType
*/
[property] string TargetURL;
+
+ /** specifies the default toggle state for the button, used when it is reset.
+
+ <p>This property is meaningful only when <member scope="com::sun::star::awt">UnoControlButtonModel::Toggle</member>
+ is <TRUE/>. In this case, the <code>DefaultState</code> controls to which <code>State</code> the button will
+ be reset.</p>
+
+ <p>For a given implementation of the interface, if this (optional) property is present, then also the optional
+ interface <type scope="com::sun::star::form">XReset</type> must be present.</p>
+ */
+ [optional, property] boolean DefaultState;
+
+ /** allows resetting the button
+
+ <p>This property is meaningful only when <member scope="com::sun::star::awt">UnoControlButtonModel::Toggle</member>
+ is <TRUE/>. In this case, the <code>DefaultState</code> controls to which <code>State</code> the button will
+ be reset, when <member scope="com::sun::star::form">XReset::reset</member> is invoked.</p>
+
+ <p>For a given implementation of the interface, if this (optional) interface is present, then also the optional
+ property <member>DefaultState</member> must be present.</p>
+ */
+ [optional] interface ::com::sun::star::form::XReset;
};
//=============================================================================
diff --git a/offapi/com/sun/star/linguistic2/Dictionary.idl b/offapi/com/sun/star/linguistic2/Dictionary.idl
index 4687db6af15b..38f97b9df435 100644
--- a/offapi/com/sun/star/linguistic2/Dictionary.idl
+++ b/offapi/com/sun/star/linguistic2/Dictionary.idl
@@ -57,7 +57,7 @@ module com { module sun { module star { module linguistic2 {
@see com::sun::star::linguistic2::DictionaryList
@see com::sun::star::linguistic2::XSearchableDictionaryList
- @since OOo 3.01
+ @since OOo 3.0.1
*/
service Dictionary
{
diff --git a/offapi/com/sun/star/linguistic2/LinguProperties.idl b/offapi/com/sun/star/linguistic2/LinguProperties.idl
index 3d57f7514221..674b4a7be8b0 100644
--- a/offapi/com/sun/star/linguistic2/LinguProperties.idl
+++ b/offapi/com/sun/star/linguistic2/LinguProperties.idl
@@ -27,6 +27,7 @@
* for a copy of the LGPLv3 License.
*
************************************************************************/
+
#ifndef __com_sun_star_linguistic2_LinguProperties_idl__
#define __com_sun_star_linguistic2_LinguProperties_idl__
@@ -65,10 +66,9 @@ published service LinguProperties
text or not when doing spellchecking or hyphenation, or using the
thesaurus.
- @deprecated
- @since OOo 3.01
+ @deprecated since OOo 3.0.1
*/
- [property] boolean IsGermanPreReform;
+ [property, maybevoid] boolean IsGermanPreReform;
//-------------------------------------------------------------------------
/** defines if the dictionary-list should be used for spellchecking
@@ -143,19 +143,17 @@ published service LinguProperties
/** indicates whether the markings for incorrectly spelled text should be
hidden or not.
- @deprecated
- @since OOo 3.01
+ @deprecated since OOo 3.0.1
*/
- [property] boolean IsSpellHide;
+ [property, maybevoid] boolean IsSpellHide;
//-------------------------------------------------------------------------
/** indicates if spellchecking should be performed in all available
languages.
- @deprecated
- @since OOo 3.01
+ @deprecated since OOo 3.0.1
*/
- [property] boolean IsSpellInAllLanguages;
+ [property, maybevoid] boolean IsSpellInAllLanguages;
//-------------------------------------------------------------------------
/** defines whether spellchecking should be done in special regions of
diff --git a/offapi/com/sun/star/linguistic2/LinguServiceEventFlags.idl b/offapi/com/sun/star/linguistic2/LinguServiceEventFlags.idl
index 7f4d6d3a1524..8da91044d97c 100644
--- a/offapi/com/sun/star/linguistic2/LinguServiceEventFlags.idl
+++ b/offapi/com/sun/star/linguistic2/LinguServiceEventFlags.idl
@@ -62,7 +62,7 @@ published constants LinguServiceEventFlags
//-------------------------------------------------------------------------
/** Request new proofreading of the document
- @since OOo 3.01
+ @since OOo 3.0.1
*/
const short PROOFREAD_AGAIN = 8;
diff --git a/offapi/com/sun/star/linguistic2/ProofreadingResult.idl b/offapi/com/sun/star/linguistic2/ProofreadingResult.idl
index d00a4ed8f8fb..b2334f7c4539 100644
--- a/offapi/com/sun/star/linguistic2/ProofreadingResult.idl
+++ b/offapi/com/sun/star/linguistic2/ProofreadingResult.idl
@@ -58,7 +58,7 @@ interface XProofreader;
//=============================================================================
/** holds the results from proofreading a sentence.
- @since OOo 3.01
+ @since OOo 3.0.1
*/
struct ProofreadingResult
{
diff --git a/offapi/com/sun/star/linguistic2/SingleProofreadingError.idl b/offapi/com/sun/star/linguistic2/SingleProofreadingError.idl
index b16ca8711d6e..851e0f8b8c64 100644
--- a/offapi/com/sun/star/linguistic2/SingleProofreadingError.idl
+++ b/offapi/com/sun/star/linguistic2/SingleProofreadingError.idl
@@ -45,7 +45,7 @@ module com { module sun { module star { module linguistic2 {
//=============================================================================
/** holds a single error found by the proofreader.
- @since OOo 3.01
+ @since OOo 3.0.1
*/
struct SingleProofreadingError
{
diff --git a/offapi/com/sun/star/linguistic2/XProofreader.idl b/offapi/com/sun/star/linguistic2/XProofreader.idl
index be7e34483239..d330a40c4e11 100644
--- a/offapi/com/sun/star/linguistic2/XProofreader.idl
+++ b/offapi/com/sun/star/linguistic2/XProofreader.idl
@@ -65,7 +65,7 @@ module com { module sun { module star { module linguistic2 {
//=============================================================================
/** API for proofreading a text
- @since OOo 3.01
+ @since OOo 3.0.1
*/
interface XProofreader: com::sun::star::linguistic2::XSupportedLocales
{
diff --git a/offapi/com/sun/star/linguistic2/XProofreadingIterator.idl b/offapi/com/sun/star/linguistic2/XProofreadingIterator.idl
index b1536cc3b5be..51da34d0fa6f 100644
--- a/offapi/com/sun/star/linguistic2/XProofreadingIterator.idl
+++ b/offapi/com/sun/star/linguistic2/XProofreadingIterator.idl
@@ -61,7 +61,7 @@ module com { module sun { module star { module linguistic2 {
//=============================================================================
/** API for the proofreading iterator that mediates between the document and the proofreader.
- @since OOo 3.01
+ @since OOo 3.0.1
*/
interface XProofreadingIterator: com::sun::star::uno::XInterface
{
diff --git a/offapi/com/sun/star/linguistic2/XSearchableDictionary.idl b/offapi/com/sun/star/linguistic2/XSearchableDictionary.idl
index ddbb8a273255..d52b8b00bb3d 100644
--- a/offapi/com/sun/star/linguistic2/XSearchableDictionary.idl
+++ b/offapi/com/sun/star/linguistic2/XSearchableDictionary.idl
@@ -60,7 +60,7 @@ interface XSearchableDictionary : com::sun::star::linguistic2::XDictionary
@see <type scope="com::sun::star::linguistic2">XDictionaryEntry</type>
@see <type scope="com::sun::star::linguistic2">XSearchableDictionaryList</type>
- @since OOo 3.01
+ @since OOo 3.0.1
*/
sequence< com::sun::star::linguistic2::XDictionaryEntry > searchSimilarEntries( [in] string aWord );
diff --git a/offapi/com/sun/star/linguistic2/XSetSpellAlternatives.idl b/offapi/com/sun/star/linguistic2/XSetSpellAlternatives.idl
index 8407fbe566c0..0637a9847e51 100644
--- a/offapi/com/sun/star/linguistic2/XSetSpellAlternatives.idl
+++ b/offapi/com/sun/star/linguistic2/XSetSpellAlternatives.idl
@@ -55,7 +55,7 @@ interface XSetSpellAlternatives : com::sun::star::uno::XInterface
/**
set the list of suggestions to be returned.
- @since OOo 3.01
+ @since OOo 3.0.1
*/
void setAlternatives( [in] sequence< string > aAlternatives );
@@ -64,7 +64,7 @@ interface XSetSpellAlternatives : com::sun::star::uno::XInterface
set the type of error found.
@see <tyoe scope="com::sun::star::linguistic2">SpellFailure</type>
- @since OOo 3.01
+ @since OOo 3.0.1
*/
void setFailureType( [in] short nFailureType );
diff --git a/offapi/com/sun/star/logging/DocumentIOLogRing.idl b/offapi/com/sun/star/logging/DocumentIOLogRing.idl
new file mode 100644
index 000000000000..a395ecff172e
--- /dev/null
+++ b/offapi/com/sun/star/logging/DocumentIOLogRing.idl
@@ -0,0 +1,66 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2008 by Sun Microsystems, Inc.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * $RCSfile: DocumentIOLogRing.idl,v $
+ * $Revision: 1.3 $
+ *
+ * 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_logging_DocumentIOLogRing_idl__
+#define __com_sun_star_logging_DocumentIOLogRing_idl__
+
+#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+#endif
+#ifndef __com_sun_star_beans_NamedValue_idl__
+#include <com/sun/star/beans/NamedValue.idl>
+#endif
+
+//=============================================================================
+
+module com { module sun { module star { module logging {
+
+interface XSimpleLogRing;
+
+//=============================================================================
+
+/** This singleton is intended to log the IO events related to loading/storing
+ of documents.
+
+ <p>
+ Please do not use the singleton without communication with source owner!
+ </p>
+
+ @since OOo 3.2
+ */
+singleton DocumentIOLogRing : XSimpleLogRing;
+
+//=============================================================================
+
+}; }; }; };
+
+//=============================================================================
+
+#endif
diff --git a/offapi/com/sun/star/logging/SimpleLogRing.idl b/offapi/com/sun/star/logging/SimpleLogRing.idl
new file mode 100644
index 000000000000..2e6fe010a092
--- /dev/null
+++ b/offapi/com/sun/star/logging/SimpleLogRing.idl
@@ -0,0 +1,72 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2008 by Sun Microsystems, Inc.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * $RCSfile: SimpleLogRing.idl,v $
+ * $Revision: 1.3 $
+ *
+ * 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_logging_SimpleLogRing_idl__
+#define __com_sun_star_logging_SimpleLogRing_idl__
+
+#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+#endif
+#ifndef __com_sun_star_beans_NamedValue_idl__
+#include <com/sun/star/beans/NamedValue.idl>
+#endif
+
+//=============================================================================
+
+module com { module sun { module star { module logging {
+
+interface XSimpleLogRing;
+
+//=============================================================================
+
+/** This service allows to log the events in a ring of specified size.
+
+ @since OOo 3.2
+ */
+service SimpleLogRing : XSimpleLogRing
+{
+ /** creates a ring of default size - 256 messages
+ */
+ create();
+
+ /** creates a ring of specified size
+ @param nSize
+ the number of messages in a ring
+ */
+ createWithSize( [in] long nSize );
+};
+
+//=============================================================================
+
+}; }; }; };
+
+//=============================================================================
+
+#endif
diff --git a/offapi/com/sun/star/logging/XSimpleLogRing.idl b/offapi/com/sun/star/logging/XSimpleLogRing.idl
new file mode 100644
index 000000000000..e3bd1b4929dc
--- /dev/null
+++ b/offapi/com/sun/star/logging/XSimpleLogRing.idl
@@ -0,0 +1,77 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2008 by Sun Microsystems, Inc.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * $RCSfile: XSimpleLogRing.idl,v $
+ * $Revision: 1.3 $
+ *
+ * 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_logging_XSimpleLogRing_idl__
+#define __com_sun_star_logging_XSimpleLogRing_idl__
+
+#ifndef __com_sun_star_uno_XInterface_idl__
+#include <com/sun/star/uno/XInterface.idl>
+#endif
+
+//=============================================================================
+
+module com { module sun { module star { module logging {
+
+//=============================================================================
+
+/** a simple log ring allowing to collect a limited number of last events
+
+ <p>
+ The intention of this interface is to provide a simple possibility
+ for developer to collect the most important events without affecting
+ the performance. For this reasons the messages related API is quite
+ simple, the strings should be produced by the preprocessor mainly.
+ </p>
+
+ @since OOo 3.2
+ */
+interface XSimpleLogRing
+{
+ /** allows to add a message to the logger
+ */
+ void logString( [in] string aMessage );
+
+ /** allows to get the collected messages from the logger
+
+ <p>
+ It is up to logger implementation to provide only the limited
+ number of last messages.
+ </p>
+ */
+ sequence< string > getCollectedLog();
+};
+
+//=============================================================================
+
+}; }; }; };
+
+//=============================================================================
+
+#endif
diff --git a/offapi/com/sun/star/logging/makefile.mk b/offapi/com/sun/star/logging/makefile.mk
index 2a92ba29cd3a..6686b04ae37a 100644
--- a/offapi/com/sun/star/logging/makefile.mk
+++ b/offapi/com/sun/star/logging/makefile.mk
@@ -40,17 +40,20 @@ PACKAGE := com$/sun$/star$/logging
IDLFILES = \
ConsoleHandler.idl\
CsvLogFormatter.idl\
+ DocumentIOLogRing.idl\
FileHandler.idl\
LoggerPool.idl\
LogLevel.idl\
LogRecord.idl\
PlainTextFormatter.idl\
+ SimpleLogRing.idl\
XConsoleHandler.idl\
XCsvLogFormatter.idl\
XLogFormatter.idl\
XLogger.idl\
XLoggerPool.idl\
- XLogHandler.idl
+ XLogHandler.idl\
+ XSimpleLogRing.idl
.INCLUDE: target.mk
.INCLUDE: $(PRJ)$/util$/target.pmk
diff --git a/offapi/com/sun/star/rdf/BlankNode.idl b/offapi/com/sun/star/rdf/BlankNode.idl
index f0534d68c441..e0ad2bb94a4e 100644
--- a/offapi/com/sun/star/rdf/BlankNode.idl
+++ b/offapi/com/sun/star/rdf/BlankNode.idl
@@ -62,7 +62,7 @@ service BlankNode : XBlankNode
another node that already exists in some repository.
That may or may not be what you want.
If you want to create a new blank node that is guaranteed to be unique,
- use <method>XRepository::createBlankNode</method> instead.
+ use <member>XRepository::createBlankNode</member> instead.
<p>
@param NodeID
diff --git a/offapi/com/sun/star/rdf/FileFormat.idl b/offapi/com/sun/star/rdf/FileFormat.idl
index f22ad9265039..d83b4bc66363 100644
--- a/offapi/com/sun/star/rdf/FileFormat.idl
+++ b/offapi/com/sun/star/rdf/FileFormat.idl
@@ -41,13 +41,13 @@ module com { module sun { module star { module rdf {
<p>
These constants are mainly for use with
- <method>XRepository::importGraph</method>
- and <method>XRepository::exportGraph</method>.
+ <member>XRepository::importGraph</member>
+ and <member>XRepository::exportGraph</member>.
</p>
<p>
- Note that these are integers because UNO IDL does not permit string
- constants.
+ Note that these are integers because UNO IDL does not permit
+ <atom>string</atom> constants.
</p>
@since OOo 3.0
diff --git a/offapi/com/sun/star/rdf/Statement.idl b/offapi/com/sun/star/rdf/Statement.idl
index 9d8692154755..18bb46bfb70e 100644
--- a/offapi/com/sun/star/rdf/Statement.idl
+++ b/offapi/com/sun/star/rdf/Statement.idl
@@ -43,7 +43,7 @@ module com { module sun { module star { module rdf {
//=============================================================================
/** represents a RDF statement, or triple.
- @since OOo 3.0
+ @since OOo 3.2
@see XRepository
*/
@@ -52,7 +52,7 @@ struct Statement
/// the subject of the RDF statement.
XResource Subject;
/// the predicate of the RDF statement.
- XResource Predicate;
+ XURI Predicate;
/// the object of the RDF statement.
XNode Object;
/// the named graph that contains this statement, or <NULL/>.
diff --git a/offapi/com/sun/star/rdf/URI.idl b/offapi/com/sun/star/rdf/URI.idl
index 2ccb100cac4f..8a4888c4efb7 100644
--- a/offapi/com/sun/star/rdf/URI.idl
+++ b/offapi/com/sun/star/rdf/URI.idl
@@ -58,7 +58,7 @@ service URI : XURI
/** creates an URI RDF node.
@param Value
- the URI, represented as string.
+ the URI, represented as <atom>string</atom>.
@throws com::sun::star::lang::IllegalArgumentException
if the argument does not represent a valid URI
@@ -70,10 +70,11 @@ service URI : XURI
/** creates an URI RDF node from namespace prefix and local name.
@param Namespace
- the namespace prefix of the URI, represented as string.
+ the namespace prefix of the URI, represented as
+ <atom>string</atom>.
@param LocalName
- the local name of the URI, represented as string.
+ the local name of the URI, represented as <atom>string</atom>.
@throws com::sun::star::lang::IllegalArgumentException
if the arguments do not represent a valid URI
diff --git a/offapi/com/sun/star/rdf/URIs.idl b/offapi/com/sun/star/rdf/URIs.idl
index 23a3ef3f7f62..19a49b4919a6 100644
--- a/offapi/com/sun/star/rdf/URIs.idl
+++ b/offapi/com/sun/star/rdf/URIs.idl
@@ -41,23 +41,103 @@ module com { module sun { module star { module rdf {
/** Constants to specify some well-known URIs.
<p>
- These constants are mainly for use with
- <method>URI::createKnown</method>.
+ These constants are for use with <member>URI::createKnown</member>.
</p>
- @since OOo 3.0
+ @since OOo 3.2
@see URI::createKnown
*/
constants URIs
{
-// /// http://www.w3.org/2001/XMLSchema#NCName
-//FIXME: XMLSchema-datatypes is preferred to XMLSchema in this context???
-
/// http://www.w3.org/2001/XMLSchema-datatypes#NCName
- const short XSD_NCNAME = 1;
+ const short XSD_NCNAME = 1;
/// http://www.w3.org/2001/XMLSchema-datatypes#string
- const short XSD_STRING = 2;
+ const short XSD_STRING = 2;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#normalizedString
+ const short XSD_NORMALIZEDSTRING = 3;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#boolean
+ const short XSD_BOOLEAN = 4;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#decimal
+ const short XSD_DECIMAL = 5;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#float
+ const short XSD_FLOAT = 6;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#double
+ const short XSD_DOUBLE = 7;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#integer
+ const short XSD_INTEGER = 8;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#nonNegativeInteger
+ const short XSD_NONNEGATIVEINTEGER = 9;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#positiveInteger
+ const short XSD_POSITIVEINTEGER = 10;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#nonPositiveInteger
+ const short XSD_NONPOSITIVEINTEGER = 11;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#negativeInteger
+ const short XSD_NEGATIVEINTEGER = 12;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#long
+ const short XSD_LONG = 13;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#int
+ const short XSD_INT = 14;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#short
+ const short XSD_SHORT = 15;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#byte
+ const short XSD_BYTE = 16;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#unsignedLong
+ const short XSD_UNSIGNEDLONG = 17;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#unsignedInt
+ const short XSD_UNSIGNEDINT = 18;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#unsignedShort
+ const short XSD_UNSIGNEDSHORT = 19;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#unsignedByte
+ const short XSD_UNSIGNEDBYTE = 20;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#hexBinary
+ const short XSD_HEXBINARY = 21;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#base64Binary
+ const short XSD_BASE64BINARY = 22;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#dateTime
+ const short XSD_DATETIME = 23;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#time
+ const short XSD_TIME = 24;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#date
+ const short XSD_DATE = 25;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#gYearMonth
+ const short XSD_GYEARMONTH = 26;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#gYear
+ const short XSD_GYEAR = 27;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#gMonthDay
+ const short XSD_GMONTHDAY = 28;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#gDay
+ const short XSD_GDAY = 29;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#gMonth
+ const short XSD_GMONTH = 30;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#anyURI
+ const short XSD_ANYURI = 31;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#token
+ const short XSD_TOKEN = 32;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#language
+ const short XSD_LANGUAGE = 33;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#NMTOKEN
+ const short XSD_NMTOKEN = 34;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#Name
+ const short XSD_NAME = 35;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#duration
+ const short XSD_DURATION = 36;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#QName
+ const short XSD_QNAME = 37;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#NOTATION
+ const short XSD_NOTATION = 38;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#NMTOKENS
+ const short XSD_NMTOKENS = 39;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#ID
+ const short XSD_ID = 40;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#IDREF
+ const short XSD_IDREF = 41;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#IDREFS
+ const short XSD_IDREFS = 42;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#ENTITY
+ const short XSD_ENTITY = 43;
+ /// http://www.w3.org/2001/XMLSchema-datatypes#ENTITIES
+ const short XSD_ENTITIES = 44;
/// http://www.w3.org/1999/02/22-rdf-syntax-ns#type
const short RDF_TYPE = 1000;
@@ -71,56 +151,179 @@ constants URIs
const short RDF_PROPERTY = 1004;
/// http://www.w3.org/1999/02/22-rdf-syntax-ns#Statement
const short RDF_STATEMENT = 1005;
+ /// http://www.w3.org/1999/02/22-rdf-syntax-ns#value
+ const short RDF_VALUE = 1006;
+ /// http://www.w3.org/1999/02/22-rdf-syntax-ns#first
+ const short RDF_FIRST = 1007;
+ /// http://www.w3.org/1999/02/22-rdf-syntax-ns#rest
+ const short RDF_REST = 1008;
+ /// http://www.w3.org/1999/02/22-rdf-syntax-ns#nil
+ const short RDF_NIL = 1009;
+ /// http://www.w3.org/1999/02/22-rdf-syntax-ns#XMLLiteral
+ const short RDF_XMLLITERAL = 1010;
+ /// http://www.w3.org/1999/02/22-rdf-syntax-ns#Alt
+ const short RDF_ALT = 1011;
+ /// http://www.w3.org/1999/02/22-rdf-syntax-ns#Bag
+ const short RDF_BAG = 1012;
+ /// http://www.w3.org/1999/02/22-rdf-syntax-ns#List
+ const short RDF_LIST = 1013;
+ /// http://www.w3.org/1999/02/22-rdf-syntax-ns#Seq
+ const short RDF_SEQ = 1014;
+ /// http://www.w3.org/1999/02/22-rdf-syntax-ns#_1
+ const short RDF_1 = 1015;
+ /* hmm... that's a lot of potential constants:
+ _n where n is a decimal integer greater than zero with no leading zeros.
+ */
/// http://www.w3.org/2000/01/rdf-schema#comment
- const short RDFS_COMMENT = 1100;
+ const short RDFS_COMMENT = 1100;
/// http://www.w3.org/2000/01/rdf-schema#label
- const short RDFS_LABEL = 1101;
+ const short RDFS_LABEL = 1101;
/// http://www.w3.org/2000/01/rdf-schema#domain
- const short RDFS_DOMAIN = 1102;
+ const short RDFS_DOMAIN = 1102;
/// http://www.w3.org/2000/01/rdf-schema#range
- const short RDFS_RANGE = 1103;
+ const short RDFS_RANGE = 1103;
/// http://www.w3.org/2000/01/rdf-schema#subClassOf
- const short RDFS_SUBCLASSOF = 1104;
+ const short RDFS_SUBCLASSOF = 1104;
/// http://www.w3.org/2000/01/rdf-schema#Literal
- const short RDFS_LITERAL = 1105;
+ const short RDFS_LITERAL = 1105;
+ /// http://www.w3.org/2000/01/rdf-schema#member
+ const short RDFS_MEMBER = 1106;
+ /// http://www.w3.org/2000/01/rdf-schema#subPropertyOf
+ const short RDFS_SUBPROPERTYOF = 1107;
+ /// http://www.w3.org/2000/01/rdf-schema#isDefinedBy
+ const short RDFS_ISDEFINEDBY = 1108;
+ /// http://www.w3.org/2000/01/rdf-schema#seeAlso
+ const short RDFS_SEEALSO = 1109;
+ /// http://www.w3.org/2000/01/rdf-schema#Resource
+ const short RDFS_RESOURCE = 1110;
+ /// http://www.w3.org/2000/01/rdf-schema#Class
+ const short RDFS_CLASS = 1111;
+ /// http://www.w3.org/2000/01/rdf-schema#Datatype
+ const short RDFS_DATATYPE = 1112;
+ /// http://www.w3.org/2000/01/rdf-schema#Container
+ const short RDFS_CONTAINER = 1113;
+ /// http://www.w3.org/2000/01/rdf-schema#ContainerMembershipProperty
+ const short RDFS_CONTAINERMEMBERSHIPPROPERTY = 1114;
/// http://www.w3.org/2002/07/owl#Class
- const short OWL_CLASS = 1200;
+ const short OWL_CLASS = 1200;
/// http://www.w3.org/2002/07/owl#ObjectProperty
- const short OWL_OBJECTPROPERTY = 1201;
+ const short OWL_OBJECTPROPERTY = 1201;
/// http://www.w3.org/2002/07/owl#DatatypeProperty
- const short OWL_DATATYPEPROPERTY = 1202;
+ const short OWL_DATATYPEPROPERTY = 1202;
/// http://www.w3.org/2002/07/owl#FunctionalProperty
- const short OWL_FUNCTIONALPROPERTY = 1203;
+ const short OWL_FUNCTIONALPROPERTY = 1203;
+ /// http://www.w3.org/2002/07/owl#Thing
+ const short OWL_THING = 1204;
+ /// http://www.w3.org/2002/07/owl#Nothing
+ const short OWL_NOTHING = 1205;
+ /// http://www.w3.org/2002/07/owl#Individual
+ const short OWL_INDIVIDUAL = 1206;
+ /// http://www.w3.org/2002/07/owl#equivalentClass
+ const short OWL_EQUIVALENTCLASS = 1207;
+ /// http://www.w3.org/2002/07/owl#equivalentProperty
+ const short OWL_EQUIVALENTPROPERTY = 1208;
+ /// http://www.w3.org/2002/07/owl#sameAs
+ const short OWL_SAMEAS = 1209;
+ /// http://www.w3.org/2002/07/owl#differentFrom
+ const short OWL_DIFFERENTFROM = 1210;
+ /// http://www.w3.org/2002/07/owl#AllDifferent
+ const short OWL_ALLDIFFERENT = 1211;
+ /// http://www.w3.org/2002/07/owl#distinctMembers
+ const short OWL_DISTINCTMEMBERS = 1212;
+ /// http://www.w3.org/2002/07/owl#inverseOf
+ const short OWL_INVERSEOF = 1213;
+ /// http://www.w3.org/2002/07/owl#TransitiveProperty
+ const short OWL_TRANSITIVEPROPERTY = 1214;
+ /// http://www.w3.org/2002/07/owl#SymmetricProperty
+ const short OWL_SYMMETRICPROPERTY = 1215;
+ /// http://www.w3.org/2002/07/owl#InverseFunctionalProperty
+ const short OWL_INVERSEFUNCTIONALPROPERTY = 1216;
+ /// http://www.w3.org/2002/07/owl#Restriction
+ const short OWL_RESTRICTION = 1217;
+ /// http://www.w3.org/2002/07/owl#onProperty
+ const short OWL_ONPROPERTY = 1218;
+ /// http://www.w3.org/2002/07/owl#allValuesFrom
+ const short OWL_ALLVALUESFROM = 1219;
+ /// http://www.w3.org/2002/07/owl#someValuesFrom
+ const short OWL_SOMEVALUESFROM = 1220;
+ /// http://www.w3.org/2002/07/owl#minCardinality
+ const short OWL_MINCARDINALITY = 1221;
+ /// http://www.w3.org/2002/07/owl#maxCardinality
+ const short OWL_MAXCARDINALITY = 1222;
+ /// http://www.w3.org/2002/07/owl#cardinality
+ const short OWL_CARDINALITY = 1223;
+ /// http://www.w3.org/2002/07/owl#Ontology
+ const short OWL_ONTOLOGY = 1224;
+ /// http://www.w3.org/2002/07/owl#imports
+ const short OWL_IMPORTS = 1225;
+ /// http://www.w3.org/2002/07/owl#versionInfo
+ const short OWL_VERSIONINFO = 1226;
+ /// http://www.w3.org/2002/07/owl#priorVersion
+ const short OWL_PRIORVERSION = 1227;
+ /// http://www.w3.org/2002/07/owl#backwardCompatibleWith
+ const short OWL_BACKWARDCOMPATIBLEWITH = 1228;
+ /// http://www.w3.org/2002/07/owl#incompatibleWith
+ const short OWL_INCOMPATIBLEWITH = 1229;
+ /// http://www.w3.org/2002/07/owl#DeprecatedClass
+ const short OWL_DEPRECATEDCLASS = 1230;
+ /// http://www.w3.org/2002/07/owl#DeprecatedProperty
+ const short OWL_DEPRECATEDPROPERTY = 1231;
+ /// http://www.w3.org/2002/07/owl#AnnotationProperty
+ const short OWL_ANNOTATIONPROPERTY = 1232;
+ /// http://www.w3.org/2002/07/owl#OntologyProperty
+ const short OWL_ONTOLOGYPROPERTY = 1233;
+ /// http://www.w3.org/2002/07/owl#oneOf
+ const short OWL_ONEOF = 1234;
+ /// http://www.w3.org/2002/07/owl#dataRange
+ const short OWL_DATARANGE = 1235;
+ /// http://www.w3.org/2002/07/owl#disjointWith
+ const short OWL_DISJOINTWITH = 1236;
+ /// http://www.w3.org/2002/07/owl#unionOf
+ const short OWL_UNIONOF = 1237;
+ /// http://www.w3.org/2002/07/owl#complementOf
+ const short OWL_COMPLEMENTOF = 1238;
+ /// http://www.w3.org/2002/07/owl#intersectionOf
+ const short OWL_INTERSECTIONOF = 1239;
+ /// http://www.w3.org/2002/07/owl#hasValue
+ const short OWL_HASVALUE = 1240;
- /// http://docs.oasis-open.org/opendocument/meta/package/common#hasPart
- const short PKG_HASPART = 2000;
- /// http://docs.oasis-open.org/opendocument/meta/package/common#idref
+ /// http://docs.oasis-open.org/ns/office/1.2/meta/pkg#hasPart
+ const short PKG_HASPART = 2000;
+/* REMOVED
+ /// http://docs.oasis-open.org/ns/office/1.2/meta/pkg#idref
const short PKG_IDREF = 2001;
- /// http://docs.oasis-open.org/opendocument/meta/package/common#path
+ /// http://docs.oasis-open.org/ns/office/1.2/meta/pkg#path
const short PKG_PATH = 2002;
- /// http://docs.oasis-open.org/opendocument/meta/package/common#mimeType
- const short PKG_MIMETYPE = 2003;
- /// http://docs.oasis-open.org/opendocument/meta/package/common#Package
- const short PKG_PACKAGE = 2004;
- /// http://docs.oasis-open.org/opendocument/meta/package/common#Element
- const short PKG_ELEMENT = 2005;
- /// http://docs.oasis-open.org/opendocument/meta/package/common#File
- const short PKG_FILE = 2006;
-
- /// http://docs.oasis-open.org/opendocument/meta/package/odf#prefix
+*/
+ /// http://docs.oasis-open.org/ns/office/1.2/meta/pkg#mimeType
+ const short PKG_MIMETYPE = 2003;
+ /// http://docs.oasis-open.org/ns/office/1.2/meta/pkg#Package
+ const short PKG_PACKAGE = 2004;
+ /// http://docs.oasis-open.org/ns/office/1.2/meta/pkg#Element
+ const short PKG_ELEMENT = 2005;
+ /// http://docs.oasis-open.org/ns/office/1.2/meta/pkg#File
+ const short PKG_FILE = 2006;
+ /// http://docs.oasis-open.org/ns/office/1.2/meta/pkg#MetadataFile
+ const short PKG_METADATAFILE = 2007;
+ /// http://docs.oasis-open.org/ns/office/1.2/meta/pkg#Document
+ const short PKG_DOCUMENT = 2008;
+
+ /// http://docs.oasis-open.org/ns/office/1.2/meta/odf#prefix
const short ODF_PREFIX = 2100;
- /// http://docs.oasis-open.org/opendocument/meta/package/odf#suffix
+ /// http://docs.oasis-open.org/ns/office/1.2/meta/odf#suffix
const short ODF_SUFFIX = 2101;
- /// http://docs.oasis-open.org/opendocument/meta/package/odf#Element
+ /// http://docs.oasis-open.org/ns/office/1.2/meta/odf#Element
const short ODF_ELEMENT = 2102;
- /// http://docs.oasis-open.org/opendocument/meta/package/odf#ContentFile
+ /// http://docs.oasis-open.org/ns/office/1.2/meta/odf#ContentFile
const short ODF_CONTENTFILE = 2103;
- /// http://docs.oasis-open.org/opendocument/meta/package/odf#StylesFile
+ /// http://docs.oasis-open.org/ns/office/1.2/meta/odf#StylesFile
const short ODF_STYLESFILE = 2104;
- /// http://docs.oasis-open.org/opendocument/meta/package/odf#MetadataFile
+/* REMOVED
+ /// http://docs.oasis-open.org/ns/office/1.2/meta/odf#MetadataFile
const short ODF_METADATAFILE = 2105;
+*/
/// urn:oasis:names:tc:opendocument:xmlns:text:1.0meta-field
// const short TEXT_META_FIELD = 3000;
diff --git a/offapi/com/sun/star/rdf/XDocumentMetadataAccess.idl b/offapi/com/sun/star/rdf/XDocumentMetadataAccess.idl
index 6eda7bf0da0e..9c82d75546a3 100644
--- a/offapi/com/sun/star/rdf/XDocumentMetadataAccess.idl
+++ b/offapi/com/sun/star/rdf/XDocumentMetadataAccess.idl
@@ -55,6 +55,10 @@
#include <com/sun/star/io/IOException.idl>
#endif
+#ifndef __com_sun_star_io_XInputStream_idl__
+#include <com/sun/star/io/XInputStream.idl>
+#endif
+
#ifndef __com_sun_star_datatransfer_UnsupportedFlavorException_idl__
#include <com/sun/star/datatransfer/UnsupportedFlavorException.idl>
#endif
@@ -63,8 +67,8 @@
#include <com/sun/star/embed/XStorage.idl>
#endif
-#ifndef __com_sun_star_io_XInputStream_idl__
-#include <com/sun/star/io/XInputStream.idl>
+#ifndef __com_sun_star_task_XInteractionHandler_idl__
+#include <com/sun/star/task/XInteractionHandler.idl>
#endif
#ifndef __com_sun_star_rdf_FileFormat_idl__
@@ -100,20 +104,15 @@ module com { module sun { module star { module rdf {
the content and the RDF metadata of an ODF document.
The main idea is to make querying and manipulating the
data in the metadata manifest easier.
- Among other things, the metadata manifest contains a mapping between ODF
- elements (in the "content.xml" and "styles.xml" streams) and URIs.
- Such a mapping works by associating the XML ID of the ODF element with
- the URI by an RDF statement of the form:
- <code>URI pkg:idref XmlId.</code>
</p>
<p>
- Note that this interface inherits from <type>XResource</type>: the
- UUID of the package is the string value of the RDF node.
- This is so that you can easily make RDF statements about the package.
+ Note that this interface inherits from <type>XURI</type>: the
+ base URI of the document is the string value of the RDF node.
+ This is so that you can easily make RDF statements about the document.
</p>
- @since OOo 3.0
+ @since OOo 3.2
@see XDocumentRepository
*/
@@ -123,33 +122,22 @@ interface XDocumentMetadataAccess
interface XRepositorySupplier;
//-------------------------------------------------------------------------
- /** get the UUID for the ODF package.
+ /** get the unique ODF element with the given metadata reference.
- @returns
- a universally unique ID that identifies this ODF package
- */
- string getPackageUUID();
-
- //-------------------------------------------------------------------------
- /** get the unique ODF element with the given XML ID.
-
- @param XmlId
- an XML ID, comprising the stream name and the "xml:id" attribute.
- For example: "content.xml#foo-element-1"
+ @param MetadataReference
+ a metadata reference, comprising the stream name and the XML ID
+ For example: Pair("content.xml", "foo-element-1")
@returns
- the ODF element with the given XML ID if it exists, else <NULL/>
+ the ODF element with the given metadata references if it exists,
+ else <NULL/>
*/
- XMetadatable getElementByXmlId([in] string XmlId);
+ XMetadatable getElementByMetadataReference(
+ [in] com::sun::star::beans::StringPair MetadataReference);
//-------------------------------------------------------------------------
/** get the ODF element that corresponds to an URI.
- <p>
- Convenience method that uses the mapping established in the
- "manifest.rdf" to locate the ODF element corresponding to an URI.
- </p>
-
@param URI
an URI that may identify an ODF element
@@ -163,94 +151,6 @@ interface XDocumentMetadataAccess
raises( com::sun::star::lang::IllegalArgumentException );
//-------------------------------------------------------------------------
- /** find the URI that is associated with an ODF element in the manifest.
-
- @param Element
- the ODF element for which the URI should be returned
-
- @returns
- the URI associated with the element, or <NULL/>
-
- @throws com::sun::star::lang::IllegalArgumentException
- if the given Element is <NULL/>
- */
- XURI getURIForElement([in] XMetadatable Element)
- raises( com::sun::star::lang::IllegalArgumentException );
-
- //-------------------------------------------------------------------------
- /** create an URI for an ODF element.
-
- <p>
- Convenience method that generates an URI for the given ODF element,
- and inserts a mapping between the URI and the XML ID of the ODF element
- into the manifest.
- If the element does not have a XML ID yet, a new XML ID will be
- generated.
- If an URI for the element already exists, it will be returned.
- </p>
-
- @param Element
- the ODF element for which an URI should be created.
-
- @returns
- the URI associated with the element
-
- @throws com::sun::star::lang::IllegalArgumentException
- if the given Element is <NULL/>
- */
- XURI getOrCreateURIForElement([in] XMetadatable Element)
- raises( com::sun::star::lang::IllegalArgumentException );
-
- //-------------------------------------------------------------------------
- /** establish mapping between an ODF Element and an URI in the manifest.
-
- <p>
- This method Convenience method that generates an URI for the given
- ODF element, and inserts a mapping between the URI and the XML ID
- of the ODF element into the manifest.
- If the element does not have a XML ID yet, a new XML ID will be
- generated.
- If there already exists an URI for the element, the mapping will not
- be changed, and an
- <type scope="com::sun::star::container">ElementExistException</type>
- will be thrown.
- </p>
-
- <p>
- Note that the mapping maintained by this method is a one-to-one
- mapping, even though the specification technically permits
- mapping an XML ID to multiple URIs.
- </p>
-
- @param Element
- the ODF element with which an URI should be associated
-
- @param URI
- the URI which should be associated with the Element
-
- @throws com::sun::star::lang::IllegalArgumentException
- if any argument is <NULL/>
-
- @throws com::sun::star::container::ElementExistException
- if either the URI or the XML ID of the Element is already mapped
- */
- void createMappingForElement([in] XMetadatable Element, [in] XURI URI)
- raises( com::sun::star::lang::IllegalArgumentException,
- com::sun::star::container::ElementExistException );
-
- //-------------------------------------------------------------------------
- /** removes mapping for an ODF element from the manifest.
-
- @param Element
- the ODF element for which the mapping should be removed
-
- @throws com::sun::star::lang::IllegalArgumentException
- if the given Element is <NULL/>
- */
- void removeMappingForElement([in] XMetadatable Element)
- raises( com::sun::star::lang::IllegalArgumentException );
-
- //-------------------------------------------------------------------------
/** get the names of all metadata files with a given type.
@param Type
@@ -272,8 +172,8 @@ interface XDocumentMetadataAccess
<p>
This convenience method does the following:
<ul>
- <li>create a new graph with the given GraphName in the repository</li>
- <li>insert the required statements declaring the new graph to be a
+ <li>create a new graph with the given name in the repository</li>
+ <li>insert statements declaring the new graph to be a
metadata file into the manifest graph</li>
<li>insert statements declaring <code>rdf:type</code> properties
for the new graph into the manifest graph</li>
@@ -281,24 +181,23 @@ interface XDocumentMetadataAccess
</p>
@param FileName
- the name of the stream in the ODF package where the graph will
+ the name of the stream in the ODF storage where the graph will
be stored
- @param GraphName
- the name of the graph that is to be created
-
@param Types
a list of types that will be inserted as <code>rdf:type</code>
properties for the graph
+ @returns
+ the name of the new graph
+
@throws com::sun::star::lang::IllegalArgumentException
- if the given GraphName is <NULL/>, or the FileName is invalid
+ if the FileName is invalid
@throws com::sun::star::container::ElementExistException
- if a graph with the given GraphName, or a stream with the given
- FileName, already exists
+ if a stream with the given FileName already exists
*/
- void addMetadataFile([in] string FileName, [in] XURI GraphName,
+ XURI addMetadataFile([in] string FileName,
[in] sequence<XURI> Types )
raises( com::sun::star::lang::IllegalArgumentException,
com::sun::star::container::ElementExistException );
@@ -309,19 +208,18 @@ interface XDocumentMetadataAccess
<p>
This convenience method does the following:
- <li>import the given file into a graph with the given GraphName
+ <li>import the given file into a graph with the given name
in the repository</li>
- <li>insert the required statements declaring the new graph to be a
+ <li>insert statements declaring the new graph to be a
metadata file into the manifest graph</li>
+ <li>insert statements declaring <code>rdf:type</code> properties
+ for the new graph into the manifest graph</li>
</p>
@param FileName
- the name of the stream in the ODF package where the graph will
+ the name of the stream in the ODF storage where the graph will
be stored
- @param GraphName
- the name of the graph that is to be created
-
@param BaseURI
a base URI to resolve relative URI references
@@ -329,8 +227,11 @@ interface XDocumentMetadataAccess
a list of types that will be inserted as <code>rdf:type</code>
properties for the graph
+ @returns
+ the name of the new graph
+
@throws com::sun::star::lang::IllegalArgumentException
- if the given stream or the GraphName is <NULL/>,
+ if the given stream is <NULL/>,
or BaseURI is <NULL/> and the format requires use of a base URI,
or the FileName is invalid
@@ -338,8 +239,7 @@ interface XDocumentMetadataAccess
if the format requested is unknown or not supported
@throws com::sun::star::container::ElementExistException
- if a graph with the given GraphName, or a stream with the given
- FileName, already exists
+ if a stream with the given FileName already exists
@throws ParseException
if the input does not conform to the specified file format.
@@ -349,9 +249,9 @@ interface XDocumentMetadataAccess
@see FileFormat
*/
- void importMetadataFile( [in] /*FileFormat*/ short Format,
+ XURI importMetadataFile( [in] /*FileFormat*/ short Format,
[in] com::sun::star::io::XInputStream InStream,
- [in] string FileName, [in] XURI GraphName, [in] XURI BaseURI,
+ [in] string FileName, [in] XURI BaseURI,
[in] sequence<XURI> Types )
raises( com::sun::star::lang::IllegalArgumentException,
com::sun::star::datatransfer::UnsupportedFlavorException,
@@ -398,7 +298,7 @@ interface XDocumentMetadataAccess
</p>
@param FileName
- the name of the stream in the ODF package
+ the name of the stream in the ODF storage
@throws com::sun::star::lang::IllegalArgumentException
if the FileName is invalid
@@ -415,12 +315,11 @@ interface XDocumentMetadataAccess
<p>
This convenience method removes the statements declaring a
- content or styles file from the manifest graph, as well as
- all mappings that refer to the file.
+ content or styles file from the manifest graph.
</p>
@param FileName
- the name of the stream in the ODF package
+ the name of the stream in the ODF storage
@throws com::sun::star::lang::IllegalArgumentException
if the FileName is invalid
@@ -447,22 +346,35 @@ interface XDocumentMetadataAccess
In this case, the document metadata will be default initialized.
</p>
+ <p>
+ If an InteractionHandler argument is given, it will be used for
+ error reporting. Otherwise, errors will be reported as exceptions.
+ </p>
+
@param Storage
- a storage, representing e.g. an ODF package file
+ a storage, representing e.g. an ODF package file, or sub-document
@param BaseURI
a base URI to resolve relative URI references
+ <p>N.B.: when loading from an ODF package, the base URI is not the
+ URI of the package, but the URI of the directory in the package
+ that contains the metadata.rdf</p>
+
+ @param InteractionHandler
+ an InteractionHandler, used for error reporting
@throws com::sun::star::lang::IllegalArgumentException
if any argument is <NULL/>
+
+ @throws com::sun::star::lang::WrappedTargetException
+ if an error occurs while loading and no InteractionHandler given
*/
-//FIXME: how to do error handling??? this thing must be able to report any number of errors in any number of streams... XInteractionHandler???
void loadMetadataFromStorage(
[in] com::sun::star::embed::XStorage Storage,
- [in] XURI BaseURI)
- raises( com::sun::star::lang::IllegalArgumentException );
-// com::sun::star::io::IOException,
-// com::sun::star::);
+ [in] XURI BaseURI,
+ [in] com::sun::star::task::XInteractionHandler InteractionHandler )
+ raises( com::sun::star::lang::IllegalArgumentException,
+ com::sun::star::lang::WrappedTargetException );
//-------------------------------------------------------------------------
/** store document metadata to a storage.
@@ -474,28 +386,29 @@ interface XDocumentMetadataAccess
<p>
Note that to be stored correctly, a named graph must have a complete
- entry in the manifest graph, with a <code>pkg:path</code> property
- that denotes a legal stream name.
+ entry in the manifest graph.
</p>
@param Storage
- a storage, representing e.g. an ODF package file
+ a storage, representing e.g. an ODF package file, or sub-document
@throws com::sun::star::lang::IllegalArgumentException
- if any argument is <NULL/>
+ if Storage argument is <NULL/>
+
+ @throws com::sun::star::lang::WrappedTargetException
+ if an error occurs while loading
*/
-//FIXME error handling
void storeMetadataToStorage(
- [in] com::sun::star::embed::XStorage Storage)
- raises( com::sun::star::lang::IllegalArgumentException );
-// com::sun::star::io::IOException,
-// com::sun::star:: );
+ [in] com::sun::star::embed::XStorage Storage )
+ raises( com::sun::star::lang::IllegalArgumentException,
+ com::sun::star::lang::WrappedTargetException );
-//FIXME error handling for these?
-//Note: any errors when accessing individual streams in the medium (including the manifest) will not be reported to the caller unless an XInteractionHandler is supplied.
//-------------------------------------------------------------------------
/** loads document metadata from a medium.
+ <p>If the Medium contains an InteractionHandler, it will be used for
+ error reporting.</p>
+
@param Medium
the <type>com::sun::star::document::MediaDescriptor</type>
representing the source
@@ -504,18 +417,14 @@ interface XDocumentMetadataAccess
if the argument does not contain a URL or Stream property
@throws com::sun::star::lang::WrappedTargetException
- if thrown when trying to access the medium
-
- @throws com::sun::star::io::IOException
- if thrown when trying to access the medium
+ if an error occurs while loading
@see com::sun::star::document::MediaDescriptor
*/
void loadMetadataFromMedium(
[in] sequence < com::sun::star::beans::PropertyValue > Medium )
raises( com::sun::star::lang::IllegalArgumentException,
- com::sun::star::lang::WrappedTargetException,
- com::sun::star::io::IOException );
+ com::sun::star::lang::WrappedTargetException );
//-------------------------------------------------------------------------
/** stores document metadata to a medium.
@@ -528,18 +437,14 @@ interface XDocumentMetadataAccess
if the argument does not contain a URL or Stream property
@throws com::sun::star::lang::WrappedTargetException
- if thrown when trying to access the medium
-
- @throws com::sun::star::io::IOException
- if thrown when trying to access the medium
+ if an error occurs while storing
@see com::sun::star::document::MediaDescriptor
*/
void storeMetadataToMedium(
[in] sequence < com::sun::star::beans::PropertyValue > Medium )
raises( com::sun::star::lang::IllegalArgumentException,
- com::sun::star::lang::WrappedTargetException,
- com::sun::star::io::IOException );
+ com::sun::star::lang::WrappedTargetException );
};
diff --git a/offapi/com/sun/star/rdf/XDocumentRepository.idl b/offapi/com/sun/star/rdf/XDocumentRepository.idl
index bd7f6d2259b6..d9131291d81a 100644
--- a/offapi/com/sun/star/rdf/XDocumentRepository.idl
+++ b/offapi/com/sun/star/rdf/XDocumentRepository.idl
@@ -31,10 +31,6 @@
#ifndef __com_sun_star_rdf_XDocumentRepository_idl__
#define __com_sun_star_rdf_XDocumentRepository_idl__
-#ifndef __com_sun_star_text_XTextRange_idl__
-#include <com/sun/star/text/XTextRange.idl>
-#endif
-
#ifndef __com_sun_star_rdf_XMetadatable_idl__
#include <com/sun/star/rdf/XMetadatable.idl>
#endif
@@ -58,7 +54,7 @@ module com { module sun { module star { module rdf {
which is stored as RDFa.
</p>
- @since OOo 3.0
+ @since OOo 3.2
@see XRepositorySupplier
@see XDocumentMetadataAccess
@@ -73,22 +69,30 @@ interface XDocumentRepository : XRepository
<p>
This method will do the following steps:
<ol>
- <li>Remove all RDFa statements that involve the Object parameter from
- the repository</li>
+ <li>Remove all previously set RDFa statements for the Object parameter
+ from the repository</li>
<li>If the RDFaContent parameter is the empty <atom>string</atom>,
+ for every Predicate in the given list of Predicates,
add the following RDF statement to an unspecified named graph:
<ul>
- <li><code>Subject Predicate XLiteral(Object->getText())</code></li>
+ <li><code>Subject Predicate
+ XLiteral(Object->getText()^^RDFaDatatype)</code></li>
</ul>
</li>
<li>If the RDFaContent parameter is not the empty <atom>string</atom>,
- add the following RDF statements to an unspecified named graph:
+ for every Predicate in the given list of Predicates,
+ add the following RDF statement to an unspecified named graph:
<ul>
<li>
<code>Subject Predicate XLiteral(RDFaContent^^RDFaDatatype)</code>
</li>
+ </ul>
+ Further, add the following RDF statement to the same unspecified
+ named graph:
+ <ul>
<li>
- <code>Subject rdfs:label XLiteral(Object->getText())</code></li>
+ <code>Subject rdfs:label XLiteral(Object->getText())</code>
+ </li>
</ul>
</li>
</ol>
@@ -97,22 +101,22 @@ interface XDocumentRepository : XRepository
<p>
RDFa statements are handled specially because they are not logically
part of any named graph in the repository.
- Also, they have rather unusual semantics.
- Also, just using <method>XNamedGraph::addStatement</method>
- for this would be ambiguous:
- if the object is a XMetadatable, do we insert the object itself (URI)
- or its literal content (RDFa)?
+ Also, they have rather unusual semantics;
+ just using <member>XNamedGraph::addStatement</member> would be
+ ambiguous:
+ if the object is a <type>XMetadatable</type>, do we insert
+ the object itself (URI) or its literal content (RDFa)?
</p>
-//FIXME: updates???
@param Subject
- the subject of the RDF triple.
+ the subject of the RDF triple(s).
- @param Predicate
- the predicate of the RDF triple.
+ @param Predicates
+ the predicates of the RDF triple(s).
@param Object
- the object of the RDF triple is the text content of this parameter.
+ the object of the RDF triple(s) is the text content of this
+ parameter.
@param RDFaContent
the <code>rdfa:content</code> attribute (may be the empty
@@ -122,16 +126,16 @@ interface XDocumentRepository : XRepository
the <code>rdfa:datatype</code> attribute (may be <NULL/>)
@throws com::sun::star::lang::IllegalArgumentException
- if any parameter is <NULL/>,
+ if any parameter is <NULL/>, Predicates is empty,
or Object is of a type that can not have RDFa metadata attached.
@throws RepositoryException
if an error occurs when accessing the repository.
*/
void setStatementRDFa(
- [in] XURI Subject,
- [in] XURI Predicate,
- [in] com::sun::star::text::XTextRange Object,
+ [in] XResource Subject,
+ [in] sequence<XURI> Predicates,
+ [in] XMetadatable Object,
[in] string RDFaContent,
[in] XURI RDFaDatatype)
raises( com::sun::star::lang::IllegalArgumentException,
@@ -146,7 +150,7 @@ interface XDocumentRepository : XRepository
part of any graph.
</p>
- @param Object
+ @param Element
the element whose RDFa statement(s) should be removed
@throws com::sun::star::lang::IllegalArgumentException
@@ -156,7 +160,7 @@ interface XDocumentRepository : XRepository
@throws RepositoryException
if an error occurs when accessing the repository.
*/
- void removeStatementRDFa([in] com::sun::star::text::XTextRange Object)
+ void removeStatementRDFa([in] XMetadatable Element)
raises( com::sun::star::lang::IllegalArgumentException,
RepositoryException );
@@ -170,13 +174,14 @@ interface XDocumentRepository : XRepository
<ul>
<li>if the element has no RDFa meta-data attributes:
the empty sequence.</li>
- <li>if the element has RDFa meta-data attributes,
+ <li>if the element has RDFa meta-data attributes:
and no <code>rdfa:content</code> attached:
- a sequence with a single element: the RDFa-statement</li>
+ a sequence with the RDFa-statements corresponding to the
+ attributes</li>
<li>if the element has RDFa meta-data attributes,
and also <code>rdfa:content</code> attached:
- a sequence with 2 elements: first the RDFa-statement,
- then the RDFa-labels-statement</li>
+ a sequence with the RDFa-statements corresponding to the
+ attributes, including the RDFa-labels-statement</li>
</ul>
@throws com::sun::star::lang::IllegalArgumentException
@@ -198,7 +203,7 @@ interface XDocumentRepository : XRepository
<p>
This method exists because RDFa statements are not part of any named
graph, and thus they cannot be enumerated with
- <method>XNamedGraph::getStatements</method>.
+ <member>XNamedGraph::getStatements</member>.
</p>
<p>
@@ -230,7 +235,7 @@ interface XDocumentRepository : XRepository
*/
com::sun::star::container::XEnumeration/*<Statement>*/ getStatementsRDFa(
[in] XResource Subject,
- [in] XResource Predicate,
+ [in] XURI Predicate,
[in] XNode Object)
raises( RepositoryException );
diff --git a/offapi/com/sun/star/rdf/XMetadatable.idl b/offapi/com/sun/star/rdf/XMetadatable.idl
index 9c702cfc4db7..19b25f8b58a0 100644
--- a/offapi/com/sun/star/rdf/XMetadatable.idl
+++ b/offapi/com/sun/star/rdf/XMetadatable.idl
@@ -35,8 +35,12 @@
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif
-#ifndef __com_sun_star_rdf_XResource_idl__
-#include <com/sun/star/rdf/XResource.idl>
+#ifndef __com_sun_star_beans_StringPair_idl__
+#include <com/sun/star/beans/StringPair.idl>
+#endif
+
+#ifndef __com_sun_star_rdf_XURI_idl__
+#include <com/sun/star/rdf/XURI.idl>
#endif
@@ -50,42 +54,52 @@ module com { module sun { module star { module rdf {
<p>
To make using ODF elements as part of RDF statements more convenient,
- this interface inherits from XRDFResource.
+ this interface inherits from <type>XURI</type>.
+ The URI is constructed by concatenating the URI of the document, the
+ stream name, a fragment separator, and the XML ID.
+ </p>
+
+ <p>
+ Note that using the <type>XURI</type> interface on an instance of
+ <type>XMetadatable</type> may have the side effect of creating a metadata
+ reference for the instance.
</p>
- @since OOo 3.0
+ @since OOo 3.2
- @see XRDFRepository
+ @see XRepository
+ @see XDocumentMetadataAccess
*/
-interface XMetadatable : XResource
+interface XMetadatable : XURI
{
//-------------------------------------------------------------------------
- /** an XML ID, comprising the stream name and the xml:id attribute.
+ /** a metadata reference, comprising the stream name and the XML ID.
<p>
- Note that this ID must be unique for the ODF document.
- This implies that the xml:id part must be unique for every stream.
- The ID may be omitted, in which case the value is the empty string.
- For Example: "content.xml#foo-element-1"
+ Note that this metadata reference must be unique for the ODF document.
+ This implies that the XML ID part must be unique for every stream.
+ A pair of two empty strings signifies "no metadata reference".
+ For example: Pair("content.xml", "foo-element-1")
</p>
@throws com::sun::star::lang::IllegalArgumentException
- if the given XmlId is invalid, or not unique
+ if the given metadata reference is invalid, or not unique
*/
- [attribute] string XmlId {
+ [attribute] com::sun::star::beans::StringPair MetadataReference {
set raises ( com::sun::star::lang::IllegalArgumentException );
};
//-------------------------------------------------------------------------
- /** creates an XML ID for this object, if necessary.
+ /** creates a metadata reference for this object, if necessary.
<p>
- If this object already has an XML ID, do nothing;
- otherwise, create a fresh, unique XML ID and assign it to the
- XmlId attribute.
+ If this object already has a metadata reference, do nothing;
+ otherwise, create metadata reference with a fresh, unique XML ID
+ and assign it to the MetadataReference attribute.
</p>
*/
- void ensureXmlId();
+ void ensureMetadataReference();
+
};
//=============================================================================
diff --git a/offapi/com/sun/star/rdf/XNamedGraph.idl b/offapi/com/sun/star/rdf/XNamedGraph.idl
index be7b67448e9f..33c09cdfceee 100644
--- a/offapi/com/sun/star/rdf/XNamedGraph.idl
+++ b/offapi/com/sun/star/rdf/XNamedGraph.idl
@@ -67,13 +67,13 @@ module com { module sun { module star { module rdf {
<p>
Note that instances may be destroyed via
- <method>XRepository::destroyGraph</method>.
- If a graph is destroyed, subsequent calls to <method>addStatement</method>,
- <method>removeStatement</method> will fail with an
+ <member>XRepository::destroyGraph</member>.
+ If a graph is destroyed, subsequent calls to <member>addStatement</member>,
+ <member>removeStatements</member> will fail with an
<type scope="com::sun::star::container">NoSuchElementException</type>.
</p>
- @since OOo 3.0
+ @since OOo 3.2
@see XRepository
*/
@@ -134,7 +134,7 @@ interface XNamedGraph : XURI
if an error occurs when accessing the repository.
*/
void addStatement([in] XResource Subject,
- [in] XResource Predicate,
+ [in] XURI Predicate,
[in] XNode Object)
raises( com::sun::star::lang::IllegalArgumentException,
com::sun::star::container::NoSuchElementException,
@@ -172,7 +172,7 @@ interface XNamedGraph : XURI
if an error occurs when accessing the repository.
*/
void removeStatements([in] XResource Subject,
- [in] XResource Predicate,
+ [in] XURI Predicate,
[in] XNode Object)
raises( com::sun::star::container::NoSuchElementException,
RepositoryException );
@@ -217,7 +217,7 @@ interface XNamedGraph : XURI
*/
com::sun::star::container::XEnumeration/*<Statement>*/ getStatements(
[in] XResource Subject,
- [in] XResource Predicate,
+ [in] XURI Predicate,
[in] XNode Object)
raises( com::sun::star::container::NoSuchElementException,
RepositoryException );
diff --git a/offapi/com/sun/star/rdf/XQuerySelectResult.idl b/offapi/com/sun/star/rdf/XQuerySelectResult.idl
index 9148b6b0db85..1d9641edf37d 100644
--- a/offapi/com/sun/star/rdf/XQuerySelectResult.idl
+++ b/offapi/com/sun/star/rdf/XQuerySelectResult.idl
@@ -51,7 +51,7 @@ module com { module sun { module star { module rdf {
each being a list of bindings for the above variables</li>
</ol>
Note that each query result retrieved via
- <method scope="com::sun::star::container">XEnumeration::nextElement</method>
+ <member scope="com::sun::star::container">XEnumeration::nextElement</member>
has the type <type dim="[]">XNode</type>,
the length of the sequence being the same as the number of query variables.
</p>
diff --git a/offapi/com/sun/star/rdf/XRepository.idl b/offapi/com/sun/star/rdf/XRepository.idl
index 3c75b50b206f..6f6e12a2ea5b 100644
--- a/offapi/com/sun/star/rdf/XRepository.idl
+++ b/offapi/com/sun/star/rdf/XRepository.idl
@@ -126,7 +126,7 @@ module com { module sun { module star { module rdf {
</p>
- @since OOo 3.0
+ @since OOo 3.2
@see XRepositorySupplier
@see XDocumentRepository
@@ -369,7 +369,7 @@ interface XRepository
*/
com::sun::star::container::XEnumeration/*<Statement>*/ getStatements(
[in] XResource Subject,
- [in] XResource Predicate,
+ [in] XURI Predicate,
[in] XNode Object)
raises( RepositoryException );
@@ -385,7 +385,7 @@ interface XRepository
</p>
@param Query
- the SPARQL query string
+ the SPARQL query <atom>string</atom>
@returns
an enumeration, containing
@@ -396,7 +396,7 @@ interface XRepository
</ol>
@throws QueryException
- if the query string is malformed, or evaluation fails
+ if the query is malformed, or evaluation fails
@throws RepositoryException
if an error occurs when accessing the repository.
@@ -416,14 +416,14 @@ interface XRepository
</p>
@param Query
- the SPARQL query string
+ the SPARQL query <atom>string</atom>
@returns
an iterator over the query result graph, represented as an
enumeration of <type>Statement</type>
@throws QueryException
- if the query string is malformed, or evaluation fails
+ if the query is malformed, or evaluation fails
@throws RepositoryException
if an error occurs when accessing the repository.
@@ -444,13 +444,13 @@ interface XRepository
</p>
@param Query
- the SPARQL query string
+ the SPARQL query <atom>string</atom>
@returns
the boolean query result
@throws QueryException
- if the query string is malformed, or evaluation fails
+ if the query is malformed, or evaluation fails
@throws RepositoryException
if an error occurs when accessing the repository.
diff --git a/offapi/com/sun/star/report/XImageControl.idl b/offapi/com/sun/star/report/XImageControl.idl
index 58d5ae46c240..df13e1a769cc 100644
--- a/offapi/com/sun/star/report/XImageControl.idl
+++ b/offapi/com/sun/star/report/XImageControl.idl
@@ -65,10 +65,18 @@ interface XImageControl
*/
[attribute,bound] string ImageURL;
- /** specifies if the image is automatically scaled to the size of the
- control.
- */
- [attribute,bound] boolean ScaleImage;
+ /** defines how to scale the image
+
+ <p>If this property is present, it supersedes the <member>ScaleImage</member> property.</p>
+
+ <p>The value of this property is one of the <type scope="com::sun::star::awt">ImageScaleMode</type> constants.</p>
+
+ @since OOo 3.2
+ */
+ [attribute,bound] short ScaleMode
+ {
+ set raises (com::sun::star::lang::IllegalArgumentException);
+ };
/** Specifies that the IRI given in the data field should be preserved, otherwise the content will be inserted in the resulting report document.
If the data field contains something different as string then this attribute will be ignored.
diff --git a/offapi/com/sun/star/report/XReportControlFormat.idl b/offapi/com/sun/star/report/XReportControlFormat.idl
index cf82c064270f..5a8e2a159780 100644
--- a/offapi/com/sun/star/report/XReportControlFormat.idl
+++ b/offapi/com/sun/star/report/XReportControlFormat.idl
@@ -30,21 +30,14 @@
#ifndef __com_sun_star_report_XReportControlFormat_idl__
#define __com_sun_star_report_XReportControlFormat_idl__
-#ifndef __com_sun_star_awt_FontDescriptor_idl__
#include <com/sun/star/awt/FontDescriptor.idl>
-#endif
-#ifndef __com_sun_star_util_Color_idl__
-#include <com/sun/star/util/Color.idl>
-#endif
-#ifndef __com_sun_star_beans_XPropertySet_idl__
+#include <com/sun/star/awt/FontSlant.idl>
#include <com/sun/star/beans/XPropertySet.idl>
-#endif
-#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
-#endif
#include <com/sun/star/lang/Locale.idl>
-#include <com/sun/star/awt/FontSlant.idl>
-
+#include <com/sun/star/style/ParagraphAdjust.idl>
+#include <com/sun/star/style/VerticalAlignment.idl>
+#include <com/sun/star/util/Color.idl>
//=============================================================================
module com { module sun { module star { module report {
@@ -70,15 +63,8 @@ interface XReportControlFormat
get raises ( com::sun::star::beans::UnknownPropertyException );
};
- /** specifies the horizontal alignment of the text in the control.
-
- <pre>
- 0: left
- 1: center
- 2: right
- </pre>
-
- @since OOo 2.0.0
+ /** specifies the horizontal alignment of the text.
+ @see ::com::sun::star::style::ParagraphAdjust
*/
[attribute,bound] short ParaAdjust
{
@@ -414,11 +400,12 @@ interface XReportControlFormat
};
/** specifies the vertical alignment of the text in the control.
- @see com::sun::star::text::ParagraphVertAlign
+ @see com::sun::star::style::VerticalAlignment
*/
- [attribute,bound] short ParaVertAlignment
+ [attribute,bound] com::sun::star::style::VerticalAlignment VerticalAlign
{
- set raises ( com::sun::star::lang::IllegalArgumentException );
+ set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException );
+ get raises ( com::sun::star::beans::UnknownPropertyException );
};
//-------------------------------------------------------------------------
diff --git a/offapi/com/sun/star/report/XReportEngine.idl b/offapi/com/sun/star/report/XReportEngine.idl
index 9cdb03eec80b..99aec07d3fd9 100644
--- a/offapi/com/sun/star/report/XReportEngine.idl
+++ b/offapi/com/sun/star/report/XReportEngine.idl
@@ -153,6 +153,13 @@ interface XReportEngine
/** specifies the status indicator which shows the progress of the report generation process.
*/
[attribute] com::sun::star::task::XStatusIndicator StatusIndicator;
+
+ /** defines the maximum number of rows which should be fetched for the report.
+ If the limit is exceeded, the excess rows are silently dropped.
+ <br/>
+ There is no limitation, if set to zero.
+ */
+ [attribute,bound] long MaxRows;
};
//=============================================================================
diff --git a/offapi/com/sun/star/report/XShape.idl b/offapi/com/sun/star/report/XShape.idl
index 22aa577002cc..2a2c60b5fb21 100644
--- a/offapi/com/sun/star/report/XShape.idl
+++ b/offapi/com/sun/star/report/XShape.idl
@@ -82,6 +82,10 @@ interface XShape
com.sun.star.drawing.EnhancedCustomShapeGeometry
*/
[attribute,bound] sequence<::com::sun::star::beans::PropertyValue> CustomShapeGeometry;
+
+ /** determines if the object is opaque or transparent for text.
+ */
+ [attribute,bound] boolean Opaque;
};
service Shape : XShape;
diff --git a/offapi/com/sun/star/sdb/ErrorCondition.idl b/offapi/com/sun/star/sdb/ErrorCondition.idl
index 0745739337c4..1a9ade6e83b5 100644
--- a/offapi/com/sun/star/sdb/ErrorCondition.idl
+++ b/offapi/com/sun/star/sdb/ErrorCondition.idl
@@ -141,6 +141,37 @@ constants ErrorCondition
database, which did not exist at that time.
*/
const long DB_NOT_CONNECTED = 304;
+
+ // ========================================================================
+ // = section AB - address book access related error conditions
+ // =
+ // = next section should start with 550
+
+ /** used by the component implementing address book access to indicate that a requested address book could
+ not be accessed.
+
+ <p>For instance, this error code is used when you try to access the address book
+ in a Thunderbird profile named <q>MyProfile</q>, but there does not exist a profile
+ with this name.</p>
+ */
+ const long AB_ADDRESSBOOK_NOT_FOUND = 500;
+
+ // ========================================================================
+ // = section DATA - data retrieval related error conditions
+ // =
+ // = next section should start with 600
+
+ /** used to indicate that a <code>SELECT</code> operation on a table needs a filter.
+
+ <p>Some database drivers are not able to <code>SELECT</code> from a table if the
+ statement does not contain a <code>WHERE</code> clause. In this case, a statement
+ like <code>SELECT * FROM "table"</cdeo> with fail with the error code
+ <code>DATA_CANNOT_SELECT_UNFILTERED</code>.</p>
+
+ <p>It is also legitimate for the driver to report this error condition as warning, and provide
+ an empty result set, instead of ungracefull failing.</p>
+ */
+ const long DATA_CANNOT_SELECT_UNFILTERED = 550;
};
//=============================================================================
diff --git a/offapi/com/sun/star/sdb/RowSet.idl b/offapi/com/sun/star/sdb/RowSet.idl
index 01d3f0662919..fd860380fc28 100644
--- a/offapi/com/sun/star/sdb/RowSet.idl
+++ b/offapi/com/sun/star/sdb/RowSet.idl
@@ -216,7 +216,8 @@ published service RowSet
the <type scope="com::sun::star::sdbc">XParameters</type> interface.<br/>
However, you can also choose to let an interaction handler supply such data. For this, you may
for instance instantiate an <type>InteractionHandler</type>, which asks the user for the
- data, or you may write your own one, which supplies the data from somewhere else.</p>
+ data, or you may write your own one, which supplies the data from somewhere else.
+ The default implementation will only ask for parameters which aren't set before through the <type scope="com::sun::star::sdbc">XParameters</type> interface.</p>
@see com::sun::star::sdb::InteractionHandler
*/
diff --git a/offapi/com/sun/star/sdb/XRowSetChangeBroadcaster.idl b/offapi/com/sun/star/sdb/XRowSetChangeBroadcaster.idl
new file mode 100644
index 000000000000..2a853eae89ec
--- /dev/null
+++ b/offapi/com/sun/star/sdb/XRowSetChangeBroadcaster.idl
@@ -0,0 +1,66 @@
+/*************************************************************************
+* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+*
+* Copyright 2008 by Sun Microsystems, Inc.
+*
+* OpenOffice.org - a multi-platform office productivity suite
+*
+* $RCSfile: code,v $
+*
+* $Revision: 1.3 $
+*
+* 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_sdb_XRowSetChangeBroadcaster_idl__
+#define __com_sun_star_sdb_XRowSetChangeBroadcaster_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+
+//=============================================================================
+
+module com { module sun { module star { module sdb {
+
+interface XRowSetChangeListener;
+
+//=============================================================================
+
+/** broadcasts changes in the <code>RowSet</code> supplied by a component
+
+ @see XRowSetSupplier
+ @see XRowSetChangeListener
+ @since OOo 3.2
+ */
+interface XRowSetChangeBroadcaster
+{
+ /** adds a listener to be notified when the <code>RowSet</code> supplied by the component changes.
+ */
+ void addRowSetChangeListener( [in] XRowSetChangeListener i_Listener );
+
+ /** removes a previously added listener.
+ */
+ void removeRowSetChangeListener( [in] XRowSetChangeListener i_Listener );
+};
+
+//=============================================================================
+
+}; }; }; };
+
+//=============================================================================
+
+#endif
diff --git a/offapi/com/sun/star/sdb/XRowSetChangeListener.idl b/offapi/com/sun/star/sdb/XRowSetChangeListener.idl
new file mode 100644
index 000000000000..8f68ec70d1fe
--- /dev/null
+++ b/offapi/com/sun/star/sdb/XRowSetChangeListener.idl
@@ -0,0 +1,62 @@
+/*************************************************************************
+* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+*
+* Copyright 2008 by Sun Microsystems, Inc.
+*
+* OpenOffice.org - a multi-platform office productivity suite
+*
+* $RCSfile: code,v $
+*
+* $Revision: 1.3 $
+*
+* 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_sdb_XRowSetChangeListener_idl__
+#define __com_sun_star_sdb_XRowSetChangeListener_idl__
+
+#include <com/sun/star/lang/XEventListener.idl>
+
+//=============================================================================
+
+module com { module sun { module star { module sdb {
+
+//=============================================================================
+
+/** is implemented by components which want to be notified when the <code>RowSet</code> supplied
+ by a <type>XRowSetSupplier</type> changes.
+
+ @see XRowSetChangeBroadcaster
+ @see XRowSetSupplier
+ @since OOo 3.2
+ */
+ interface XRowSetChangeListener : ::com::sun::star::lang::XEventListener
+{
+ /** notifies the listener that the <code>RowSet</code> associated with a <type>XRowSetSupplier</type>
+ has changed.
+ */
+ [oneway] void onRowSetChanged( [in] ::com::sun::star::lang::EventObject i_Event );
+};
+
+//=============================================================================
+
+}; }; }; };
+
+//=============================================================================
+
+#endif
diff --git a/offapi/com/sun/star/sdb/XRowSetSupplier.idl b/offapi/com/sun/star/sdb/XRowSetSupplier.idl
index 071750c915ab..0ab2b78c97a5 100644
--- a/offapi/com/sun/star/sdb/XRowSetSupplier.idl
+++ b/offapi/com/sun/star/sdb/XRowSetSupplier.idl
@@ -43,6 +43,8 @@
//=============================================================================
/** uses a row set as datasource.
+
+ @see XRowSetChangeBroadcaster
*/
published interface XRowSetSupplier: com::sun::star::uno::XInterface
{
diff --git a/offapi/com/sun/star/sdb/application/DefaultViewController.idl b/offapi/com/sun/star/sdb/application/DefaultViewController.idl
index 47040d133736..2c9836b70b0c 100644
--- a/offapi/com/sun/star/sdb/application/DefaultViewController.idl
+++ b/offapi/com/sun/star/sdb/application/DefaultViewController.idl
@@ -44,7 +44,7 @@ module com { module sun { module star { module sdb { module application {
//=============================================================================
-/** is the default <type>Controller</type> implementation for OpenOffice.org's database application.
+/** is the default controller implementation for OpenOffice.org's database application.
*/
service DefaultViewController
{
diff --git a/offapi/com/sun/star/sdb/application/XCopyTableWizard.idl b/offapi/com/sun/star/sdb/application/XCopyTableWizard.idl
index 01f6fc783201..8a9bbf52b052 100644
--- a/offapi/com/sun/star/sdb/application/XCopyTableWizard.idl
+++ b/offapi/com/sun/star/sdb/application/XCopyTableWizard.idl
@@ -130,6 +130,14 @@ interface XCopyTableWizard : ::com::sun::star::ui::dialogs::XExecutableDialog
set raises ( ::com::sun::star::lang::IllegalArgumentException );
};
+ /** specifies that the first row should be used to identify column names.
+
+ <p>This attribute is ignored when the source defines the column names which isn't the case when only a part of a table should be copied
+ e.g. in the RTF format or in the HTML format.
+ </p>
+ */
+ [attribute] boolean UseHeaderLineAsColumnNames;
+
/** adds a listener which is to be notified of progress in the copy operation
*/
void addCopyTableListener( [in] XCopyTableListener Listener );
diff --git a/offapi/com/sun/star/sdb/makefile.mk b/offapi/com/sun/star/sdb/makefile.mk
index d3358cf63fc5..b535584fc4b8 100644
--- a/offapi/com/sun/star/sdb/makefile.mk
+++ b/offapi/com/sun/star/sdb/makefile.mk
@@ -126,6 +126,8 @@ IDLFILES=\
XResultSetAccess.idl \
XRowSetApproveBroadcaster.idl \
XRowSetApproveListener.idl \
+ XRowSetChangeBroadcaster.idl \
+ XRowSetChangeListener.idl \
XRowSetSupplier.idl \
XSingleSelectQueryAnalyzer.idl \
XSingleSelectQueryComposer.idl \
diff --git a/offapi/com/sun/star/sheet/DDELinkInfo.idl b/offapi/com/sun/star/sheet/DDELinkInfo.idl
index 4edba2eff4f2..9fdd218f99d2 100644
--- a/offapi/com/sun/star/sheet/DDELinkInfo.idl
+++ b/offapi/com/sun/star/sheet/DDELinkInfo.idl
@@ -41,42 +41,37 @@ module com { module sun { module star { module sheet {
//=============================================================================
/** describes all items of a DDE connection used in formulas.
- A DDE connection consists of the DDE service name, the DDE topic and a
- list of DDE items which may contain results cached from the last update.
-
- The formula that would need this information for example would contain
- =[1]!'R1C1' or =[2]!'Sheet1.A1' where [1] is an external link with DDE
- service name "excel" and topic "X:\PATH\[FILE.XLSX]Sheet1", and [2]
- contains service "soffice" and topic "file:///X:/PATH/FILE.ODS". The
- service name is stored in <member>DDELinkInfo::Service</member>, the topic
- is stored in <member>DDELinkInfo::Topic</member>. Note that if the DDE
- item contains single quotes they are escaped by doubling them, as usual.
- For example =[2]!'''Sheet name''.A1' in a "soffice" service.
+ <p>A DDE connection consists of the DDE service name, the DDE topic and a
+ list of DDE items which may contain results cached from the last update.</p>
+
+ <p>The formula that would need this information for example would contain
+ <code>=[1]!'R1C1'</code> or <code>=[2]!'Sheet1.A1'</code> where
+ <em>[1]</em> is an external link with DDE service name "excel" and the
+ topic "X:\PATH\[FILE.XLSX]Sheet1", and <em>[2]</em> contains service
+ "soffice" and topic "file:///X:/PATH/FILE.ODS". The service name is stored
+ in <member>DDELinkInfo::Service</member>, the topic is stored in
+ <member>DDELinkInfo::Topic</member>. Note that if the DDE item contains
+ single quotes they are escaped by doubling them, as usual, for example
+ <code>=[2]!'''Sheet name''.A1'</code> in a "soffice" service.</p>
@since OOo3.1
*/
struct DDELinkInfo
{
//-------------------------------------------------------------------------
-
/** The DDE service name.
*/
-
string Service;
//-------------------------------------------------------------------------
-
/** The DDE topic.
*/
-
string Topic;
//-------------------------------------------------------------------------
-
/** A list of DDE items. Each item may contain its results from the last
update.
*/
-
sequence< DDEItemInfo > Items;
};
diff --git a/offapi/com/sun/star/sheet/DataPilotDescriptor.idl b/offapi/com/sun/star/sheet/DataPilotDescriptor.idl
index a677303a7c54..f44655bd96aa 100644
--- a/offapi/com/sun/star/sheet/DataPilotDescriptor.idl
+++ b/offapi/com/sun/star/sheet/DataPilotDescriptor.idl
@@ -35,6 +35,10 @@
#include <com/sun/star/sheet/XDataPilotDescriptor.idl>
#endif
+#ifndef __com_sun_star_sheet_XDataPilotDataLayoutFieldSupplier_idl__
+#include <com/sun/star/sheet/XDataPilotDataLayoutFieldSupplier.idl>
+#endif
+
#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif
@@ -55,7 +59,7 @@ published service DataPilotDescriptor
/** provides access to the layout settings of the data pilot table.
*/
- interface com::sun::star::sheet::XDataPilotDescriptor;
+ interface XDataPilotDescriptor;
//-------------------------------------------------------------------------
@@ -63,6 +67,13 @@ published service DataPilotDescriptor
*/
[optional] interface com::sun::star::beans::XPropertySet;
+ //-------------------------------------------------------------------------
+
+ /** Provides access to the <type>DataPilotField</type> used to layout
+ multiple data fields.
+ */
+ [optional] interface XDataPilotDataLayoutFieldSupplier;
+
//=========================================================================
/** specifies the orientation of the field.
diff --git a/offapi/com/sun/star/sheet/DataPilotField.idl b/offapi/com/sun/star/sheet/DataPilotField.idl
index a4bf3c9a082d..83ae7892e0c2 100644
--- a/offapi/com/sun/star/sheet/DataPilotField.idl
+++ b/offapi/com/sun/star/sheet/DataPilotField.idl
@@ -83,9 +83,9 @@ module com { module sun { module star { module sheet {
/** represents a single field in a data pilot table.
- <p>If the data pilot table is based on a spreadsheet cell range, a
- field is representred by a column of the range and is named using
- the topmost cell of the column.</p>
+ <p>If the data pilot table is based on a spreadsheet cell range, a field
+ is representred by a column of the range and is named using the topmost
+ cell of the column.</p>
*/
published service DataPilotField
{
@@ -104,17 +104,21 @@ published service DataPilotField
//-------------------------------------------------------------------------
- [optional] interface com::sun::star::sheet::XDataPilotField;
+ [optional] interface XDataPilotField;
//-------------------------------------------------------------------------
- [optional] interface com::sun::star::sheet::XDataPilotFieldGrouping;
+ [optional] interface XDataPilotFieldGrouping;
//=========================================================================
/** specifies the orientation of the field.
+
+ <p>If the orientation of a field has been changed using this property,
+ the field will be moved to the last position in the collection of all
+ fields with the specified orientation.</p>
*/
- [property] com::sun::star::sheet::DataPilotFieldOrientation Orientation;
+ [property] DataPilotFieldOrientation Orientation;
//-------------------------------------------------------------------------
@@ -125,21 +129,39 @@ published service DataPilotField
For data fields, this is the function shown in the data pilot
table.</p>
*/
- [property] com::sun::star::sheet::GeneralFunction Function;
+ [property] GeneralFunction Function;
+
+ //-------------------------------------------------------------------------
+
+ /** specifies the functions used to calculate subtotals for this field.
+
+ <p>This property is supported by column and row fields only.</p>
+ <p>An empty sequence means no subtotals. The same effect can be
+ achieved by setting the property <member>Function</member> to the
+ value <const>GeneralFunction::NONE</const>. If the length of the
+ sequence is greater then 1, then the sequence MUST NOT contain one of
+ the values <const>GeneralFunction::NONE</const> or
+ <const>GeneralFunction::AUTO</const>.</p>
+
+ <p>The order of the functions in this sequence is reflected in the
+ DataPilot table. Multiple entries of the same function are ignored
+ when setting the property.</p>
+ */
+ [property, optional] sequence<GeneralFunction> Subtotals;
//-------------------------------------------------------------------------
/** specifies the selected page which is used to filter the data pilot.
*/
- [property,optional] string SelectedPage;
+ [property, optional] string SelectedPage;
//-------------------------------------------------------------------------
/** specifies whether to use the selected page to filter the data pilot or
show all.
*/
- [property,optional] boolean UseSelectedPage;
+ [property, optional] boolean UseSelectedPage;
//-------------------------------------------------------------------------
@@ -147,73 +169,78 @@ published service DataPilotField
@see com::sun::star::sheet::DataPilotSourceHierarchies
*/
- [property,optional] string UsedHierarchy;
+ [property, optional] string UsedHierarchy;
//-------------------------------------------------------------------------
/** specifies whether this field has sorting information.
*/
- [property,optional] boolean HasSortInfo;
+ [property, optional] boolean HasSortInfo;
//-------------------------------------------------------------------------
/** controls how the field's items are sorted.
*/
- [property,optional] com::sun::star::sheet::DataPilotFieldSortInfo SortInfo;
+ [property, optional] DataPilotFieldSortInfo SortInfo;
//-------------------------------------------------------------------------
/** specifies whether this field has layout information.
*/
- [property,optional] boolean HasLayoutInfo;
+ [property, optional] boolean HasLayoutInfo;
//-------------------------------------------------------------------------
/** controls how the field's items are laid out in the result table.
*/
- [property,optional] com::sun::star::sheet::DataPilotFieldLayoutInfo LayoutInfo;
+ [property, optional] DataPilotFieldLayoutInfo LayoutInfo;
//-------------------------------------------------------------------------
/** specifies whether this field has auto show information.
*/
- [property,optional] boolean HasAutoShowInfo;
+ [property, optional] boolean HasAutoShowInfo;
//-------------------------------------------------------------------------
/** enables the automatic inclusion of only a number of items with
the highest or lowest result values.
*/
- [property,optional] com::sun::star::sheet::DataPilotFieldAutoShowInfo AutoShowInfo;
+ [property, optional] DataPilotFieldAutoShowInfo AutoShowInfo;
//-------------------------------------------------------------------------
/** specifies whether this field has a reference.
*/
- [property,optional] boolean HasReference;
+ [property, optional] boolean HasReference;
//-------------------------------------------------------------------------
/** controls how the results are shown in relation to a selected
reference result.
*/
- [property,optional] com::sun::star::sheet::DataPilotFieldReference Reference;
+ [property, optional] DataPilotFieldReference Reference;
//-------------------------------------------------------------------------
/** specifies whether this field is a group field.
*/
- [property,optional] boolean IsGroupField;
+ [property, optional] boolean IsGroupField;
//-------------------------------------------------------------------------
- /** contains the grouping information of the Field
+ /** contains the grouping information of the DataPilot field.
+
+ <p>By changing the value of this property it is possible to modify the
+ grouping settings of this field.</p>
*/
- [property,optional] com::sun::star::sheet::DataPilotFieldGroupInfo GroupInfo;
+ [property, optional] DataPilotFieldGroupInfo GroupInfo;
+
+ //-------------------------------------------------------------------------
/** specifies whether to show this field also if it is empty or not.
*/
- [property,optional] boolean ShowEmpty;
+ [property, optional] boolean ShowEmpty;
};
//=============================================================================
diff --git a/offapi/com/sun/star/sheet/DataPilotFieldGroup.idl b/offapi/com/sun/star/sheet/DataPilotFieldGroup.idl
index f66ff0ce0ba5..f520e0d5644e 100644
--- a/offapi/com/sun/star/sheet/DataPilotFieldGroup.idl
+++ b/offapi/com/sun/star/sheet/DataPilotFieldGroup.idl
@@ -34,8 +34,8 @@
#ifndef __com_sun_star_container_XNamed_idl__
#include <com/sun/star/container/XNamed.idl>
#endif
-#ifndef __com_sun_star_container_XNameAccess_idl__
-#include <com/sun/star/container/XNameAccess.idl>
+#ifndef __com_sun_star_container_XNameContainer_idl__
+#include <com/sun/star/container/XNameContainer.idl>
#endif
#ifndef __com_sun_star_container_XEnumerationAccess_idl__
#include <com/sun/star/container/XEnumerationAccess.idl>
@@ -52,19 +52,28 @@ module com { module sun { module star { module sheet {
/** represents a collection of members in a data pilot field group.
- @see com::sun::star::sheet::DataPilotFieldGroupMember
+ <p>The members (also called items) of this collection are instances of
+ <type>DataPilotFieldGroupItem</type>.</p>
+
+ @see DataPilotField
+ @see DataPilotFieldGroups
+ @see DataPilotFieldGroupItem
*/
published service DataPilotFieldGroup
{
//-------------------------------------------------------------------------
/** provides access to the name of the data pilot field group.
+
+ <p>It is possible to change the name of this field group as long as
+ the new name is not used in the collection of groups in the field.</p>
*/
interface com::sun::star::container::XNamed;
//-------------------------------------------------------------------------
- /** provides access to the data pilot field group members in the collection via index.
+ /** provides access to the data pilot field group members in the
+ collection via index.
*/
interface com::sun::star::container::XIndexAccess;
@@ -72,16 +81,51 @@ published service DataPilotFieldGroup
/** creates an enumeration of all data pilot field group members.
- @see com::sun::star::sheet::DataPilotItemsEnumeration
+ @see DataPilotFieldGroupEnumeration
*/
interface com::sun::star::container::XEnumerationAccess;
//-------------------------------------------------------------------------
- /** provides access to the data pilot field group members in the collection via name.
+ /** provides access to the data pilot field group members in the
+ collection via name.
*/
interface com::sun::star::container::XNameAccess;
+ //-------------------------------------------------------------------------
+
+ /** provides read/write access to the data pilot field group members in
+ the collection via name.
+
+ <p>The <type scope="com::sun::star::container">XNameContainer</type>
+ and <type scope="com::sun::star::container">XNameReplace</type>
+ interfaces can be used to manage the members that this group contains.
+ It is possible to insert, remove, and replace members.</p>
+
+ <p>The method <member scope="com::sun::star::container">
+ XNameReplace::replaceByName</member> can be used to rename the
+ specified member. To do so, the new name has to be passed as second
+ argument. An implementation should support the following data types:
+
+ <ul>
+ <li>a non-empty <atom>string</atom> specifying the new name of the
+ group member.</li>
+ <li>an object supporting the <type scope="com::sun::star::container">
+ XNamed</type> interface, for example an instance of
+ <type>DataPilotFieldGroupItem</type> received from another group.</li>
+ </ul></p>
+
+ <p>The method <member scope="com::sun::star::container">
+ XNameContainer::insertByName</member> can be used to insert a new
+ member into this field group. An implementation should ignore the
+ second argument and insert the specified member name.</p>
+
+ <p>The method <member scope="com::sun::star::container">
+ XNameContainer::removeByName</member> can be used to remove an
+ existing member name.</p>
+ */
+ [optional] interface com::sun::star::container::XNameContainer;
+
};
//=============================================================================
diff --git a/offapi/com/sun/star/sheet/DataPilotFieldGroupBy.idl b/offapi/com/sun/star/sheet/DataPilotFieldGroupBy.idl
index 18136dbb1e0f..77b2d12ee13e 100644
--- a/offapi/com/sun/star/sheet/DataPilotFieldGroupBy.idl
+++ b/offapi/com/sun/star/sheet/DataPilotFieldGroupBy.idl
@@ -37,17 +37,100 @@ module com { module sun { module star { module sheet {
//=============================================================================
-/** These constants select different types of DataPilotFieldGroups.
+/** These constants select different types for grouping members of a DataPilot
+ field by date or time.
+
+ @see DataPilotFieldGroupInfo
*/
published constants DataPilotFieldGroupBy
{
- const long SECONDS = 1;
- const long MINUTES = 2;
- const long HOURS = 4;
- const long DAYS = 8;
- const long MONTHS = 16;
+ // -----------------------------------------------------------------------
+ /** Groups all members of a DataPilot field containing a date/time value
+ by their current value for seconds.
+
+ <p>Example: The group <em>:02</em> will contain all members that
+ contain a time with a seconds value of 2, regardless of the date,
+ hours and minutes of the member, e.g. <em>2002-Jan-03 00:00:02</em> or
+ <em>1999-May-02 12:45:02</em>.</p>
+ */
+ const long SECONDS = 1;
+
+ // -----------------------------------------------------------------------
+ /** Groups all members of a DataPilot field containing a date/time value
+ by their current value for minutes.
+
+ <p>Example: The group <em>:02</em> will contain all members that
+ contain a time with a minutes value of 2, regardless of the date,
+ hours and seconds of the member, e.g. <em>2002-Jan-03 00:02:00</em> or
+ <em>1999-May-02 12:02:45</em>.</p>
+ */
+ const long MINUTES = 2;
+
+ // -----------------------------------------------------------------------
+ /** Groups all members of a DataPilot field containing a date/time value
+ by their current value for hours.
+
+ <p>Example: The group <em>02</em> will contain all members that
+ contain a time with a hour value of 2, regardless of the date, minutes
+ and seconds of the member, e.g. <em>2002-Jan-03 02:00:00</em> or
+ <em>1999-May-02 02:12:45</em>.</p>
+ */
+ const long HOURS = 4;
+
+ // -----------------------------------------------------------------------
+ /** Groups all members of a DataPilot field containing a date/time value
+ by their calendar day, or by ranges of days.
+
+ <p>Examples:
+ <ul>
+ <li>Calendar day grouping: The group <em>Jan 03</em> will contain all
+ members that contain the january 3rd, regardless of the year or time
+ of the member, e.g. <em>2002-Jan-03 00:00:00</em> or
+ <em>1999-Jan-03 02:12:45</em>.</li>
+
+ <li>Day range grouping: The group <em>2002-Jan-03 - 2002-Jan-09</em>
+ will contain all members with a date/time in the range from
+ 2002-Jan-03 00:00:00 through 2002-Jan-09 23:59:59.</li>
+ </ul></p>
+
+ <p>See descriptions for <member>XDataPilotFieldGrouping::createDateGroup
+ </member> for more details about day grouping.</p>
+ */
+ const long DAYS = 8;
+
+ // -----------------------------------------------------------------------
+ /** Groups all members of a DataPilot field containing a date/time value
+ by their month.
+
+ <p>Example: The group <em>Jan</em> will contain all members with a
+ date in the month january, regardless of the year, day, or time of the
+ member, e.g. <em>2002-Jan-03 00:00:00</em> or
+ <em>1999-Jan-02 02:12:45</em>.</p>
+ */
+ const long MONTHS = 16;
+
+ // -----------------------------------------------------------------------
+ /** Groups all members of a DataPilot field containing a date/time value
+ by their quarter.
+
+ <p>Example: The group <em>Q1</em> will contain all members with a
+ date in the first quarter of a year (i.e. the months january,
+ february, and march), regardless of the year, day, or time of the
+ member, e.g. <em>2002-Jan-03 00:00:00</em> or
+ <em>1999-Mar-02 02:12:45</em>.</p>
+ */
const long QUARTERS = 32;
- const long YEARS = 64;
+
+ // -----------------------------------------------------------------------
+ /** Groups all members of a DataPilot field containing a date/time value
+ by their year.
+
+ <p>Example: The group <em>1999</em> will contain all members with a
+ date in the year 1999, regardless of the month, day, or time of the
+ member, e.g. <em>1999-Jan-03 00:00:00</em> or
+ <em>1999-May-02 02:12:45</em>.</p>
+ */
+ const long YEARS = 64;
};
//=============================================================================
diff --git a/offapi/com/sun/star/sheet/DataPilotFieldGroupEnumeration.idl b/offapi/com/sun/star/sheet/DataPilotFieldGroupEnumeration.idl
new file mode 100644
index 000000000000..01d0d35e44c3
--- /dev/null
+++ b/offapi/com/sun/star/sheet/DataPilotFieldGroupEnumeration.idl
@@ -0,0 +1,67 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2008 by Sun Microsystems, Inc.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * $RCSfile: DataPilotItemsEnumeration.idl,v $
+ * $Revision: 1.4 $
+ *
+ * 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_sheet_DataPilotFieldGroupEnumeration_idl__
+#define __com_sun_star_sheet_DataPilotFieldGroupEnumeration_idl__
+
+#ifndef __com_sun_star_container_XEnumeration_idl__
+#include <com/sun/star/container/XEnumeration.idl>
+#endif
+
+//=============================================================================
+
+module com { module sun { module star { module sheet {
+
+//=============================================================================
+
+/** represents an enumeration of members in a DataPilot field group.
+
+ @see DataPilotFieldGroupItem
+ @see DataPilotFieldGroup
+ */
+service DataPilotFieldGroupEnumeration
+{
+ //-------------------------------------------------------------------------
+
+ /** provides methods to access the group members in the enumeration.
+
+ <p>The elements of the enumeration are instances of
+ <type>DataPilotFieldGroupItem</type>.</p>
+ */
+ interface com::sun::star::container::XEnumeration;
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif
+
diff --git a/offapi/com/sun/star/sheet/DataPilotFieldGroupInfo.idl b/offapi/com/sun/star/sheet/DataPilotFieldGroupInfo.idl
index 1ecf58e013c9..690d9342a568 100644
--- a/offapi/com/sun/star/sheet/DataPilotFieldGroupInfo.idl
+++ b/offapi/com/sun/star/sheet/DataPilotFieldGroupInfo.idl
@@ -50,75 +50,113 @@ published struct DataPilotFieldGroupInfo
{
//-------------------------------------------------------------------------
- /** specifies whether the start value for the grouping is taken automatically
- */
-
- boolean HasAutoStart;
+ /** specifies whether the start value for the grouping is taken
+ automatically from the minimum of the item values.
+
+ <p><ul>
+ <li>If <FALSE/> is set, the value from <member>Start</member> will be
+ used as start value for the grouping.</li>
+ <li>If <TRUE/> is set, the start value for the grouping will be
+ calculated automatically from the minimum of all member values of the
+ DataPilot field.</li>
+ </ul></p>
+ */
+ boolean HasAutoStart;
//-------------------------------------------------------------------------
- /** specifies whether the end value for the grouping is taken automatically
- */
+ /** specifies whether the end value for the grouping is taken
+ automatically from the maximum of the item values.
- boolean HasAutoEnd;
+ <p><ul>
+ <li>If <FALSE/> is set, the value from <member>End</member> will be
+ used as end value for the grouping.</li>
+ <li>If <TRUE/> is set, the end value for the grouping will be
+ calculated automatically from the maximum of all member values of the
+ DataPilot field.</li>
+ </ul></p>
+ */
+ boolean HasAutoEnd;
//-------------------------------------------------------------------------
- /** specifies whether date values are grouped
- */
-
- boolean HasDateValues;
+ /** specifies whether date values are grouped by ranges of days.
+
+ <p><ul>
+ <li>If <FALSE/> is set, and <member>GroupBy</member> contains zero,
+ grouping is performed inplace on the item values.</li>
+ <li>If <FALSE/> is set, and <member>GroupBy</member> contains one or
+ more flags from <type>DataPilotFieldGroupBy</type>, grouping is
+ performed on date or time.</li>
+ <li>If <TRUE/> is set, <member>Step</member> contains a value greater
+ than or equal to 1, and <member>GroupBy</member> set to <const>
+ DataPilotFieldGroupBy::DAYS</const>, grouping is performed on ranges
+ of days (see descriptions for <member>
+ XDataPilotFieldGrouping::createDateGroup</member> for more details
+ about day grouping).</li>
+ </ul></p>
+ */
+ boolean HasDateValues;
//-------------------------------------------------------------------------
- /** specifies the start value for the grouping if HasAutoStart is false
- */
-
- double Start;
+ /** specifies the start value for the grouping if <member>HasAutoStart
+ </member> is set to <FALSE/>.
+ */
+ double Start;
//-------------------------------------------------------------------------
- /** specifies the end value for the grouping if HasAutoEnd is false
- */
-
- double End;
+ /** specifies the end value for the grouping if <member>HasAutoEnd
+ </member> is set to <FALSE/>.
+ */
+ double End;
//-------------------------------------------------------------------------
- /** specifies the steps between the groups
- */
+ /** specifies the size of the ranges for numeric or day grouping.
- double Step;
+ <p>Example: With <member>HasAutoStart</member> set to <FALSE/>,
+ <member>Start</member> set to 2, and <member>Step</member> set to 3,
+ the first group will contain all values greater than or equal to 2 and
+ less than 5. The second group will contain all values greater than or
+ equal to 5 and less then 8, and so on.</p>
+ */
+ double Step;
//-------------------------------------------------------------------------
/** specifies the grouping of the date values.
- @see com::sun::star::sheet::DataPilotFieldGroupBy
-
- */
-
- long GroupBy;
+ @see DataPilotFieldGroupBy
+ */
+ long GroupBy;
//-------------------------------------------------------------------------
- /** specifies the source field.
-
- @see com::sun::star::sheet::DataPilotField
+ /** contains the source DataPilot field grouping is based on. Will be
+ <NULL/> if this field is not grouped or contains numeric grouping.
- */
-
- com::sun::star::sheet::XDataPilotField SourceField;
+ @see DataPilotField
+ */
+ XDataPilotField SourceField;
//-------------------------------------------------------------------------
- /** specifies the groups if there are some
-
- @see com::sun::star::sheet::DataPilotFieldGroups
+ /** specifies the named groups in this field if there are some.
- */
+ <p>The returned object is an instance of <type>DataPilotFieldGroups
+ </type>. The collection of groups can be modified by inserting,
+ removing, replacing, or renaming single groups or item names in the
+ groups. When writing back this struct containing such a changed
+ collection of groups to the <member>DataPilotField::GroupInfo</member>
+ property, the modified grouping settings are applied at the DataPilot
+ field.</p>
- com::sun::star::container::XNameAccess Groups;
+ @see DataPilotField
+ @see DataPilotFieldGroups
+ */
+ com::sun::star::container::XNameAccess Groups;
};
//=============================================================================
diff --git a/offapi/com/sun/star/sheet/DataPilotFieldGroups.idl b/offapi/com/sun/star/sheet/DataPilotFieldGroups.idl
index 0c195e41dfd7..2c60d9a4b71b 100644
--- a/offapi/com/sun/star/sheet/DataPilotFieldGroups.idl
+++ b/offapi/com/sun/star/sheet/DataPilotFieldGroups.idl
@@ -31,8 +31,8 @@
#ifndef __com_sun_star_sheet_DataPilotFieldGroups_idl__
#define __com_sun_star_sheet_DataPilotFieldGroups_idl__
-#ifndef __com_sun_star_container_XNameAccess_idl__
-#include <com/sun/star/container/XNameAccess.idl>
+#ifndef __com_sun_star_container_XNameContainer_idl__
+#include <com/sun/star/container/XNameContainer.idl>
#endif
#ifndef __com_sun_star_container_XEnumerationAccess_idl__
#include <com/sun/star/container/XEnumerationAccess.idl>
@@ -49,13 +49,19 @@ module com { module sun { module star { module sheet {
/** represents a collection of groups in a data pilot field.
- @see com::sun::star::sheet::DataPilotFieldGroup
+ <p>The members of this collection are instances of <type>DataPilotFieldGroup</type>
+ containing the names of all items in the group.</p>
+
+ @see DataPilotField
+ @see DataPilotFieldGroup
+ @see DataPilotFieldGroupInfo
*/
published service DataPilotFieldGroups
{
//-------------------------------------------------------------------------
- /** provides access to the data pilot field groups in the collection via index.
+ /** provides access to the data pilot field groups in the collection via
+ index.
*/
interface com::sun::star::container::XIndexAccess;
@@ -63,16 +69,57 @@ published service DataPilotFieldGroups
/** creates an enumeration of all data pilot field groups.
- @see com::sun::star::sheet::DataPilotItemsEnumeration
+ @see DataPilotFieldGroupsEnumeration
*/
interface com::sun::star::container::XEnumerationAccess;
//-------------------------------------------------------------------------
- /** provides access to the data pilot field groups in the collection via name.
+ /** provides access to the data pilot field groups in the collection via
+ name.
*/
interface com::sun::star::container::XNameAccess;
+ //-------------------------------------------------------------------------
+
+ /** provides read/write access to the data pilot field groups in the
+ collection via name.
+
+ <p>The <type scope="com::sun::star::container">XNameContainer</type>
+ and <type scope="com::sun::star::container">XNameReplace</type>
+ interfaces can be used to manage the item groups. It is possible to
+ insert, remove, and replace item groups.</p>
+
+ <p>The method <member scope="com::sun::star::container">
+ XNameReplace::replaceByName</member> can be used to replace the item
+ names in an existing group with a new collection of item names. An
+ implementation should support the following data types:
+
+ <ul>
+ <li>an empty <atom>any</atom> to remove all items and leave the
+ group empty. The group can be filled later with new item names.</li>
+ <li>a <atom dim="[]">string</atom> containing all item names that will
+ be part of the group.</li>
+ <li>an object supporting <type scope="com::sun::star::container">
+ XIndexAccess</type> containing elements that provide an item name per
+ element via the interface <type scope="com::sun::star::container">
+ XNamed</type>, for example an instance of <type>DataPilotFieldGroup
+ </type>.</li>
+ </ul></p>
+
+ <p>The method <member scope="com::sun::star::container">
+ XNameContainer::insertByName</member> can be used to insert a new
+ field group with the passed collection of item names. An
+ implementation should support the same data types as described above
+ for the method <member scope="com::sun::star::container">
+ XNameReplace::replaceByName</member>.</p>
+
+ <p>The method <member scope="com::sun::star::container">
+ XNameContainer::removeByName</member> can be used to remove an
+ existing field group.</p>
+ */
+ [optional] interface com::sun::star::container::XNameContainer;
+
};
//=============================================================================
diff --git a/offapi/com/sun/star/sheet/DataPilotFieldGroupsEnumeration.idl b/offapi/com/sun/star/sheet/DataPilotFieldGroupsEnumeration.idl
new file mode 100644
index 000000000000..4b0f29b70108
--- /dev/null
+++ b/offapi/com/sun/star/sheet/DataPilotFieldGroupsEnumeration.idl
@@ -0,0 +1,67 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2008 by Sun Microsystems, Inc.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * $RCSfile: DataPilotItemsEnumeration.idl,v $
+ * $Revision: 1.4 $
+ *
+ * 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_sheet_DataPilotFieldGroupsEnumeration_idl__
+#define __com_sun_star_sheet_DataPilotFieldGroupsEnumeration_idl__
+
+#ifndef __com_sun_star_container_XEnumeration_idl__
+#include <com/sun/star/container/XEnumeration.idl>
+#endif
+
+//=============================================================================
+
+module com { module sun { module star { module sheet {
+
+//=============================================================================
+
+/** represents an enumeration of member groups in a DataPilot field.
+
+ @see DataPilotFieldGroup
+ @see DataPilotFieldGroups
+ */
+service DataPilotFieldGroupsEnumeration
+{
+ //-------------------------------------------------------------------------
+
+ /** provides methods to access the field groups in the enumeration.
+
+ <p>The elements of the enumeration are instances of
+ <type>DataPilotFieldGroup</type>.</p>
+ */
+ interface com::sun::star::container::XEnumeration;
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif
+
diff --git a/offapi/com/sun/star/sheet/DataPilotItem.idl b/offapi/com/sun/star/sheet/DataPilotItem.idl
index b93746617514..89ca7e21c779 100644
--- a/offapi/com/sun/star/sheet/DataPilotItem.idl
+++ b/offapi/com/sun/star/sheet/DataPilotItem.idl
@@ -72,9 +72,9 @@ service DataPilotItem
//=========================================================================
- /** specifies whether the item is hidden.
- */
- [property] boolean IsHidden;
+ /** specifies whether the item is hidden.
+ */
+ [property] boolean IsHidden;
//=========================================================================
@@ -82,7 +82,7 @@ service DataPilotItem
@since OOo 2.4.0
*/
- [optional, property] boolean Position;
+ [optional, property] long Position;
};
//=============================================================================
diff --git a/offapi/com/sun/star/sheet/DataPilotItems.idl b/offapi/com/sun/star/sheet/DataPilotItems.idl
index 0b773f981196..3cf5ad244717 100644
--- a/offapi/com/sun/star/sheet/DataPilotItems.idl
+++ b/offapi/com/sun/star/sheet/DataPilotItems.idl
@@ -47,7 +47,9 @@ module com { module sun { module star { module sheet {
//=============================================================================
-/** represents a collection of Items in a data pilot field.
+/** represents a collection of items in a data pilot field.
+
+ @see DataPilotItem
*/
service DataPilotItems
{
diff --git a/offapi/com/sun/star/sheet/DatabaseRange.idl b/offapi/com/sun/star/sheet/DatabaseRange.idl
index b613b4eb74cd..eb2fe13d0262 100644
--- a/offapi/com/sun/star/sheet/DatabaseRange.idl
+++ b/offapi/com/sun/star/sheet/DatabaseRange.idl
@@ -160,7 +160,7 @@ published service DatabaseRange
@see com::sun::star::sheet::FormulaToken
@see com::sun::star::sheet::FormulaMapGroupSpecialOffset::DB_AREA
- @since OOo 2.x
+ @since OOo 3.0
*/
[optional, readonly, property] long TokenIndex;
};
diff --git a/offapi/com/sun/star/sheet/ExternalLinkInfo.idl b/offapi/com/sun/star/sheet/ExternalLinkInfo.idl
index 52758ec12474..2842b7077949 100644
--- a/offapi/com/sun/star/sheet/ExternalLinkInfo.idl
+++ b/offapi/com/sun/star/sheet/ExternalLinkInfo.idl
@@ -46,30 +46,29 @@ module com { module sun { module star { module sheet {
struct ExternalLinkInfo
{
//-------------------------------------------------------------------------
-
/** Link type, one of <type>ExternalLinkType</type> constants.
*/
-
long Type;
//-------------------------------------------------------------------------
-
/** Location of this link type.
- Modes used:
-
- 1. If <member>Type</member> is <const>ExternalLinkType::EXTERNAL</const>,
- this member shall contain a string with the <b>URI</b> of a
- document. The formula that would need this information for example
- would contain =[1]Sheet1!A1 or ='[1]Sheet name'!A1 where [1] does
- resolve to the URI contained in this Location member. Note that
- the quotes cover both, the document name and the sheet name.
-
- 2. If <member>Type</member> is <type>ExternalLinkType::DDE</type>,
- this member shall contain a <type>DDELinkType</type> describing
- service name, topic, and all known items of a DDE link.
+ <p>Modes used:
+
+ <ol>
+ <li>If <member>Type</member> is <const>ExternalLinkType::EXTERNAL
+ </const>, this member shall contain a <atom>string</atom> with the
+ <em>URI</em> of a document. The formula that would need this
+ information for example would contain <code>=[1]Sheet1!A1</code> or
+ <code>='[1]Sheet name'!A1</code> where <em>[1]</em> does resolve to
+ the URI contained in the member <member>Data</member>. Note that the
+ quotes cover both, the document name and the sheet name.</li>
+
+ <li>If <member>Type</member> is <const>ExternalLinkType::DDE</const>,
+ this member shall contain a <type>DDELinkInfo</type> describing
+ service name, topic, and all known items of a DDE link.</li>
+ </ol></p>
*/
-
any Data;
};
diff --git a/offapi/com/sun/star/sheet/FilterFormulaParser.idl b/offapi/com/sun/star/sheet/FilterFormulaParser.idl
new file mode 100644
index 000000000000..ed1a1d073e29
--- /dev/null
+++ b/offapi/com/sun/star/sheet/FilterFormulaParser.idl
@@ -0,0 +1,55 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2008 by Sun Microsystems, Inc.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * $RCSfile: FilterFormulaParser.idl,v $
+ * $Revision: 1.1 $
+ *
+ * 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_sheet_FilterFormulaParser_idl__
+#define __com_sun_star_sheet_FilterFormulaParser_idl__
+
+#include <com/sun/star/sheet/XFilterFormulaParser.idl>
+#include <com/sun/star/lang/XComponent.idl>
+
+//=============================================================================
+
+module com { module sun { module star { module sheet {
+
+//=============================================================================
+
+/** A service used to implement parsing and printing formula strings in a
+ specific formula language.
+ */
+service FilterFormulaParser : XFilterFormulaParser
+{
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif
+
diff --git a/offapi/com/sun/star/sheet/FilterOperator2.idl b/offapi/com/sun/star/sheet/FilterOperator2.idl
new file mode 100644
index 000000000000..94935979c8f5
--- /dev/null
+++ b/offapi/com/sun/star/sheet/FilterOperator2.idl
@@ -0,0 +1,164 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2008 by Sun Microsystems, Inc.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * $RCSfile: FilterOperator2.idl,v $
+ * $Revision: 1.7 $
+ *
+ * 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_sheet_FilterOperator2_idl__
+#define __com_sun_star_sheet_FilterOperator2_idl__
+
+//=============================================================================
+
+module com { module sun { module star { module sheet {
+
+//=============================================================================
+
+/** specifies the type of a single condition in a filter descriptor.
+
+ <p>This constants group extends the <type>FilterOperator</type> enum by
+ additional filter operators.</p>
+
+ @since OOo 3.2
+ */
+published constants FilterOperator2
+{
+
+ //-------------------------------------------------------------------------
+
+ /** selects empty entries.
+ */
+ const long EMPTY = 0;
+
+ //-------------------------------------------------------------------------
+
+ /** selects non-empty entries.
+ */
+ const long NOT_EMPTY = 1;
+
+ //-------------------------------------------------------------------------
+
+ /** value has to be equal to the specified value.
+ */
+ const long EQUAL = 2;
+
+ //-------------------------------------------------------------------------
+
+ /** value must not be equal to the specified value.
+ */
+ const long NOT_EQUAL = 3;
+
+ //-------------------------------------------------------------------------
+
+ /** value has to be greater than the specified value.
+ */
+ const long GREATER = 4;
+
+ //-------------------------------------------------------------------------
+
+ /** value has to be greater than or equal to the specified value.
+ */
+ const long GREATER_EQUAL = 5;
+
+ //-------------------------------------------------------------------------
+
+ /** value has to be less than the specified value.
+ */
+ const long LESS = 6;
+
+ //-------------------------------------------------------------------------
+
+ /** value has to be less than or equal to the specified value.
+ */
+ const long LESS_EQUAL = 7;
+
+ //-------------------------------------------------------------------------
+
+ /** selects a specified number of entries with the greatest values.
+ */
+ const long TOP_VALUES = 8;
+
+ //-------------------------------------------------------------------------
+
+ /** selects a specified percentage of entries with the greatest values.
+ */
+ const long TOP_PERCENT = 9;
+
+ //-------------------------------------------------------------------------
+
+ /** selects a specified number of entries with the lowest values.
+ */
+ const long BOTTOM_VALUES = 10;
+
+ //-------------------------------------------------------------------------
+
+ /** selects a specified percentage of entries with the lowest values.
+ */
+ const long BOTTOM_PERCENT = 11;
+
+ //-------------------------------------------------------------------------
+
+ /** selects contains entries.
+ */
+ const long CONTAINS = 12;
+
+ //-------------------------------------------------------------------------
+
+ /** selects does-not-contain entries.
+ */
+ const long DOES_NOT_CONTAIN = 13;
+
+ //-------------------------------------------------------------------------
+
+ /** selects begins-with entries.
+ */
+ const long BEGINS_WITH = 14;
+
+ //-------------------------------------------------------------------------
+
+ /** selects does-not-begin-with entries.
+ */
+ const long DOES_NOT_BEGIN_WITH = 15;
+ //-------------------------------------------------------------------------
+
+ /** selects ends-with entries.
+ */
+ const long ENDS_WITH = 16;
+
+ //-------------------------------------------------------------------------
+
+ /** selects does-not-end-with entries.
+ */
+ const long DOES_NOT_END_WITH = 17;
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif
+
diff --git a/offapi/com/sun/star/sheet/FormulaMapGroupSpecialOffset.idl b/offapi/com/sun/star/sheet/FormulaMapGroupSpecialOffset.idl
index d205c1487536..c4b2babd7b4c 100644
--- a/offapi/com/sun/star/sheet/FormulaMapGroupSpecialOffset.idl
+++ b/offapi/com/sun/star/sheet/FormulaMapGroupSpecialOffset.idl
@@ -41,7 +41,7 @@ module com { module sun { module star { module sheet {
<member>XFormulaOpCodeMapper::getAvailableMappings</member> when
called for group <const>FormulaMapGroup::SPECIAL</const>.
- The number of constants may grow in future versions!
+ <p>The number of constants may grow in future versions!</p>
*/
constants FormulaMapGroupSpecialOffset
{
@@ -56,26 +56,24 @@ constants FormulaMapGroupSpecialOffset
<ul>
<li>A value of type <atom>double</atom> for literal floating-point
- constants.</li>
+ constants.</li>
<li>A <atom>string</atom> for literal text.</li>
- <li>A sequence of sequence of <atom>any</atom> for a literal array.
- The contained values shall be of type <atom>double</atom> or
- <atom>string</atom>. Floating-point values and strings may occur
- together in an array.</li>
+ <li>A <atom dim="[][]">any</atom> for a literal array. The contained
+ values shall be of type <atom>double</atom> or atom>string</atom>.
+ Floating-point values and strings may occur together in an array.</li>
<li>A struct of type <type>SingleReference</type> for a reference to a
- single cell in the own document.</li>
+ single cell in the own document.</li>
<li>A struct of type <type>ComplexReference</type> for a reference to
- a range of cells in the own document.</li>
+ a range of cells in the own document.</li>
<li>A struct of type <type>ExternalReference</type> for a reference to
- a cell, a range of cells, or a defined name in an external
- document.</li>
+ a cell, a range of cells, or a defined name in an external document.</li>
</ul>
*/
- const long PUSH = 0;
+ const long PUSH = 0;
// -----------------------------------------------------------------------
- const long CALL = 1;
+ const long CALL = 1;
// -----------------------------------------------------------------------
@@ -86,7 +84,7 @@ constants FormulaMapGroupSpecialOffset
<p>The <member>FormulaToken::Data</member> member is not used
and should be empty.</p>
*/
- const long STOP = 2;
+ const long STOP = 2;
// -----------------------------------------------------------------------
@@ -99,7 +97,7 @@ constants FormulaMapGroupSpecialOffset
"com.sun.star.sheet.addin.Analysis.getEomonth" for the EOMONTH
function from the Analsysis add-in.</p>
*/
- const long EXTERNAL = 3;
+ const long EXTERNAL = 3;
// -----------------------------------------------------------------------
@@ -110,11 +108,11 @@ constants FormulaMapGroupSpecialOffset
<p>The <member>FormulaToken::Data</member> member shall contain an
integer value of type <atom>long</atom> specifying the index of the
defined name. This index can be obtained from the defined name using
- its <type>NamedRange::TokenIndex</type> property.</p>
+ its <member>NamedRange::TokenIndex</member> property.</p>
@see NamedRange
*/
- const long NAME = 4;
+ const long NAME = 4;
// -----------------------------------------------------------------------
@@ -124,20 +122,21 @@ constants FormulaMapGroupSpecialOffset
<p>The <member>FormulaToken::Data</member> member is not used
and should be empty.</p>
*/
- const long NO_NAME = 5;
+ const long NO_NAME = 5;
// -----------------------------------------------------------------------
/** Formula tokens containing the op-code obtained from this offset
describe an empty function parameter.
- <p>Example: In the formula =SUM(1;;2) the second parameter is empty
- and represented by a formula token containing the "empty" op-code.</p>
+ <p>Example: In the formula <code>=SUM(1;;2)</code> the second
+ parameter is empty and represented by a formula token containing the
+ "missing" op-code.</p>
<p>The <member>FormulaToken::Data</member> member is not used
and should be empty.</p>
*/
- const long MISSING = 6;
+ const long MISSING = 6;
// -----------------------------------------------------------------------
@@ -147,17 +146,17 @@ constants FormulaMapGroupSpecialOffset
<p>The <member>FormulaToken::Data</member> member shall contain a
<atom>string</string> with the bad data. This string will be displayed
- in the formula.</p>
+ literally in the formula.</p>
*/
- const long BAD = 7;
+ const long BAD = 7;
// -----------------------------------------------------------------------
/** Formula tokens containing the op-code obtained from this offset
- describe white-space characters within the string representation of a
+ describe whitespace characters within the string representation of a
formula.
- <p>White-space characters in formulas are used for readability and do
+ <p>Whitespace characters in formulas are used for readability and do
not affect the result of the formula.</p>
<p>The <member>FormulaToken::Data</member> member shall contain a
@@ -168,11 +167,11 @@ constants FormulaMapGroupSpecialOffset
characters than simple space characters (e.g. line feeds, horizontal
tabulators, non-breakable spaces).</p>
*/
- const long SPACES = 8;
+ const long SPACES = 8;
// -----------------------------------------------------------------------
- const long MAT_REF = 9;
+ const long MAT_REF = 9;
// -----------------------------------------------------------------------
@@ -182,7 +181,7 @@ constants FormulaMapGroupSpecialOffset
<p>The <member>FormulaToken::Data</member> member shall contain an
integer value of type <atom>long</atom> specifying the index of the
database range. This index can be obtained from the database range
- using its <type>DatabaseRange::TokenIndex</type> property.</p>
+ using its <member>DatabaseRange::TokenIndex</member> property.</p>
@see DatabaseRange
*/
diff --git a/offapi/com/sun/star/sheet/FormulaParser.idl b/offapi/com/sun/star/sheet/FormulaParser.idl
index 7bc919286359..2f8be7e8ee9b 100644
--- a/offapi/com/sun/star/sheet/FormulaParser.idl
+++ b/offapi/com/sun/star/sheet/FormulaParser.idl
@@ -37,9 +37,6 @@
#ifndef __com_sun_star_sheet_XFormulaParser_idl__
#include <com/sun/star/sheet/XFormulaParser.idl>
#endif
-#ifndef __com_sun_star_table_CellAddress_idl__
-#include <com/sun/star/table/CellAddress.idl>
-#endif
#ifndef __com_sun_star_sheet_FormulaOpCodeMapEntry_idl__
#include <com/sun/star/sheet/FormulaOpCodeMapEntry.idl>
#endif
@@ -65,24 +62,20 @@ service FormulaParser
// ------------------------------------------------------------------------
- [property] com::sun::star::table::CellAddress ReferencePosition;
-
- // ------------------------------------------------------------------------
-
- /** Whether to use English parser and formatter.
+ /** specifies whether to use English parser and formatter.
- Note: When changing this, an already existing
- <member>OpCodeMap</member> needs to be recreated internally, so
- for performance reasons set this _before_ setting the OpCodeMap.
+ <p>Note: When changing this, an already existing <member>OpCodeMap
+ </member> needs to be recreated internally, so for performance reasons
+ set this <em>before</em> setting the <member>OpCodeMap</member>.
*/
[property] boolean CompileEnglish;
// ------------------------------------------------------------------------
- /** Specifies which address reference style convention to use when
+ /** specifies which address reference style convention to use when
parsing a formula string.
- @see com::sun::star::sheet::AddressConvention
+ @see AddressConvention
*/
[property] short FormulaConvention;
@@ -96,22 +89,22 @@ service FormulaParser
// ------------------------------------------------------------------------
- /** The complete mapping of Names to OpCodes.
+ /** contains the complete mapping of names to op-codes.
- Names and symbols not defined here lead to a parser/print error.
+ <p>Names and symbols not defined here lead to a parser/print error.</p>
*/
[property] sequence< FormulaOpCodeMapEntry > OpCodeMap;
// ------------------------------------------------------------------------
- /** List of external links referenced in formulas.
+ /** contains a list of external links referenced in formulas.
- Use of this property depends on the
- <member>FormulaConvention</member> in use. It is relevant only
- for <type>AddressConvention::XL_OOX</type> to map indices to
- external documents. The sequence must be in the order of indices
- used. Note that indices are 1-based, the sequence must start
- with an empty element.
+ <p>Use of this property depends on the <member>FormulaConvention
+ </member> in use. It is relevant only for <const>
+ AddressConvention::XL_OOX</const> to map indices to external
+ documents. The sequence must be in the order of indices used. Note
+ that indices are 1-based, the sequence must start with an empty
+ element.</p>
@since OOo3.1
*/
diff --git a/offapi/com/sun/star/sheet/NamedRange.idl b/offapi/com/sun/star/sheet/NamedRange.idl
index 65c14dc2fcdf..c6f97c0f09e2 100644
--- a/offapi/com/sun/star/sheet/NamedRange.idl
+++ b/offapi/com/sun/star/sheet/NamedRange.idl
@@ -84,7 +84,7 @@ published service NamedRange
@see com::sun::star::sheet::FormulaToken
@see com::sun::star::sheet::FormulaMapGroupSpecialOffset::NAME
- @since OOo 2.x
+ @since OOo 3.0
*/
[optional, readonly, property] long TokenIndex;
diff --git a/offapi/com/sun/star/sheet/TableFilterField2.idl b/offapi/com/sun/star/sheet/TableFilterField2.idl
new file mode 100644
index 000000000000..1cf50ddd547b
--- /dev/null
+++ b/offapi/com/sun/star/sheet/TableFilterField2.idl
@@ -0,0 +1,106 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2008 by Sun Microsystems, Inc.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * $RCSfile: TableFilterField2.idl,v $
+ * $Revision: 1.7 $
+ *
+ * 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_sheet_TableFilterField2_idl__
+#define __com_sun_star_sheet_TableFilterField2_idl__
+
+
+#ifndef __com_sun_star_sheet_FilterConnection_idl__
+#include <com/sun/star/sheet/FilterConnection.idl>
+#endif
+
+#ifndef __com_sun_star_sheet_FilterOperator2_idl__
+#include <com/sun/star/sheet/FilterOperator2.idl>
+#endif
+
+//=============================================================================
+
+module com { module sun { module star { module sheet {
+
+//=============================================================================
+
+/** describes a single condition in a filter descriptor.
+
+ <p>This struct has the <type>FilterOperator2</type> constants group as
+ member, whereas the <type>TableFilterField</type> struct uses the
+ <type>FilterOperator</type> enum.</p>
+
+ @see com::sun::star::sheet::SheetFilterDescriptor
+ @since OOo 3.2
+ */
+published struct TableFilterField2
+{
+ //-------------------------------------------------------------------------
+
+ /** specifies how the condition is connected to the previous condition.
+ */
+ com::sun::star::sheet::FilterConnection Connection;
+
+ //-------------------------------------------------------------------------
+
+ /** specifies which field (column) is used for the condition.
+ */
+ long Field;
+
+ //-------------------------------------------------------------------------
+
+ /** specifies the type of the condition as defined in
+ <type>FilterOperator2</type>.
+ */
+ long Operator;
+
+ //-------------------------------------------------------------------------
+
+ /** selects whether the <member>TableFilterField2::NumericValue</member>
+ or the <member>TableFilterField2::StringValue</member> is used.
+ */
+ boolean IsNumeric;
+
+ //-------------------------------------------------------------------------
+
+ /** specifies a numeric value for the condition.
+ */
+ double NumericValue;
+
+ //-------------------------------------------------------------------------
+
+ /** specifies a string value for the condition.
+ */
+ string StringValue;
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
+
+#endif
+
diff --git a/offapi/com/sun/star/sheet/XDataPilotDataLayoutFieldSupplier.idl b/offapi/com/sun/star/sheet/XDataPilotDataLayoutFieldSupplier.idl
new file mode 100644
index 000000000000..c74126aaf64e
--- /dev/null
+++ b/offapi/com/sun/star/sheet/XDataPilotDataLayoutFieldSupplier.idl
@@ -0,0 +1,77 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2008 by Sun Microsystems, Inc.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * $RCSfile: XDataPilotDataLayoutFieldSupplier.idl,v $
+ * $Revision: 1.1 $
+ *
+ * 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_sheet_XDataPilotDataLayoutFieldSupplier_idl__
+#define __com_sun_star_sheet_XDataPilotDataLayoutFieldSupplier_idl__
+
+#ifndef __com_sun_star_sheet_XDataPilotField_idl__
+#include <com/sun/star/sheet/XDataPilotField.idl>
+#endif
+
+//=============================================================================
+
+module com { module sun { module star { module sheet {
+
+//=============================================================================
+
+/** Provides access to the <type>DataPilotField</type> used to layout
+ multiple data fields.
+
+ <p>This data field can be inserted into the rows dimension or columns
+ dimension by changing its <member scope="DataPilotField">Orientation</member>
+ property. This interface can be used to access the data layout field
+ before multiple data fields are inserted into the DataPilot table. It
+ remains invisible as long as the DataPilot table contains at most one data
+ field.</p>
+
+ @see com::sun::star::sheet::DataPilotDescriptor
+ @see com::sun::star::sheet::DataPilotTable
+ */
+published interface XDataPilotDataLayoutFieldSupplier
+{
+ //-------------------------------------------------------------------------
+
+ /** Returns the <type>DataPilotField</type> used to layout multiple data
+ fields.
+
+ <p>If the field does not exist yet, it will be created. It is possible
+ to insert this field into the rows or columns dimension by changing
+ its <member scope="DataPilotField">Orientation</member> property.</p>
+ */
+ XDataPilotField getDataLayoutField();
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif
+
diff --git a/offapi/com/sun/star/sheet/XDataPilotDescriptor.idl b/offapi/com/sun/star/sheet/XDataPilotDescriptor.idl
index 1a29dfcdf4b9..b1f4f32aa978 100644
--- a/offapi/com/sun/star/sheet/XDataPilotDescriptor.idl
+++ b/offapi/com/sun/star/sheet/XDataPilotDescriptor.idl
@@ -57,7 +57,7 @@ module com { module sun { module star { module sheet {
<p>This interface extends the interface
<type scope="com::sun::star::container">XNamed</type> which provides
- access to the name of the data pilot table used i.e. in collections.</p>
+ access to the name of the data pilot table used e.g. in collections.</p>
@see com::sun::star::sheet::DataPilotDescriptor
@see com::sun::star::sheet::DataPilotTable
diff --git a/offapi/com/sun/star/sheet/XDataPilotFieldGrouping.idl b/offapi/com/sun/star/sheet/XDataPilotFieldGrouping.idl
index ffbb560a8930..03ff2a6bc182 100644
--- a/offapi/com/sun/star/sheet/XDataPilotFieldGrouping.idl
+++ b/offapi/com/sun/star/sheet/XDataPilotFieldGrouping.idl
@@ -48,43 +48,123 @@ module com { module sun { module star { module sheet {
//=============================================================================
-/** provides methods to control a data pilot field which has already
- been created.
+/** Provides methods to create new DataPilot fields where some or all items of
+ this DataPilot field are grouped in some way.
- @see com::sun::star::sheet::DataPilotField
+ @see DataPilotField
*/
published interface XDataPilotFieldGrouping: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
- /** Creates a new Field which contains a group containing the given Items.
+ /** Creates a new DataPilot field which contains a group containing the
+ given DataPilot field items (members).
- @returns
- the new created field if there is one created.
+ <p>It is possible to create multiple groups by calling this method
+ several times at the same DataPilot field. On subsequent calls, the
+ DataPilot field created at the first call is used to insert the new
+ groups.</p>
- @see com::sun::star::sheet::DataPilotField
+ <p>The collection of groups can be accessed via the
+ <member>DataPilotField::GroupInfo</member> property. The returned
+ struct contains the sequence of groups in its member
+ <member>DataPilotFieldGroupInfo::Groups</member>.</p>
@param aItems
- A sequence containing the Item names which have to be in the new group. This
- have to be Items of the current field.
+ a sequence containing the names of the items (members) which will
+ be part of the new group. Must be names of items contained in the
+ current field.
+
+ @returns
+ the new created field if there is one created on the first call of
+ this method. <NULL/> is returned on subsequent calls.
+
+ @see DataPilotField
+ @see DataPilotFieldGroupInfo
*/
- com::sun::star::sheet::XDataPilotField createNameGroup([in] sequence< string > aItems)
+ XDataPilotField createNameGroup([in] sequence< string > aItems)
raises( com::sun::star::lang::IllegalArgumentException );
//-------------------------------------------------------------------------
- /** Creates a new Field if the current field is grouped by dates. Doesn't create a new field
- if the field contains no dates or it isn't grouped yet.
+ /** Groups the members of this field by dates, according to the passed
+ settings.
+
+ <p>If this field is already grouped by dates, a new DataPilot field
+ will be created and returned. If this field is not grouped at all, the
+ date grouping is perfomed inside of this field (no new field will be
+ created). There must not be any other grouping (by member names or by
+ numeric ranges), otherwise an exception is thrown.</p>
+
+ @param aInfo
+ contains the information how to group the items of the field. The
+ members of this struct have to fulfill the following requirements:
+
+ <ul>
+ <li>If the member <member>DataPilotFieldGroupInfo::HasAutoStart
+ </member> is set to <FALSE/>, then the value of <member>
+ DataPilotFieldGroupInfo::Start</member> must be a floating-point
+ value representing a valid date/time value (if <member>
+ DataPilotFieldGroupInfo::HasAutoStart</member> is set to <TRUE/>,
+ the value of <member>DataPilotFieldGroupInfo::Start</member> will
+ be ignored).</li>
+
+ <li>If the member <member>DataPilotFieldGroupInfo::HasAutoEnd
+ </member> is set to <FALSE/>, then the value of <member>
+ DataPilotFieldGroupInfo::End</member> must be a floating-point
+ value representing a valid date/time value( if <member>
+ DataPilotFieldGroupInfo::HasAutoEnd</member> is set to <TRUE/>,
+ the value of <member>DataPilotFieldGroupInfo::End</member> will be
+ ignored).</li>
+
+ <li>If the members <member>DataPilotFieldGroupInfo::HasAutoStart
+ </member> and <member>DataPilotFieldGroupInfo::HasAutoEnd</member>
+ are set to <FALSE/> both, then the value of <member>
+ DataPilotFieldGroupInfo::Start</member> must be less than or equal
+ to the value of <member>DataPilotFieldGroupInfo::End</member>.</li>
+
+ <li>The member <member>DataPilotFieldGroupInfo::HasDateValues</member>
+ must be set to <TRUE/>.</li>
+
+ <li>The member <member>DataPilotFieldGroupInfo::Step</member> must
+ be zero, unless ranges of days have to be grouped (see the
+ description of the member GroupBy below), in that case the value
+ must be greater than or equal to 1 and less than or equal to 32767.
+ The fractional part of the value will be ignored.</li>
+
+ <li>The member <member>DataPilotFieldGroupInfo::GroupBy</member>
+ must contain exactly one of the flags from <type>DataPilotFieldGroupBy</type>.
+ A combination of several flags will not be accepted. If
+ <const>DataPilotFieldGroupBy::DAYS</const> is specified, the
+ value of the member <member>DataPilotFieldGroupInfo::Step</member>
+ will specify the type of day grouping (see above). If that value
+ is zero, grouping is performed on all days of the year (e.g. the
+ members containing the 1st of January of any year are grouped
+ together). If that value is greater than zero, grouping is done on
+ ranges of days, and the value specifies the number of days grouped
+ into one range (e.g. a value of 7 groups the members of a week
+ into a range).</li>
+
+ <li>The contents of the member <member>
+ DataPilotFieldGroupInfo::SourceField</member> will be ignored.</li>
+
+ <li>The contents of the member <member>
+ DataPilotFieldGroupInfo::Groups</member> will be ignored.</li>
+ </ul>
@returns
- the new created field if there is one created.
+ the new created field if there is one created. <NULL/> is returned,
+ if date grouping is performed inside this field (i.e. this field
+ was not grouped by dates before).
- @see com::sun::star::sheet::DataPilotField
+ @throws com::sun::star::lang::IllegalArgumentException
+ if the passed struct does not contain valid settings as described,
+ or if this field is already grouped by member names or numeric
+ ranges.
- @param aInfo
- contains the information how to group the field.
+ @see DataPilotField
*/
- com::sun::star::sheet::XDataPilotField createDateGroup([in] com::sun::star::sheet::DataPilotFieldGroupInfo aInfo)
+ XDataPilotField createDateGroup([in] DataPilotFieldGroupInfo aInfo)
raises( com::sun::star::lang::IllegalArgumentException );
};
diff --git a/offapi/com/sun/star/sheet/XFilterFormulaParser.idl b/offapi/com/sun/star/sheet/XFilterFormulaParser.idl
new file mode 100644
index 000000000000..300a0981d09d
--- /dev/null
+++ b/offapi/com/sun/star/sheet/XFilterFormulaParser.idl
@@ -0,0 +1,62 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2008 by Sun Microsystems, Inc.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * $RCSfile: XFilterFormulaParser.idl,v $
+ * $Revision: 1.1 $
+ *
+ * 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_sheet_XFilterFormulaParser_idl__
+#define __com_sun_star_sheet_XFilterFormulaParser_idl__
+
+#include <com/sun/star/sheet/XFormulaParser.idl>
+
+//=============================================================================
+
+module com { module sun { module star { module sheet {
+
+//=============================================================================
+
+/** Extends the interface <type>XFormulaParser</type> by an attribute that
+ specifies the namespace URL of the supported formula language.
+ */
+interface XFilterFormulaParser : XFormulaParser
+{
+ //-------------------------------------------------------------------------
+
+ /** Specifies the namespace URL of the formula language supported by this
+ implementation.
+ */
+ [attribute, readonly] string SupportedNamespace;
+
+ //-------------------------------------------------------------------------
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif
+
diff --git a/offapi/com/sun/star/sheet/XFormulaOpCodeMapper.idl b/offapi/com/sun/star/sheet/XFormulaOpCodeMapper.idl
index 86d3a0758a57..2877c72b4440 100644
--- a/offapi/com/sun/star/sheet/XFormulaOpCodeMapper.idl
+++ b/offapi/com/sun/star/sheet/XFormulaOpCodeMapper.idl
@@ -53,10 +53,10 @@ interface XFormulaOpCodeMapper
/** OpCode value used for external Add-In functions.
- Needed to be able to identify which of the function names map to
- an Add-In implementation where this OpCode is used in the
- returned mapping and the programmatical name is available as
- additional information.
+ <p>Needed to be able to identify which of the function names map to an
+ Add-In implementation where this OpCode is used in the returned
+ mapping and the programmatical name is available as additional
+ information.</p>
*/
[attribute, readonly] long OpCodeExternal;
@@ -64,8 +64,8 @@ interface XFormulaOpCodeMapper
/** OpCode value used for unknown functions.
- Used to identify which of the function names queried with
- <member>getMappings</member> are unknown to the implementation.
+ <p>Used to identify which of the function names queried with
+ <member>getMappings</member> are unknown to the implementation.</p>
*/
[attribute, readonly] long OpCodeUnknown;
@@ -80,36 +80,35 @@ interface XFormulaOpCodeMapper
knows.
@param Language
- Formula language to be used, one of
- <type>FormulaLanguage</type> constants. If a constant
- unknown to the implementation is passed,
- <type>com::sun::star::lang::IllegalArgumentException</type>
+ Formula language to be used, one of <type>FormulaLanguage</type>
+ constants. If a constant unknown to the implementation is passed,
+ <type scope="com::sun::star::lang">IllegalArgumentException</type>
is thrown.
@returns
- Sequence of <type>FormulaToken</type> matching the input
+ a sequence of <type>FormulaToken</type> matching the input
sequence in order.
- Each string element in <param>Names</param> according to the
- formula language in <param>Language</param> is mapped to a
- <type>FormulaToken</type> containing the internal OpCode used by
- the spreadsheet application in
- <member>FormulaToken.OpCode</member> and by contract maybe
- additional information in <member>FormulaToken.Data</member>.
-
- The order of the FormulaToken sequence returned matches the
- input order of the string sequence.
-
- An unknown Name string gets the OpCode value of
- <member>OpCodeUnknown</member assigned.
-
- Additional information in <member>FormulaToken.Data</member> is
- returned for:
-
- Add-In names: the programmatical name. The OpCode value used for
- Add-Ins can be queried with the <member>OpCodeExternal</member>
- getter method.
-
+ <p>Each string element in parameter Names according to the formula
+ language in parameter Language is mapped to a <type>FormulaToken
+ </type> containing the internal OpCode used by the spreadsheet
+ application in <member>FormulaToken::OpCode</member> and by
+ contract maybe additional information in <member>
+ FormulaToken::Data</member>.</p>
+
+ <p>The order of the FormulaToken sequence returned matches the
+ input order of the string sequence.</p>
+
+ <p>An unknown Name string gets the OpCode value of <member>
+ OpCodeUnknown</member> assigned.</p>
+
+ <p>Additional information in <member>FormulaToken::Data</member>
+ is returned for:
+ <ul>
+ <li>Add-in names: the programmatical name. The OpCode value used
+ for add-ins can be queried with the <member>OpCodeExternal</member>
+ getter method.</li>
+ </ul></p>
*/
sequence< FormulaToken > getMappings(
[in] sequence< string > Names,
@@ -122,26 +121,24 @@ interface XFormulaOpCodeMapper
a given formula language.
@param Language
- Formula language to be used, one of
- <type>FormulaLanguage</type> constants. If a constant
- unknown to the implementation is passed,
- <type>com::sun::star::lang::IllegalArgumentException</type>
+ Formula language to be used, one of <type>FormulaLanguage</type>
+ constants. If a constant unknown to the implementation is passed,
+ <type scope="com::sun::star::lang">IllegalArgumentException</type>
is thrown.
@param Groups
- Group of mappings to be returned, a bit mask of
- <type>FormulaMapGroup</type> constants.
+ Group of mappings to be returned, a bit mask of <type>
+ FormulaMapGroup</type> constants.
@returns
Sequence of <type>FormulaOpCodeMapEntry</type>.
- Each element of the formula language in <param>Language</param>
- is mapped to a <type>FormulaToken</type> containing the internal
- OpCode used by the spreadsheet application in
- <member>FormulaToken.OpCode</member> and by contract maybe
- additional information in <member>FormulaToken.Data</member>.
- See <member>getMappings</member>.
-
+ <p>Each element of the formula language in parameter Language is
+ mapped to a <type>FormulaToken</type> containing the internal
+ OpCode used by the spreadsheet application in <member>
+ FormulaToken::OpCode</member> and by contract maybe additional
+ information in <member>FormulaToken::Data</member>. See <member>
+ getMappings</member> for more details.</p>
*/
sequence< FormulaOpCodeMapEntry > getAvailableMappings(
[in] long Language, [in] long Groups )
diff --git a/offapi/com/sun/star/sheet/XFormulaParser.idl b/offapi/com/sun/star/sheet/XFormulaParser.idl
index b4c02cea3bd1..de78f00f02dd 100644
--- a/offapi/com/sun/star/sheet/XFormulaParser.idl
+++ b/offapi/com/sun/star/sheet/XFormulaParser.idl
@@ -31,13 +31,9 @@
#ifndef __com_sun_star_sheet_XFormulaParser_idl__
#define __com_sun_star_sheet_XFormulaParser_idl__
-#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
-#endif
-
-#ifndef __com_sun_star_sheet_FormulaToken_idl__
#include <com/sun/star/sheet/FormulaToken.idl>
-#endif
+#include <com/sun/star/table/CellAddress.idl>
//=============================================================================
@@ -53,13 +49,17 @@ interface XFormulaParser
/** parses a formula into a sequence of tokens.
*/
- sequence< FormulaToken > parseFormula( [in] string aFormula );
+ sequence< FormulaToken > parseFormula(
+ [in] string aFormula,
+ [in] ::com::sun::star::table::CellAddress aReferencePos );
//-------------------------------------------------------------------------
/** converts a formula into a string.
*/
- string printFormula( [in] sequence< FormulaToken > aTokens );
+ string printFormula(
+ [in] sequence< FormulaToken > aTokens,
+ [in] ::com::sun::star::table::CellAddress aReferencePos );
};
diff --git a/offapi/com/sun/star/sheet/XSheetFilterDescriptor2.idl b/offapi/com/sun/star/sheet/XSheetFilterDescriptor2.idl
new file mode 100644
index 000000000000..cc26a73c1674
--- /dev/null
+++ b/offapi/com/sun/star/sheet/XSheetFilterDescriptor2.idl
@@ -0,0 +1,79 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2008 by Sun Microsystems, Inc.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * $RCSfile: XSheetFilterDescriptor2.idl,v $
+ * $Revision: 1.9 $
+ *
+ * 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_sheet_XSheetFilterDescriptor2_idl__
+#define __com_sun_star_sheet_XSheetFilterDescriptor2_idl__
+
+#ifndef __com_sun_star_sheet_TableFilterField2_idl__
+#include <com/sun/star/sheet/TableFilterField2.idl>
+#endif
+
+#ifndef __com_sun_star_uno_XInterface_idl__
+#include <com/sun/star/uno/XInterface.idl>
+#endif
+
+//=============================================================================
+
+module com { module sun { module star { module sheet {
+
+//=============================================================================
+
+/** provides access to a collection of filter conditions (filter fields).
+
+ <p>This interface uses the <type>TableFilterField2</type> struct,
+ whereas the <type>XSheetFilterDescriptor</type> interface uses the
+ <type>TableFilterField</type> struct.</p>
+
+ @see com::sun::star::sheet::SheetFilterDescriptor
+ @since OOo 3.2
+ */
+published interface XSheetFilterDescriptor2: com::sun::star::uno::XInterface
+{
+ //-------------------------------------------------------------------------
+
+ /** returns the collection of filter fields.
+ */
+ sequence< com::sun::star::sheet::TableFilterField2 > getFilterFields2();
+
+ //-------------------------------------------------------------------------
+
+ /** sets a new collection of filter fields.
+ */
+ void setFilterFields2(
+ [in] sequence< com::sun::star::sheet::TableFilterField2 > aFilterFields );
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif
+
diff --git a/offapi/com/sun/star/sheet/makefile.mk b/offapi/com/sun/star/sheet/makefile.mk
index 61ab96c08477..468e96b9860b 100644
--- a/offapi/com/sun/star/sheet/makefile.mk
+++ b/offapi/com/sun/star/sheet/makefile.mk
@@ -84,9 +84,11 @@ IDLFILES=\
DataPilotFieldFilter.idl\
DataPilotFieldGroup.idl\
DataPilotFieldGroupBy.idl\
+ DataPilotFieldGroupEnumeration.idl\
DataPilotFieldGroupInfo.idl\
DataPilotFieldGroupItem.idl\
DataPilotFieldGroups.idl\
+ DataPilotFieldGroupsEnumeration.idl\
DataPilotFieldLayoutInfo.idl\
DataPilotFieldLayoutMode.idl\
DataPilotFieldOrientation.idl\
@@ -135,7 +137,9 @@ IDLFILES=\
FillDirection.idl\
FillMode.idl\
FilterConnection.idl\
+ FilterFormulaParser.idl\
FilterOperator.idl\
+ FilterOperator2.idl\
FormulaLanguage.idl\
FormulaMapGroup.idl\
FormulaMapGroupSpecialOffset.idl\
@@ -217,6 +221,7 @@ IDLFILES=\
TableConditionalEntryEnumeration.idl\
TableConditionalFormat.idl\
TableFilterField.idl\
+ TableFilterField2.idl\
TableOperationMode.idl\
TablePageBreakData.idl\
TablePageStyle.idl\
@@ -251,6 +256,7 @@ IDLFILES=\
XDDELink.idl\
XDDELinkResults.idl\
XDDELinks.idl\
+ XDataPilotDataLayoutFieldSupplier.idl\
XDataPilotDescriptor.idl\
XDataPilotField.idl\
XDataPilotFieldGrouping.idl\
@@ -271,6 +277,7 @@ IDLFILES=\
XExternalSheetCache.idl\
XExternalSheetName.idl\
XFillAcrossSheet.idl\
+ XFilterFormulaParser.idl\
XFormulaOpCodeMapper.idl\
XFormulaParser.idl\
XFormulaQuery.idl\
@@ -312,6 +319,7 @@ IDLFILES=\
XSheetConditionalEntries.idl\
XSheetConditionalEntry.idl\
XSheetFilterDescriptor.idl\
+ XSheetFilterDescriptor2.idl\
XSheetFilterable.idl\
XSheetFilterableEx.idl\
XSheetLinkable.idl\
diff --git a/offapi/com/sun/star/style/Style.idl b/offapi/com/sun/star/style/Style.idl
index a3492e492130..0965f849576d 100644
--- a/offapi/com/sun/star/style/Style.idl
+++ b/offapi/com/sun/star/style/Style.idl
@@ -165,7 +165,7 @@ published service Style
</ul>
- @since OOo 2.0.1.
+ @since OOo 2.0.1
*/
[optional, property] sequence< com::sun::star::beans::NamedValue > ParaStyleConditions;
diff --git a/offapi/com/sun/star/task/DocumentMSPasswordRequest.idl b/offapi/com/sun/star/task/DocumentMSPasswordRequest.idl
new file mode 100644
index 000000000000..6e4adec10720
--- /dev/null
+++ b/offapi/com/sun/star/task/DocumentMSPasswordRequest.idl
@@ -0,0 +1,67 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright IBM Corporation 2009.
+ * Copyright 2009 by Sun Microsystems, Inc.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * $RCSfile: DocumentMSPasswordRequest.idl,v $
+ * $Revision: 1.0 $
+ *
+ * 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_task_DocumentMSPasswordRequest_idl__
+#define __com_sun_star_task_DocumentMSPasswordRequest_idl__
+
+#ifndef __com_sun_star_task_PasswordRequest_idl__
+#include <com/sun/star/task/PasswordRequest.idl>
+#endif
+
+
+//=============================================================================
+
+module com { module sun { module star { module task {
+
+//=============================================================================
+/** this request specifies the mode in which the password for Microsoft Office file format encryption should be asked
+
+ <P>
+ It is supported by <type>InteractionHandler</type> service, and can
+ be used to interact for a document password. Continuations for using with
+ the mentioned service are Abort and Approve.
+ </P>
+
+ @since OOo 3.x.x
+*/
+published exception DocumentMSPasswordRequest: PasswordRequest
+{
+ //-------------------------------------------------------------------------
+ /** the name of the document
+ */
+ string Name;
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif
diff --git a/offapi/com/sun/star/task/makefile.mk b/offapi/com/sun/star/task/makefile.mk
index 366d531fc847..1559901f740c 100644
--- a/offapi/com/sun/star/task/makefile.mk
+++ b/offapi/com/sun/star/task/makefile.mk
@@ -3,6 +3,7 @@
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
#
# Copyright 2008 by Sun Microsystems, Inc.
+# Copyright IBM Corporation 2009.
#
# OpenOffice.org - a multi-platform office productivity suite
#
@@ -45,6 +46,7 @@ IDLFILES=\
ClassifiedInteractionRequest.idl\
DocumentMacroConfirmationRequest.idl\
DocumentPasswordRequest.idl\
+ DocumentMSPasswordRequest.idl\
ErrorCodeRequest.idl\
ErrorCodeIOException.idl\
FutureDocumentVersionProductUpdateRequest.idl\
diff --git a/offapi/com/sun/star/text/DocumentSettings.idl b/offapi/com/sun/star/text/DocumentSettings.idl
index 43fd5eff8f40..171a5caebb9f 100644
--- a/offapi/com/sun/star/text/DocumentSettings.idl
+++ b/offapi/com/sun/star/text/DocumentSettings.idl
@@ -129,8 +129,6 @@ published service DocumentSettings
/** specifies if the former (till OpenOffice.org 1.1) or the new
line spacing formatting is applied.
- @since OOo 2.0.0
-
<p>This property controls how a set line spacing at a paragraph
influences the formatting of the text lines and the spacing between
paragraphs.
@@ -144,14 +142,13 @@ published service DocumentSettings
a proportional line spacing is only applied below a text line and
it's always added to the paragraph spacing between two paragraphs.</p>
+ @since OOo 2.0.0
*/
[optional, property] boolean UseFormerLineSpacing;
// ------------------------------------------------------------
/** specifies if paragraph and table spacing is added at the
bottom of table cells
- @since OOo 2.0.0
-
<p>This property controls, if the spacing of the last paragraph
respectively table of a table cell is added at the bottom of this
table cells
@@ -162,14 +159,13 @@ published service DocumentSettings
the spacing of the last paragraph respectively table of a table
cell isn't added at the bottom of this table cell.</p>
+ @since OOo 2.0.0
*/
[optional, property] boolean AddParaSpacingToTableCells;
// ------------------------------------------------------------
/** specifies if the former (till OpenOffice.org 1.1) or the new
object positioning is applied.
- @since OOo 2.0.0
-
<p>This property controls how floating screen objects (Writer
fly frames and drawing objects are positioned.
If <TRUE/>, the object positioning till OpenOffice.org 1.1 is
@@ -181,6 +177,7 @@ published service DocumentSettings
its vertical position, doesn't include the lower spacing and the
line spacing of the previous paragraph.</p>
+ @since OOo 2.0.0
*/
[optional, property] boolean UseFormerObjectPositioning;
@@ -188,8 +185,6 @@ published service DocumentSettings
/** specifies if the text wrap of floating screen objects are
considered in a specified way in the positioning algorithm.
- @since OOo 2.0.0
-
<p>This property controls how floating screen objects (Writer
fly frames and drawing objects) are positioned.
If <TRUE/>, the object positioning algorithm will consider
@@ -199,6 +194,7 @@ published service DocumentSettings
If <FALSE/> (default value), the former object positioning
algorithm (known from OpenOffice.org 1.1) is applied.</p>
+ @since OOo 2.0.0
*/
[optional, property] boolean ConsiderTextWrapOnObjPos;
diff --git a/offapi/com/sun/star/text/NumberingLevel.idl b/offapi/com/sun/star/text/NumberingLevel.idl
index 987dfa53f565..46b014d9cd71 100644
--- a/offapi/com/sun/star/text/NumberingLevel.idl
+++ b/offapi/com/sun/star/text/NumberingLevel.idl
@@ -201,8 +201,6 @@ published service NumberingLevel
/** position and space mode
- @since OOo 3.0
-
<p>
Specifies the position and space mode of the numbering level.
For valid values see com::sun::star::text::PositionAndSpaceMode.
@@ -211,53 +209,55 @@ published service NumberingLevel
If it equals LABEL_ALIGNMENT, properties Adjust, LabelFollowedBy,
ListtabStopPosition, FirstLineIndent, IndentAt are used.
</p>
+
+ @since OOo 3.0
*/
[optional, property] short PositionAndSpaceMode;
/** character following the list label
- @since OOo 3.0
-
<p>
Specifies the character following the list label.
For valid values see com::sun::star::text::LabelFollow.
Only of relevance, if PositionAndSpaceMode equals LABEL_ALIGNMENT.
</p>
+
+ @since OOo 3.0
*/
[optional, property] short LabelFollowedBy;
/** list tab position
- @since OOo 3.0
-
<p>
Specifies the position of the list tab stop - only non-negative
values are allowed.
Only of relevance, if PositionAndSpaceMode equals LABEL_ALIGNMENT
and LabelFollowedBy equal LABELFOLLOW_LISTTAB
</p>
+
+ @since OOo 3.0
*/
[optional, property] long ListtabStopPosition;
/** additional line indent for the first text line
- @since OOo 3.0
-
<p>
Specifies the first line indent.
Only of relevance, if PositionAndSpaceMode equals LABEL_ALIGNMENT.
</p>
+
+ @since OOo 3.0
*/
[optional, property] long FirstLineIndent;
/** indentation of the text lines
- @since OOo 3.0
-
<p>
Specifies the indent of the text lines
Only of relevance, if PositionAndSpaceMode equals LABEL_ALIGNMENT.
</p>
+
+ @since OOo 3.0
*/
[optional, property] long IndentAt;
};
diff --git a/offapi/com/sun/star/text/ReferenceFieldPart.idl b/offapi/com/sun/star/text/ReferenceFieldPart.idl
index c58679fada90..2ac96da25ee2 100644
--- a/offapi/com/sun/star/text/ReferenceFieldPart.idl
+++ b/offapi/com/sun/star/text/ReferenceFieldPart.idl
@@ -88,8 +88,6 @@ published constants ReferenceFieldPart
/** The numbering label and depending of the reference field context numbering lables of
superior list levels of the reference are displayed.
- @since OOo 3.0
-
<p>This option is only valid, if the source of the reference is a bookmark or a set reference.</p>
<p>The contents of the list label of the paragraph, at which the bookmark respectively the
set reference starts - named "referenced item" in the following - is displayed. To unambiguous
@@ -102,23 +100,23 @@ published constants ReferenceFieldPart
be the level of the most superior level, then no list label content of superior levels greater or
equal than X are added.
If the referenced item isn't numbered, nothing is displayed.</p>
+
+ @since OOo 3.0
*/
const short NUMBER = 8;
//-------------------------------------------------------------------------
/** The numbering label of the reference is displayed.
- @since OOo 3.0
-
<p>This option is only valid, if the source of the reference is a bookmark or a set reference.</p>
<p>The contents of the list label of the paragraph, at which the bookmark respectively the
set reference starts, is displayed. If this paragraph isn't numbered, nothing is displayed.</p>
+
+ @since OOo 3.0
*/
const short NUMBER_NO_CONTEXT = 9;
//-------------------------------------------------------------------------
/** The numbering label and numbering lables of superior list levels of the reference are displayed.
- @since OOo 3.0
-
<p>This option is only valid, if the source of the reference is a bookmark or a set reference.</p>
<p>The contents of the list label of the paragraph, at which the bookmark respectively the
set reference starts - named "referenced item" in the following - is displayed and the contents
@@ -128,6 +126,8 @@ published constants ReferenceFieldPart
be the level of the most superior level, then no list label content of superior levels greater or
equal than X are added.
If the referenced item is numbered nothing is displayed.</p>
+
+ @since OOo 3.0
*/
const short NUMBER_FULL_CONTEXT = 10;
};
diff --git a/offapi/com/sun/star/text/TextPortion.idl b/offapi/com/sun/star/text/TextPortion.idl
index 10b1cc05175d..26ad5bd5ba6c 100644
--- a/offapi/com/sun/star/text/TextPortion.idl
+++ b/offapi/com/sun/star/text/TextPortion.idl
@@ -31,18 +31,10 @@
#define __com_sun_star_text_TextPortion_idl__
-#ifndef __com_sun_star_style_ParagraphProperties_idl__
-#include <com/sun/star/style/ParagraphProperties.idl>
-#endif
-
#ifndef __com_sun_star_beans_XTolerantMultiPropertySet_idl__
#include <com/sun/star/beans/XTolerantMultiPropertySet.idl>
#endif
-#ifndef __com_sun_star_style_CharacterProperties_idl__
-#include <com/sun/star/style/CharacterProperties.idl>
-#endif
-
#ifndef __com_sun_star_container_XContentEnumerationAccess_idl__
#include <com/sun/star/container/XContentEnumerationAccess.idl>
#endif
@@ -50,10 +42,20 @@
#ifndef __com_sun_star_text_TextRange_idl__
#include <com/sun/star/text/TextRange.idl>
#endif
+
#ifndef __com_sun_star_text_XTextContent_idl__
#include <com/sun/star/text/XTextContent.idl>
#endif
+#ifndef __com_sun_star_text_XTextField_idl__
+#include <com/sun/star/text/XTextField.idl>
+#endif
+
+#ifndef __com_sun_star_text_XFootnote_idl__
+#include <com/sun/star/text/XFootnote.idl>
+#endif
+
+
//=============================================================================
module com { module sun { module star { module text {
@@ -61,65 +63,107 @@ module com { module sun { module star { module text {
//=============================================================================
/** A TextPortion is a piece of text within a paragraph that does not
contain changes of its attributes inside.
- <p>It is created by an enumaration implemented in a paragraph service.
- It is used to export the content of the paragraph to an external document format.</p>
+ <p>
+ It is created by an enumeration implemented in a paragraph service.
+ It may be used to export the content of the paragraph to an external
+ document format.
+ </p>
+
+ @see com::sun::star::text::TextPortionEnumeration
+ @see com::sun::star::text::XTextPortionEnumeration
*/
published service TextPortion
{
- service com::sun::star::text::TextRange;
+ service ::com::sun::star::text::TextRange;
//-------------------------------------------------------------------------
/** contains text frames, graphic objects, embedded objects or
- shapes that are anchored at or as character.
+ shapes that are anchored at or as character.
@see com.sun.star.text.TextFrame
@see com.sun.star.text.TextGraphicObject
*/
- [optional] interface ::com::sun::star::container::XContentEnumerationAccess;
+ [optional]
+ interface ::com::sun::star::container::XContentEnumerationAccess;
//-------------------------------------------------------------------------
/** gives access to a sequence of properties.
@since OOo 2.0.0
*/
- [optional] interface ::com::sun::star::beans::XTolerantMultiPropertySet;
+ [optional]
+ interface ::com::sun::star::beans::XTolerantMultiPropertySet;
//-------------------------------------------------------------------------
/** contains the type of the text portion.
+
<p> Valid content type names are:</p>
- <UL>
- <LI><P>Text - string content</P>
- <LI><P>TextField - TextField content</P>
- <LI><P>TextContent - text content - supplied via the interface XContentEnumerationAccess</P>
- <LI><P>Footnote - a footnote or an endnote</P>
- <LI><P>ControlCharacter - a control character</P>
- <LI><P>ReferenceMark - a reference mark </P>
- <LI><P>DocumentIndexMark - a document index mark</P>
- <LI><P>Bookmark - a bookmark</P>
- <LI><P>Redline - a redline portion which is a result of the change tracking feature.</P>
- <LI><P>Ruby - a ruby attribute which is used in Asian text</P>
- <LI><P>Frame - a frame.</P>
- </UL>
- <p>The text portions for reference marks and document index marks are generated twice for
- each mark since they may include string content.</p>
+ <dl>
+ <dt>Text</dt><dd>string content</dd>
+ <dt>TextField</dt><dd>a text field</dd>
+ <dt>TextContent</dt><dd>text content - supplied via the
+ interface <type scope="com::sun::star::container">
+ XContentEnumerationAccess</type></dd>
+ <dt>ControlCharacter</dt><dd>a control character</dd>
+ <dt>Footnote</dt><dd>a footnote or an endnote</dd>
+ <dt>ReferenceMark</dt><dd>a reference mark</dd>
+ <dt>DocumentIndexMark</dt><dd>a document index mark</dd>
+ <dt>Bookmark</dt><dd>a bookmark</dd>
+ <dt>Redline</dt><dd>a redline portion which is a result
+ of the change tracking feature</dd>
+ <dt>Ruby</dt><dd>a ruby attribute which is used in Asian text</dd>
+ <dt>Frame</dt><dd>a frame</dd>
+ <dt>SoftPageBreak</dt><dd>a soft page break</dd>
+ </dl>
+ <p>For Reference marks, document index marks, etc., 2 text portions
+ will be generated, one for the start position and one for the
+ end position.</p>
*/
[readonly, property] string TextPortionType;
//-------------------------------------------------------------------------
- /** returns the control character if the text portion contains a ControlCharacter*/
+ /** contains the control character of a text portion of type
+ ControlCharacter.
+ */
[readonly, property] short ControlCharacter;
//-------------------------------------------------------------------------
- /** contains the bookmark if the portion is of the type */
- [optional, property] com::sun::star::text::XTextContent Bookmark;
+ /** contains the bookmark of a text portion of type Bookmark. */
+ [optional, readonly, property]
+ ::com::sun::star::text::XTextContent Bookmark;
+
+ //-------------------------------------------------------------------------
+ /** contains the document index mark of a text portion of type
+ DocumentIndexMark. */
+ [optional, readonly, property]
+ ::com::sun::star::text::XTextContent DocumentIndexMark;
+
+ //-------------------------------------------------------------------------
+ /** contains the bookmark of a text portion of type ReferenceMark. */
+ [optional, readonly, property]
+ ::com::sun::star::text::XTextContent ReferenceMark;
+
+ //-------------------------------------------------------------------------
+ /** contains the footnote of a text portion of type Footnote. */
+ [optional, readonly, property]
+ ::com::sun::star::text::XFootnote Footnote;
+
+ //-------------------------------------------------------------------------
+ /** contains the text field of a text portion of type TextField. */
+ [optional, readonly, property]
+ ::com::sun::star::text::XTextField TextField;
//-------------------------------------------------------------------------
- /** determines whether the portion is a point only.*/
- [optional, property] boolean IsCollapsed;
+ /** contains whether the portion is a point only. */
+ [optional, readonly, property] boolean IsCollapsed;
//-------------------------------------------------------------------------
- /** determines whether the portion is a start portion if two portions are needed to include an
- object (i.e. DocmentIndexMark)*/
- [optional, property] boolean IsStart;
+ /** contains whether the portion is the start of the portion.
+
+ <p>This is used for portions which are represented by
+ 2 TextPortion objects (e.g., DocmentIndexMark).</p>
+ */
+ [optional, readonly, property] boolean IsStart;
+
};
//=============================================================================
diff --git a/offapi/com/sun/star/text/ViewSettings.idl b/offapi/com/sun/star/text/ViewSettings.idl
index f9e356f64732..88d87ccb4798 100644
--- a/offapi/com/sun/star/text/ViewSettings.idl
+++ b/offapi/com/sun/star/text/ViewSettings.idl
@@ -342,14 +342,18 @@ published service ViewSettings
[optional, property] boolean ShowNonprintingCharacters;
//-------------------------------------------------------------------------
/** metric unit of the horizontal ruler
+
+ <p>Uses values <type scope="com::sun::star::awt">FieldUnit</type></p>
+
@since OOo 3.1.0
- <p>Uses values from com::sun::star::awt::FieldUnit</p>
*/
[optional, property] long HorizontalRulerMetric;
//-------------------------------------------------------------------------
/** metric unit of the vertical ruler
+
+ <p>Uses values from <type scope="com::sun::star::awt">FieldUnit</type></p>
+
@since OOo 3.1.0
- <p>Uses values from com::sun::star::awt::FieldUnit</p>
*/
[optional, property] long VerticalRulerMetric;
};
diff --git a/offapi/com/sun/star/text/XFormField.idl b/offapi/com/sun/star/text/XFormField.idl
index 5215e381bcdb..f1f2d1bab9b9 100644
--- a/offapi/com/sun/star/text/XFormField.idl
+++ b/offapi/com/sun/star/text/XFormField.idl
@@ -7,6 +7,8 @@
module com { module sun { module star { module text {
+/** @deprecated
+ */
interface XFormField: com::sun::star::uno::XInterface
{
short getType();
diff --git a/offapi/com/sun/star/text/XMultiTextMarkup.idl b/offapi/com/sun/star/text/XMultiTextMarkup.idl
index 661038152bb4..f380797d0eb8 100644
--- a/offapi/com/sun/star/text/XMultiTextMarkup.idl
+++ b/offapi/com/sun/star/text/XMultiTextMarkup.idl
@@ -68,8 +68,8 @@ interface XMultiTextMarkup
@param aMarkups
a sequence of single text markups.
- @see som::sun::star:text::XTextMarkup
- @see som::sun::star:text::TextMarkupType
+ @see com::sun::star::text::XTextMarkup
+ @see com::sun::star::text::TextMarkupType
*/
void commitMultiTextMarkup(
diff --git a/offapi/com/sun/star/text/XTextTable.idl b/offapi/com/sun/star/text/XTextTable.idl
index 88cffcaa60f7..a2161a2a0cbc 100644
--- a/offapi/com/sun/star/text/XTextTable.idl
+++ b/offapi/com/sun/star/text/XTextTable.idl
@@ -59,7 +59,7 @@
/** manages a text table.
- @see som::sun::star:text::TextTable
+ @see com::sun::star::text::TextTable
@see com::sun::star::text::Cell
*/
published interface XTextTable: com::sun::star::text::XTextContent
diff --git a/offapi/com/sun/star/text/fieldmaster/Bibliography.idl b/offapi/com/sun/star/text/fieldmaster/Bibliography.idl
index a43e9e16e7c6..9fc3dbdf0e43 100644
--- a/offapi/com/sun/star/text/fieldmaster/Bibliography.idl
+++ b/offapi/com/sun/star/text/fieldmaster/Bibliography.idl
@@ -37,7 +37,7 @@
//=============================================================================
-module com { module sun { module star { module text { module FieldMaster {
+module com { module sun { module star { module text { module fieldmaster {
//=============================================================================
/** specifies service of a Bibliography field master.
diff --git a/offapi/com/sun/star/text/fieldmaster/DDE.idl b/offapi/com/sun/star/text/fieldmaster/DDE.idl
index 82049858eea7..1f1da82de47a 100644
--- a/offapi/com/sun/star/text/fieldmaster/DDE.idl
+++ b/offapi/com/sun/star/text/fieldmaster/DDE.idl
@@ -36,7 +36,7 @@
//=============================================================================
-module com { module sun { module star { module text { module FieldMaster {
+module com { module sun { module star { module text { module fieldmaster {
//=============================================================================
/** specifies service of a DDE field master.
diff --git a/offapi/com/sun/star/text/fieldmaster/Database.idl b/offapi/com/sun/star/text/fieldmaster/Database.idl
index 95ce53e6fe42..d8554d7b4d69 100644
--- a/offapi/com/sun/star/text/fieldmaster/Database.idl
+++ b/offapi/com/sun/star/text/fieldmaster/Database.idl
@@ -36,7 +36,7 @@
//=============================================================================
-module com { module sun { module star { module text { module FieldMaster {
+module com { module sun { module star { module text { module fieldmaster {
//=============================================================================
/** specifies service of a Database field master.
@@ -85,7 +85,7 @@ published service Database
//------------------------------------------------------------------------
/** contains the DataColumnName but it enables the fieldmaster and its
depending fields to work without setting DataSourceName, DataTableName and CommandType
- @since OOo 2.x
+ @since OOo 2.3
*/
[optional, property] string Name;
diff --git a/offapi/com/sun/star/text/fieldmaster/SetExpression.idl b/offapi/com/sun/star/text/fieldmaster/SetExpression.idl
index 1407f29906c4..1e5f1e783a6a 100644
--- a/offapi/com/sun/star/text/fieldmaster/SetExpression.idl
+++ b/offapi/com/sun/star/text/fieldmaster/SetExpression.idl
@@ -36,7 +36,7 @@
//=============================================================================
-module com { module sun { module star { module text { module FieldMaster {
+module com { module sun { module star { module text { module fieldmaster {
//=============================================================================
/** Specifies the service of a set expression field master.
diff --git a/offapi/com/sun/star/text/fieldmaster/User.idl b/offapi/com/sun/star/text/fieldmaster/User.idl
index 305682b75156..c973c8ba8ffa 100644
--- a/offapi/com/sun/star/text/fieldmaster/User.idl
+++ b/offapi/com/sun/star/text/fieldmaster/User.idl
@@ -36,7 +36,7 @@
//=============================================================================
-module com { module sun { module star { module text { module FieldMaster {
+module com { module sun { module star { module text { module fieldmaster {
//=============================================================================
/** Specifies the service of a user field master.
diff --git a/offapi/com/sun/star/ui/dialogs/FilePicker.idl b/offapi/com/sun/star/ui/dialogs/FilePicker.idl
index b2f4d8ed258c..c15ab0287631 100644
--- a/offapi/com/sun/star/ui/dialogs/FilePicker.idl
+++ b/offapi/com/sun/star/ui/dialogs/FilePicker.idl
@@ -60,6 +60,11 @@ module com { module sun { module star { module ui { module dialogs {
//=============================================================================
/** A FilePicker.
+ It is <strong>NOT</strong> recommended to cache a reference to a file
+ picker instance. Due to restrictions by the underlying system there can
+ be specific limitations possible. To overcome these problems it'
+ s recommended to create a new instance on demand.
+
@see XFilePicker
*/
diff --git a/offapi/com/sun/star/util/MeasureUnit.idl b/offapi/com/sun/star/util/MeasureUnit.idl
index 6d7915a5774c..6cb8d3e7c883 100644
--- a/offapi/com/sun/star/util/MeasureUnit.idl
+++ b/offapi/com/sun/star/util/MeasureUnit.idl
@@ -106,3 +106,4 @@ published constants MeasureUnit
}; }; }; };
#endif
+
diff --git a/offapi/com/sun/star/xml/sax/XFastShapeContextHandler.idl b/offapi/com/sun/star/xml/sax/XFastShapeContextHandler.idl
index 3def460ed435..c125e55ddd2e 100644
--- a/offapi/com/sun/star/xml/sax/XFastShapeContextHandler.idl
+++ b/offapi/com/sun/star/xml/sax/XFastShapeContextHandler.idl
@@ -32,7 +32,7 @@
#include <com/sun/star/xml/sax/XFastContextHandler.idl>
#include <com/sun/star/drawing/XShape.idl>
-#include <com/sun/star/drawing/XShapes.idl>
+#include <com/sun/star/drawing/XDrawPage.idl>
#include <com/sun/star/frame/XModel.idl>
#include <com/sun/star/io/XInputStream.idl>
@@ -50,7 +50,7 @@ module com { module sun { module star { module xml { module sax {
interface XFastShapeContextHandler: com::sun::star::xml::sax::XFastContextHandler
{
[attribute, readonly] com::sun::star::drawing::XShape Shape;
- [attribute] com::sun::star::drawing::XShapes Shapes;
+ [attribute] com::sun::star::drawing::XDrawPage DrawPage;
[attribute] com::sun::star::frame::XModel Model;
[attribute] com::sun::star::io::XInputStream InputStream;
[attribute] string RelationFragmentPath;
diff --git a/offapi/com/sun/star/xml/sax/XFastTokenHandler.idl b/offapi/com/sun/star/xml/sax/XFastTokenHandler.idl
index 691474f5d6e3..71ebdd4abd25 100644
--- a/offapi/com/sun/star/xml/sax/XFastTokenHandler.idl
+++ b/offapi/com/sun/star/xml/sax/XFastTokenHandler.idl
@@ -57,7 +57,7 @@ interface XFastTokenHandler: com::sun::star::uno::XInterface
/** returns a integer token for the given string identifier.
@returns
- a unique integer token for the given String or <const>FastToken::DONTKNOW</const
+ a unique integer token for the given String or <const>FastToken::DONTKNOW</const>
if the identifier is not known to this instance.
*/
long getToken( [in] string Identifier );
diff --git a/offapi/prj/build.lst b/offapi/prj/build.lst
index 094ca718a124..ede720d44540 100644
--- a/offapi/prj/build.lst
+++ b/offapi/prj/build.lst
@@ -1,4 +1,4 @@
-oa offapi : udkapi solenv NULL
+oa offapi : udkapi idlc solenv NULL
oa offapi usr1 - all oa_mkout NULL
oa offapi\com\sun\star\script nmake - all oa_script oa_embed NULL
oa offapi\com\sun\star\script\browse nmake - all oa_sfbrowse NULL
diff --git a/offapi/type_reference/typelibrary_history.txt b/offapi/type_reference/typelibrary_history.txt
index 830cb806f03d..70f0e1d0cb35 100644
--- a/offapi/type_reference/typelibrary_history.txt
+++ b/offapi/type_reference/typelibrary_history.txt
@@ -135,3 +135,16 @@
04/12/08 (JSC): TaskID=i96902
update reference rdb with the released version from OO.org 3.0 (ooo300m9)
+
+04/17/09 (tl, JSC): TaskID=i96846
+ changed old and not longer used properties in css.linguistic2.LinguProperties
+ to maybevoid and deprecate. They should be removed in a future version. The
+ implementation will never return them.
+
+25/02/09 (MST, JSC): TaskID=i96209
+ rename module css.text.FieldMaster to css.text.fieldmaster.
+ the implementation handles both variants.
+
+15/05/09 (MST, JSC): TaskID=i101965
+ fix read-only status of properties of css.text.TextPortion
+
diff --git a/offapi/type_reference/types.rdb b/offapi/type_reference/types.rdb
index b75cd71a7290..f9a30cdbbd53 100644
--- a/offapi/type_reference/types.rdb
+++ b/offapi/type_reference/types.rdb
Binary files differ