diff options
| author | Jens-Heiner Rechtien <hr@openoffice.org> | 2010-01-28 18:49:22 +0000 |
|---|---|---|
| committer | Jens-Heiner Rechtien <hr@openoffice.org> | 2010-01-28 18:49:22 +0000 |
| commit | 4728462953156cb2b4c0fa0d8bbbb3ab0b11e762 (patch) | |
| tree | 64db1d3663261b3940b5aaa748943d690bc410d8 /offapi/com | |
| parent | 751e88e346f2160cdd27791e427f73b9fa89c82a (diff) | |
| parent | eb0ab12b525227b11e43f5b2d685b4bb77373fa5 (diff) | |
koheidatapilot03: merge with DEV300_m56
Diffstat (limited to 'offapi/com')
70 files changed, 1700 insertions, 437 deletions
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/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/awt/tree/XTreeDataModelListener.idl b/offapi/com/sun/star/awt/tree/XTreeDataModelListener.idl index 81e98b301954..8ea308f69a6f 100644 --- a/offapi/com/sun/star/awt/tree/XTreeDataModelListener.idl +++ b/offapi/com/sun/star/awt/tree/XTreeDataModelListener.idl @@ -62,7 +62,7 @@ interface XTreeDataModelListener: com::sun::star::lang::XEventListener Example: the name of a file has changed, but it is in the same location in the file system. To indicate the root has changed, <member>TreeDataModelEvent::Nodes</member> will contain - the root node and and <member>TreeDataModelEvent::ParentNode</member will be empty. + the root node and <member>TreeDataModelEvent::ParentNode</member> will be empty. */ void treeNodesChanged( [in] TreeDataModelEvent Event ); 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/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/deployment/XPackage.idl b/offapi/com/sun/star/deployment/XPackage.idl index 4847f09090a2..36799875eee1 100644 --- a/offapi/com/sun/star/deployment/XPackage.idl +++ b/offapi/com/sun/star/deployment/XPackage.idl @@ -6,9 +6,6 @@ * * OpenOffice.org - a multi-platform office productivity suite * - * $RCSfile: XPackage.idl,v $ - * $Revision: 1.14 $ - * * This file is part of OpenOffice.org. * * OpenOffice.org is free software: you can redistribute it and/or modify @@ -102,6 +99,25 @@ interface XPackage com::sun::star::ucb::CommandFailedException, com::sun::star::ucb::CommandAbortedException); + /** checks if the dependencies for this package are still satisfied + + After updateing the OpenOffice.org, some dependencies for packages might + no longer be satisfied. + + @since OOo 3.2.0 + + @param xCmdEnv + command environment for error handling and other interaction. + + @return + true - all dependencies are satisfied + false - at least one dependency failed. + */ + boolean checkDependencies( + [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv ) + raises (DeploymentException, + com::sun::star::ucb::CommandFailedException); + /** determines whether the package is currently is registered, i.e. whether it is active. diff --git a/offapi/com/sun/star/deployment/ui/UpdateRequiredDialog.idl b/offapi/com/sun/star/deployment/ui/UpdateRequiredDialog.idl new file mode 100644 index 000000000000..761070eb7443 --- /dev/null +++ b/offapi/com/sun/star/deployment/ui/UpdateRequiredDialog.idl @@ -0,0 +1,54 @@ +/************************************************************************* + * + * 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. + * + ************************************************************************/ + +#if ! defined INCLUDED_com_sun_star_deployment_ui_UpdateRequiredDialog_idl +#define INCLUDED_com_sun_star_deployment_ui_UpdateRequiredDialog_idl + +#include <com/sun/star/ui/dialogs/XExecutableDialog.idl> +#include <com/sun/star/awt/XWindow.idl> + + +module com { module sun { module star { module deployment { module ui { + +/** The <type>UpdateRequiredDialog</type> is used to show a list of extensions not compatible with this office version. + + @since OOo 3.2.0 +*/ +service UpdateRequiredDialog : com::sun::star::ui::dialogs::XExecutableDialog +{ + /** Create a GUI using the specific parent window and focus on the + given context. + + @param xParent + parent window + */ + create(); +}; + +}; }; }; }; }; + +#endif diff --git a/offapi/com/sun/star/deployment/ui/makefile.mk b/offapi/com/sun/star/deployment/ui/makefile.mk index d91d20001bb5..f733c762a80c 100644 --- a/offapi/com/sun/star/deployment/ui/makefile.mk +++ b/offapi/com/sun/star/deployment/ui/makefile.mk @@ -39,8 +39,9 @@ PACKAGE = com$/sun$/star$/deployment$/ui .INCLUDE : $(PRJ)$/util$/makefile.pmk IDLFILES = \ - PackageManagerDialog.idl \ - LicenseDialog.idl + PackageManagerDialog.idl \ + LicenseDialog.idl \ + UpdateRequiredDialog.idl .INCLUDE : target.mk .INCLUDE : $(PRJ)$/util$/target.pmk 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/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/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/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/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/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/FormulaParser.idl b/offapi/com/sun/star/sheet/FormulaParser.idl index ba38acf791b0..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,10 +62,6 @@ service FormulaParser // ------------------------------------------------------------------------ - [property] com::sun::star::table::CellAddress ReferencePosition; - - // ------------------------------------------------------------------------ - /** specifies whether to use English parser and formatter. <p>Note: When changing this, an already existing <member>OpCodeMap 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/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/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 f6ca0810604e..468e96b9860b 100644 --- a/offapi/com/sun/star/sheet/makefile.mk +++ b/offapi/com/sun/star/sheet/makefile.mk @@ -137,7 +137,9 @@ IDLFILES=\ FillDirection.idl\ FillMode.idl\ FilterConnection.idl\ + FilterFormulaParser.idl\ FilterOperator.idl\ + FilterOperator2.idl\ FormulaLanguage.idl\ FormulaMapGroup.idl\ FormulaMapGroupSpecialOffset.idl\ @@ -219,6 +221,7 @@ IDLFILES=\ TableConditionalEntryEnumeration.idl\ TableConditionalFormat.idl\ TableFilterField.idl\ + TableFilterField2.idl\ TableOperationMode.idl\ TablePageBreakData.idl\ TablePageStyle.idl\ @@ -274,6 +277,7 @@ IDLFILES=\ XExternalSheetCache.idl\ XExternalSheetName.idl\ XFillAcrossSheet.idl\ + XFilterFormulaParser.idl\ XFormulaOpCodeMapper.idl\ XFormulaParser.idl\ XFormulaQuery.idl\ @@ -315,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/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/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; |