diff options
Diffstat (limited to 'offapi/com/sun')
132 files changed, 2019 insertions, 191 deletions
diff --git a/offapi/com/sun/star/accessibility/AccessibleRelation.idl b/offapi/com/sun/star/accessibility/AccessibleRelation.idl index 8eeabb8e9..61126087d 100644 --- a/offapi/com/sun/star/accessibility/AccessibleRelation.idl +++ b/offapi/com/sun/star/accessibility/AccessibleRelation.idl @@ -50,7 +50,7 @@ published struct AccessibleRelation the whole relation is regarded as invalid. The content of the targetSet is then undefined.</p> - @see AccessibleRelationType. + @see AccessibleRelationType */ short RelationType; diff --git a/offapi/com/sun/star/awt/ItemListEvent.idl b/offapi/com/sun/star/awt/ItemListEvent.idl new file mode 100644 index 000000000..f9d2658bd --- /dev/null +++ b/offapi/com/sun/star/awt/ItemListEvent.idl @@ -0,0 +1,76 @@ +/************************************************************************* + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __offapi_com_sun_star_awt_ListItemEvent_idl__ +#define __offapi_com_sun_star_awt_ListItemEvent_idl__ + +#include <com/sun/star/lang/EventObject.idl> +#include <com/sun/star/beans/Optional.idl> + +//================================================================================================================== + +module com { module sun { module star { module awt { + +//================================================================================================================== + +/** is the event broadcasted by a <type>XListItems</type> implementation for changes + in its item list. + */ +struct ItemListEvent : ::com::sun::star::lang::EventObject +{ + /** specifies the position of the item which is affected by the event + + <p>In case the event is not related to a single item, but to the complete list, the value of this + member is undefined.</p> + */ + long ItemPosition; + + /** the text of the item. + + <p>If the event being notified did not touch the text of an item, this member is empty. For instance, upon + invocation of <member>XItemList::setItemImage</member>, only <code>ItemImageURL</code> will be set, and + <code>ItemText</code> will be empty.</p> + */ + ::com::sun::star::beans::Optional< string > + ItemText; + + /** the URL of the image of the item + + <p>If the event being notified did not touch the image of an item, this member is empty. For instance, upon + invocation of <member>XItemList::setItemText</member>, only <code>ItemText</code> will be set, and + <code>ItemImageURL</code> will be empty.</p> + */ + ::com::sun::star::beans::Optional< string > + ItemImageURL; +}; + +//================================================================================================================== + +}; }; }; }; + +//================================================================================================================== + +#endif diff --git a/offapi/com/sun/star/awt/UnoControlListBoxModel.idl b/offapi/com/sun/star/awt/UnoControlListBoxModel.idl index 8d94cdab4..d875315bf 100644 --- a/offapi/com/sun/star/awt/UnoControlListBoxModel.idl +++ b/offapi/com/sun/star/awt/UnoControlListBoxModel.idl @@ -38,6 +38,8 @@ #ifndef __com_sun_star_util_Color_idl__ #include <com/sun/star/util/Color.idl> #endif + +#include <com/sun/star/awt/XItemList.idl> //============================================================================= @@ -208,6 +210,11 @@ published service UnoControlListBoxModel this is possible.</p> */ [optional, property] short MouseWheelBehavior; + + /** allows mmanipulating the list of items in the list box more fine-grained than the + <member>StringItemList</member> property. + */ + [optional] interface XItemList; }; //============================================================================= diff --git a/offapi/com/sun/star/awt/UnoControlSimpleAnimation.idl b/offapi/com/sun/star/awt/UnoControlSimpleAnimation.idl index 8bd21dee8..6c65cd8a4 100644 --- a/offapi/com/sun/star/awt/UnoControlSimpleAnimation.idl +++ b/offapi/com/sun/star/awt/UnoControlSimpleAnimation.idl @@ -45,9 +45,11 @@ /** specifies a simple animation control. <p>The model of an <type>UnoControlSimpleAnimation</type> control must support - the <type>UnoControlSimpleAnimationModel</type> service. + the <type>UnoControlSimpleAnimationModel</type> service.</p> + + @since OOo 2.2 */ -service UnoControlSimpleAnimation +published service UnoControlSimpleAnimation { service com::sun::star::awt::UnoControl; diff --git a/offapi/com/sun/star/awt/UnoControlSimpleAnimationModel.idl b/offapi/com/sun/star/awt/UnoControlSimpleAnimationModel.idl index 4a00c749e..902dffb98 100644 --- a/offapi/com/sun/star/awt/UnoControlSimpleAnimationModel.idl +++ b/offapi/com/sun/star/awt/UnoControlSimpleAnimationModel.idl @@ -45,9 +45,10 @@ <p> </p> @see UnoControlScrollBarModel + @since OOo 2.2 */ -service UnoControlSimpleAnimationModel +published service UnoControlSimpleAnimationModel { service com::sun::star::awt::UnoControlModel; diff --git a/offapi/com/sun/star/awt/UnoControlThrobber.idl b/offapi/com/sun/star/awt/UnoControlThrobber.idl index f1328e4ea..9d0384ef7 100644 --- a/offapi/com/sun/star/awt/UnoControlThrobber.idl +++ b/offapi/com/sun/star/awt/UnoControlThrobber.idl @@ -45,9 +45,11 @@ /** specifies a simple animation control. <p>The model of an <type>UnoControlThrobber</type> control must support - the <type>UnoControlThrobberModel</type> service. + the <type>UnoControlThrobberModel</type> service.</p> + + @since OOo 2.2 */ -service UnoControlThrobber +published service UnoControlThrobber { service com::sun::star::awt::UnoControl; diff --git a/offapi/com/sun/star/awt/UnoControlThrobberModel.idl b/offapi/com/sun/star/awt/UnoControlThrobberModel.idl index 6ad51a0dc..d82c65666 100644 --- a/offapi/com/sun/star/awt/UnoControlThrobberModel.idl +++ b/offapi/com/sun/star/awt/UnoControlThrobberModel.idl @@ -45,9 +45,10 @@ <p> </p> @see UnoControlScrollBarModel + @since OOo 2.2 */ -service UnoControlThrobberModel +published service UnoControlThrobberModel { service com::sun::star::awt::UnoControlModel; }; diff --git a/offapi/com/sun/star/awt/XItemList.idl b/offapi/com/sun/star/awt/XItemList.idl new file mode 100644 index 000000000..6419ea94d --- /dev/null +++ b/offapi/com/sun/star/awt/XItemList.idl @@ -0,0 +1,286 @@ +/************************************************************************* + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __offapi_com_sun_star_awt_XItemList_idl__ +#define __offapi_com_sun_star_awt_XItemList_idl__ + +#include <com/sun/star/lang/IndexOutOfBoundsException.idl> +#include <com/sun/star/beans/Pair.idl> + +//================================================================================================================== + +module com { module sun { module star { module awt { + +interface XItemListListener; + +//================================================================================================================== + +/** provides convenient access to the list of items in a list box + */ +interface XItemList +{ + /** is the number of items in the list + */ + [attribute, readonly] long ItemCount; + + /** inserts a new item into the list + + @param Position + the position at which the item should be inserted. Must be greater or equal to 0, and + lesser than or equal to <member>ItemCount</member>. + + @param ItemText + the text of the item to be inserted. + + @param ItemImageURL + the URL of the image to display for the item + + @throws ::com::sun::star::lang::IndexOutOfBoundsException + if <code>Position</code> is invalid. + */ + void insertItem( + [in] long Position, + [in] string ItemText, + [in] string ItemImageURL + ) + raises ( ::com::sun::star::lang::IndexOutOfBoundsException ); + + /** inserts an item which has only a text, but no image + + @param Position + the position at which the item should be inserted. Must be greater or equal to 0, and + lesser than or equal to <member>ItemCount</member>. + + @param ItemText + the text of the item to be inserted. + + @throws ::com::sun::star::lang::IndexOutOfBoundsException + if <code>Position</code> is invalid. + */ + void insertItemText( + [in] long Position, + [in] string ItemText + ) + raises ( ::com::sun::star::lang::IndexOutOfBoundsException ); + + /** inserts an item which has only an image, but no text + + @param Position + the position at which the item should be inserted. Must be greater or equal to 0, and + lesser than or equal to <member>ItemCount</member>. + + @param ItemImageURL + the URL of the image to display for the item + + @throws ::com::sun::star::lang::IndexOutOfBoundsException + if <code>Position</code> is invalid. + */ + void insertItemImage( + [in] long Position, + [in] string ItemImageURL + ) + raises ( ::com::sun::star::lang::IndexOutOfBoundsException ); + + /** removes an item from the list + + @param Position + the position of the item which should be removed. Must be greater or equal to 0, and + lesser than <member>ItemCount</member>. + + @throws ::com::sun::star::lang::IndexOutOfBoundsException + if <code>Position</code> is invalid. + */ + void removeItem( + [in] long Position + ) + raises ( ::com::sun::star::lang::IndexOutOfBoundsException ); + + /** removes all items from the list + */ + void removeAllItems(); + + /** sets a new text for an existing item + + @param Position + the position of the item whose text is to be changed. Must be greater or equal to 0, and + lesser than <member>ItemCount</member>. + + @param ItemText + the new text of the item + + @throws ::com::sun::star::lang::IndexOutOfBoundsException + if <code>Position</code> is invalid. + */ + void setItemText( + [in] long Position, + [in] string ItemText + ) + raises ( ::com::sun::star::lang::IndexOutOfBoundsException ); + + /** sets a new image for an existing item + + @param Position + the position of the item whose image is to be changed. Must be greater or equal to 0, and + lesser than <member>ItemCount</member>. + + @param ItemImageURL + the new URL of the image to display for the item + + @throws ::com::sun::star::lang::IndexOutOfBoundsException + if <code>Position</code> is invalid. + */ + void setItemImage( + [in] long Position, + [in] string ItemImageURL + ) + raises ( ::com::sun::star::lang::IndexOutOfBoundsException ); + + /** sets both a new position and text for an existing item + + @param Position + the position of the item whose text and image is to be changed. Must be greater or equal to 0, and + lesser than <member>ItemCount</member>. + + @param ItemText + the new text of the item + + @param ItemImageURL + the new URL of the image to display for the item + + @throws ::com::sun::star::lang::IndexOutOfBoundsException + if <code>Position</code> is invalid. + */ + void setItemTextAndImage( + [in] long Position, + [in] string ItemText, + [in] string ItemImageURL + ) + raises ( ::com::sun::star::lang::IndexOutOfBoundsException ); + + /** associates an implementation dependend value with the given list item. + + <p>You can use this to store data for an item which does not interfere with the displayed + text and image, but can be used by the client of the list box for an arbitrary purpose.</p> + + @param Position + the position of the item whose data value should be set. Must be greater or equal to 0, and + lesser than <member>ItemCount</member>. + + @param ItemData + the data to associate with the list item + + @throws ::com::sun::star::lang::IndexOutOfBoundsException + if <code>Position</code> is invalid. + + @see getItemData + */ + void setItemData( + [in] long Position, + [in] any ItemData + ) + raises ( ::com::sun::star::lang::IndexOutOfBoundsException ); + + /** retrieves the text of an existing item + + @param Position + the position of the item whose text should be retrieved. Must be greater or equal to 0, and + lesser than <member>ItemCount</member>. + + @throws ::com::sun::star::lang::IndexOutOfBoundsException + if <code>Position</code> is invalid. + */ + string getItemText( + [in] long Position + ) + raises ( ::com::sun::star::lang::IndexOutOfBoundsException ); + + /** retrieves the URL of the image of an existing item + + @param Position + the position of the item whose image should be retrieved. Must be greater or equal to 0, and + lesser than <member>ItemCount</member>. + + @throws ::com::sun::star::lang::IndexOutOfBoundsException + if <code>Position</code> is invalid. + */ + string getItemImage( + [in] long Position + ) + raises ( ::com::sun::star::lang::IndexOutOfBoundsException ); + + /** retrieves both the text and the image URL of an existing item + + @param Position + the position of the item whose text and image should be retrieved. Must be greater or equal to 0, and + lesser than <member>ItemCount</member>. + + @throws ::com::sun::star::lang::IndexOutOfBoundsException + if <code>Position</code> is invalid. + */ + ::com::sun::star::beans::Pair< string, string > + getItemTextAndImage( + [in] long Position + ) + raises ( ::com::sun::star::lang::IndexOutOfBoundsException ); + + /** retrieves the implementation dependend value associated with the given list item. + @see setItemData + + @param Position + the position of the item whose data value should be retrieved. Must be greater or equal to 0, and + lesser than <member>ItemCount</member>. + + @throws ::com::sun::star::lang::IndexOutOfBoundsException + if <code>Position</code> is invalid. + + @see setItemData + */ + any getItemData( + [in] long Position + ) + raises ( ::com::sun::star::lang::IndexOutOfBoundsException ); + + /** retrieves the texts and images of all items in the list + */ + sequence< ::com::sun::star::beans::Pair< string, string > > + getAllItems(); + + /** registers a listener which is notified about changes in the item list. + */ + void addItemListListener( [in] XItemListListener Listener ); + + /** revokes a listener which is notified about changes in the item list. + */ + void removeItemListListener( [in] XItemListListener Listener ); +}; + +//================================================================================================================== + +}; }; }; }; + +//================================================================================================================== + +#endif diff --git a/offapi/com/sun/star/awt/XItemListListener.idl b/offapi/com/sun/star/awt/XItemListListener.idl new file mode 100644 index 000000000..d41d8b104 --- /dev/null +++ b/offapi/com/sun/star/awt/XItemListListener.idl @@ -0,0 +1,85 @@ +/************************************************************************* + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __offapi_com_sun_star_awt_XItemListListener_idl__ +#define __offapi_com_sun_star_awt_XItemListListener_idl__ + +#include <com/sun/star/lang/XEventListener.idl> +#include <com/sun/star/awt/ItemListEvent.idl> + +//================================================================================================================== + +module com { module sun { module star { module awt { + +//================================================================================================================== + +/** describes a listener for changes in a item list + @see XListItems + */ +interface XItemListListener : ::com::sun::star::lang::XEventListener +{ + /** is called when an item is inserted into the list + */ + void listItemInserted( + [in] ItemListEvent Event + ); + + /** is called when an item is removed from the list + */ + void listItemRemoved( + [in] ItemListEvent Event + ); + + /** is called when an item in the list is modified, i.e. its text or image changed + */ + void listItemModified( + [in] ItemListEvent Event + ); + /** is called when the list has been completely cleared, i.e. after an invocation of + <member>XItemList::removeAllItems</member> + */ + void allItemsRemoved( + [in] ::com::sun::star::lang::EventObject Event + ); + + /** is called when the changes to the item list which occured are too complex to be notified + in single events. + + <p>Consumers of this event should discard their cached information about the current item list, + and completely refresh it from the <type>XItemList</type>'s current state.</p> + */ + void itemListChanged( + [in] ::com::sun::star::lang::EventObject Event + ); +}; + +//================================================================================================================== + +}; }; }; }; + +//================================================================================================================== + +#endif diff --git a/offapi/com/sun/star/awt/XSimpleAnimation.idl b/offapi/com/sun/star/awt/XSimpleAnimation.idl index ee1dfe21d..306d7d353 100644 --- a/offapi/com/sun/star/awt/XSimpleAnimation.idl +++ b/offapi/com/sun/star/awt/XSimpleAnimation.idl @@ -43,7 +43,7 @@ /** Controls the animation control. */ -interface XSimpleAnimation: com::sun::star::uno::XInterface +published interface XSimpleAnimation: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- diff --git a/offapi/com/sun/star/awt/XThrobber.idl b/offapi/com/sun/star/awt/XThrobber.idl index 26c66a89b..5d421a36d 100644 --- a/offapi/com/sun/star/awt/XThrobber.idl +++ b/offapi/com/sun/star/awt/XThrobber.idl @@ -43,7 +43,7 @@ /** Controls the animation control. */ -interface XThrobber: com::sun::star::uno::XInterface +published interface XThrobber: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- diff --git a/offapi/com/sun/star/awt/makefile.mk b/offapi/com/sun/star/awt/makefile.mk index 1e2350a3a..55734fd75 100644 --- a/offapi/com/sun/star/awt/makefile.mk +++ b/offapi/com/sun/star/awt/makefile.mk @@ -328,7 +328,10 @@ IDLFILES=\ MenuLogo.idl \ XMenuExtended2.idl \ XMenuBarExtended.idl \ - XPopupMenuExtended.idl + XPopupMenuExtended.idl \ + XItemList.idl \ + XItemListListener.idl \ + ItemListEvent.idl # ------------------------------------------------------------------ diff --git a/offapi/com/sun/star/awt/tree/XTreeControl.idl b/offapi/com/sun/star/awt/tree/XTreeControl.idl index c4eed8e3f..dafdedc1a 100644 --- a/offapi/com/sun/star/awt/tree/XTreeControl.idl +++ b/offapi/com/sun/star/awt/tree/XTreeControl.idl @@ -219,6 +219,17 @@ interface XTreeControl */ XTreeNode getClosestNodeForLocation( [in] long x, [in] long y ); + /** returns the rectangle occupied by the visual representation of the given node + + @param Node + the node whose geometry should be obtained + @throws ::com::sun::star::lang::IllegalArgumentException + if the given node is <NULL/>, or does not belong to the tree's data model + */ + ::com::sun::star::awt::Rectangle + getNodeRect( [in] XTreeNode Node ) + raises( ::com::sun::star::lang::IllegalArgumentException ); + // ------------ // tree editing // ------------ diff --git a/offapi/com/sun/star/chart/ChartDocument.idl b/offapi/com/sun/star/chart/ChartDocument.idl index 37af66701..a45ebeb30 100644 --- a/offapi/com/sun/star/chart/ChartDocument.idl +++ b/offapi/com/sun/star/chart/ChartDocument.idl @@ -39,9 +39,8 @@ #include <com/sun/star/xml/UserDefinedAttributeSupplier.idl> #endif -// #ifndef com_sun_star_chart2_data_XDataReceiver_idl -// #include <com/sun/star/chart2/data/XDataReceiver.idl> -// #endif +#include <com/sun/star/drawing/XDrawPageSupplier.idl> + //============================================================================= @@ -73,12 +72,7 @@ published service ChartDocument interface ::com::sun::star::chart::XChartDocument; interface ::com::sun::star::beans::XPropertySet; - /** If this interface is implemented, it is possible to connect - data to a chart via the improved data connection method using - an <type scope="com::sun::star::chart2::data">XDataProvider</type>. - */ - // BM: #i32138# XDataReceiver is not yet published -// [optional] interface ::com::sun::star::chart2::data::XDataReceiver; + [optional] interface ::com::sun::star::drawing::XDrawPageSupplier; //------------------------------------------------------------------------- diff --git a/offapi/com/sun/star/chart/Diagram.idl b/offapi/com/sun/star/chart/Diagram.idl index 2afadb436..2074285ed 100644 --- a/offapi/com/sun/star/chart/Diagram.idl +++ b/offapi/com/sun/star/chart/Diagram.idl @@ -30,8 +30,16 @@ #ifndef __com_sun_star_chart_XDiagram_idl__ #include <com/sun/star/chart/XDiagram.idl> #endif + +#ifndef __com_sun_star_chart_XDiagramPositioning_idl__ +#include <com/sun/star/chart/XDiagramPositioning.idl> +#endif -#ifndef __com_sun_star_beans_XPropertySet_idl__ +#ifndef __com_sun_star_chart_XSecondAxisTitleSupplier_idl__ +#include <com/sun/star/chart/XSecondAxisTitleSupplier.idl> +#endif + +#ifndef __com_sun_star_beans_XPropertySet_idl__ #include <com/sun/star/beans/XPropertySet.idl> #endif @@ -64,6 +72,17 @@ published service Diagram interface com::sun::star::chart::XDiagram; + /** Provides access to the titles of the secondary X axis and Y axis. + + @since OOo 3.0 + */ + [optional] interface com::sun::star::chart::XSecondAxisTitleSupplier; + + /** + @since OOo 3.3 + */ + [optional] interface com::sun::star::chart::XDiagramPositioning; + //------------------------------------------------------------------------- /** If this property is <TRUE/> the position is calculated by the application automatically. diff --git a/offapi/com/sun/star/chart/XDiagramPositioning.idl b/offapi/com/sun/star/chart/XDiagramPositioning.idl new file mode 100644 index 000000000..cc12ccfff --- /dev/null +++ b/offapi/com/sun/star/chart/XDiagramPositioning.idl @@ -0,0 +1,107 @@ +/************************************************************************* + * + * 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: XDiagramPositioning.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_chart_XDiagramPositioning_idl__ +#define __com_sun_star_chart_XDiagramPositioning_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif +#ifndef __com_sun_star_awt_Rectangle_idl__ +#include <com/sun/star/awt/Rectangle.idl> +#endif + +//============================================================================= + + module com { module sun { module star { module chart { + +//============================================================================= + +/** allow for different positioning options for a diagram + + @see Diagram + */ +interface XDiagramPositioning : com::sun::star::uno::XInterface +{ + /** the diagram will be placed automtically + */ + void setAutomaticDiagramPositioning(); + + /** @returns whether the diagram is placed automtically + */ + boolean isAutomaticDiagramPositioning(); + + /** place the inner diagram part excluding any axes, labels and titles + @param PositionRect + specifies the position and size in 100/th mm + */ + void setDiagramPositionExcludingAxes( [in] com::sun::star::awt::Rectangle PositionRect ); + + /** @returns true in case the diagram position was set with method setDiagramPositionExcludingAxes + */ + boolean isExcludingDiagramPositioning(); + + /** @returns the position rectangle of the inner diagram part excluding any axes, labels and titles. + Position and size are given in 100/th mm. + It might be necessary to calculate the positioning so this method can be expensive and the result may depend on different other settings. + */ + com::sun::star::awt::Rectangle calculateDiagramPositionExcludingAxes(); + + + /** place the outer diagram part including the axes and axes labels, but excluding the axes titles. + @param PositionRect + specifies the position and size in 100/th mm + */ + void setDiagramPositionIncludingAxes( [in] com::sun::star::awt::Rectangle PositionRect ); + + /** @returns the position rectangle of the diagram including the axes and axes labels, but excluding the axes titles. + Position and size are given in 100/th mm. + It might be necessary to calculate the positioning so this method can be expensive and the result may depend on different other settings. + */ + com::sun::star::awt::Rectangle calculateDiagramPositionIncludingAxes(); + + /** place the diagram including the axes, axes labels and axes titles. + For the placement the current axis titles are taken into account, so the titles must be initialized properly before this method is called. + @param PositionRect + specifies the position and size in 100/th mm + */ + void setDiagramPositionIncludingAxesAndAxisTitles( [in] com::sun::star::awt::Rectangle PositionRect ); + + /** @returns the position rectangle of the diagram including the axes, axes labels and axes titles. + Position and size are given in 100/th mm. + It might be necessary to calculate the positioning so this method can be expensive and the result may depend on different other settings. + */ + com::sun::star::awt::Rectangle calculateDiagramPositionIncludingAxesAndAxisTitles(); +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/chart/makefile.mk b/offapi/com/sun/star/chart/makefile.mk index 2c0b93256..fdbf07173 100644 --- a/offapi/com/sun/star/chart/makefile.mk +++ b/offapi/com/sun/star/chart/makefile.mk @@ -105,6 +105,7 @@ IDLFILES=\ XChartDocument.idl\ XComplexDescriptionAccess.idl\ XDiagram.idl\ + XDiagramPositioning.idl\ XStatisticDisplay.idl\ XTwoAxisXSupplier.idl\ XTwoAxisYSupplier.idl\ diff --git a/offapi/com/sun/star/chart2/Diagram.idl b/offapi/com/sun/star/chart2/Diagram.idl index 737e8e9b9..4550d0ec6 100644 --- a/offapi/com/sun/star/chart2/Diagram.idl +++ b/offapi/com/sun/star/chart2/Diagram.idl @@ -77,6 +77,10 @@ service Diagram */ [property] ::com::sun::star::layout::RelativeSize RelativeSize; + /** The attributes RelativePosition and RelativeSize should be used for the inner coordinate region without axis labels and without data labels. + */ + [optional, property] boolean PosSizeExcludeLabels; + /** Sort data points by x values for rendering */ [optional, property] boolean SortByXValues; diff --git a/offapi/com/sun/star/configuration/Update.idl b/offapi/com/sun/star/configuration/Update.idl new file mode 100644 index 000000000..790a4bb40 --- /dev/null +++ b/offapi/com/sun/star/configuration/Update.idl @@ -0,0 +1,45 @@ +/************************************************************************* +* +* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +* +* Copyright 2000, 2010 Oracle and/or its affiliates. +* +* OpenOffice.org - a multi-platform office productivity suite +* +* This file is part of OpenOffice.org. +* +* OpenOffice.org is free software: you can redistribute it and/or modify +* it under the terms of the GNU Lesser General Public License version 3 +* only, as published by the Free Software Foundation. +* +* OpenOffice.org is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +* GNU Lesser General Public License version 3 for more details +* (a copy is included in the LICENSE file that accompanied this code). +* +* You should have received a copy of the GNU Lesser General Public License +* version 3 along with OpenOffice.org. If not, see +* <http://www.openoffice.org/license.html> +* for a copy of the LGPLv3 License. +* +************************************************************************/ + +#ifndef __com_sun_star_configuration_Update_idl__ +#define __com_sun_star_configuration_Update_idl__ + +#include "com/sun/star/configuration/XUpdate.idl" + +module com { module sun { module star { module configuration { + +/* Provides access to internal update features of the configuration provider. + + <p>This singleton is unpublished and unstable.</p> + + @since OOo 3.3.0 +*/ +singleton Update: XUpdate; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/configuration/XUpdate.idl b/offapi/com/sun/star/configuration/XUpdate.idl new file mode 100644 index 000000000..7514cbcb1 --- /dev/null +++ b/offapi/com/sun/star/configuration/XUpdate.idl @@ -0,0 +1,51 @@ +/************************************************************************* +* +* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +* +* Copyright 2000, 2010 Oracle and/or its affiliates. +* +* OpenOffice.org - a multi-platform office productivity suite +* +* This file is part of OpenOffice.org. +* +* OpenOffice.org is free software: you can redistribute it and/or modify +* it under the terms of the GNU Lesser General Public License version 3 +* only, as published by the Free Software Foundation. +* +* OpenOffice.org is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +* GNU Lesser General Public License version 3 for more details +* (a copy is included in the LICENSE file that accompanied this code). +* +* You should have received a copy of the GNU Lesser General Public License +* version 3 along with OpenOffice.org. If not, see +* <http://www.openoffice.org/license.html> +* for a copy of the LGPLv3 License. +* +************************************************************************/ + +#ifndef __com_sun_star_configuration_XUpdate_idl__ +#define __com_sun_star_configuration_XUpdate_idl__ + +#include "com/sun/star/uno/XInterface.idl" + +module com { module sun { module star { module configuration { + +/* Provides access to internal update features of the configuration provider. + + <p>This interface is unpublished and unstable.</p> + + @since OOo 3.3.0 +*/ +interface XUpdate { + void insertExtensionXcsFile([in] boolean shared, [in] string fileUri); + void insertExtensionXcuFile([in] boolean shared, [in] string fileUri); + void insertModificationXcuFile( + [in] string fileUri, [in] sequence< string > includedPaths, + [in] sequence< string > excludedPaths); +}; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/configuration/makefile.mk b/offapi/com/sun/star/configuration/makefile.mk index 0dc3a42df..00525e9ba 100644 --- a/offapi/com/sun/star/configuration/makefile.mk +++ b/offapi/com/sun/star/configuration/makefile.mk @@ -65,6 +65,8 @@ IDLFILES=\ PropertyHierarchy.idl\ XTemplateContainer.idl\ XTemplateInstance.idl\ + Update.idl \ + XUpdate.idl # ------------------------------------------------------------------ diff --git a/offapi/com/sun/star/document/DocumentProperties.idl b/offapi/com/sun/star/document/DocumentProperties.idl index 3e1a102aa..111cedb01 100755 --- a/offapi/com/sun/star/document/DocumentProperties.idl +++ b/offapi/com/sun/star/document/DocumentProperties.idl @@ -49,7 +49,7 @@ module com { module sun { module star { module document { @see XDocumentProperties @see XDocumentPropertiesSupplier */ -service DocumentProperties : XDocumentProperties +published service DocumentProperties : XDocumentProperties { /** constructs default-initialized instance */ diff --git a/offapi/com/sun/star/document/OfficeDocument.idl b/offapi/com/sun/star/document/OfficeDocument.idl index 888c7a574..51c119eda 100644 --- a/offapi/com/sun/star/document/OfficeDocument.idl +++ b/offapi/com/sun/star/document/OfficeDocument.idl @@ -71,6 +71,10 @@ #include <com/sun/star/document/XEmbeddedScripts.idl> #endif +#ifndef __com_sun_star_document_XDocumentPropertiesSupplier_idl__ +#include <com/sun/star/document/XDocumentPropertiesSupplier.idl> +#endif + //============================================================================= module com { module sun { module star { module document { @@ -158,6 +162,8 @@ published service OfficeDocument Instead of the <type>StandaloneDocumentInfo</type> service the <type>DocumentInfo</type> will be available on an already opened document only. </p> + + @deprecated Use <type>XDocumentPropertiesSupplier</type> instead. */ [optional] interface XDocumentInfoSupplier; @@ -180,6 +186,13 @@ published service OfficeDocument [optional] interface XEmbeddedScripts; //------------------------------------------------------------------------- + /** access to the <type>DocumentProperties</type>. + + @since OOo 3.0 + */ + [optional] interface XDocumentPropertiesSupplier; + + //------------------------------------------------------------------------- /** controls the focus behaviour of the form controls in the document <p> diff --git a/offapi/com/sun/star/document/XDocumentProperties.idl b/offapi/com/sun/star/document/XDocumentProperties.idl index 07058cedf..8a3b2c184 100755 --- a/offapi/com/sun/star/document/XDocumentProperties.idl +++ b/offapi/com/sun/star/document/XDocumentProperties.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -88,7 +88,7 @@ module com { module sun { module star { module document { for getting access to an instance from a loaded document @see DocumentProperties for a service that implements this interface */ -interface XDocumentProperties +published interface XDocumentProperties { //------------------------------------------------------------------------- /** contains the initial author of the document. @@ -352,8 +352,6 @@ interface XDocumentProperties if thrown when trying to open a stream in the given storage @throws com::sun::star::io::IOException if thrown when trying to open a stream in the given storage - @throws com::sun::star::uno::Exception - in various unspecified circumstances */ void loadFromStorage( [in] com::sun::star::embed::XStorage Storage, @@ -361,15 +359,10 @@ interface XDocumentProperties raises( com::sun::star::lang::IllegalArgumentException, com::sun::star::io::WrongFormatException, com::sun::star::lang::WrappedTargetException, - com::sun::star::io::IOException, - com::sun::star::uno::Exception ); + com::sun::star::io::IOException ); //------------------------------------------------------------------------- /** loads document properties from an ODF package or an OLE container. - <p> - For compatibility reasons this method also supports the import from - former StarOffice binary file formats. - </p> @param URL the URL of the source document @@ -389,16 +382,13 @@ interface XDocumentProperties if thrown when trying to open a stream in the given storage @throws com::sun::star::io::IOException if thrown when trying to open a stream in the given storage - @throws com::sun::star::uno::Exception - in various unspecified circumstances */ void loadFromMedium( [in] string URL, [in] sequence < com::sun::star::beans::PropertyValue > Medium ) raises( com::sun::star::io::WrongFormatException, com::sun::star::lang::WrappedTargetException, - com::sun::star::io::IOException, - com::sun::star::uno::Exception ); + com::sun::star::io::IOException ); //------------------------------------------------------------------------- /** stores document properties to an ODF package. @@ -428,23 +418,16 @@ interface XDocumentProperties if thrown when trying to open a stream in the given storage @throws com::sun::star::io::IOException if thrown when writing to the storage - @throws com::sun::star::uno::Exception - in various unspecified circumstances */ void storeToStorage( [in] com::sun::star::embed::XStorage Storage, [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::uno::Exception ); + com::sun::star::io::IOException ); //------------------------------------------------------------------------- /** stores document properties to an ODF package or an OLE container. - <p> - For compatibility reasons this method also supports the export to former - StarOffice binary file formats. - </p> @param URL the URL of the target document @@ -462,15 +445,12 @@ interface XDocumentProperties if thrown when trying to open a stream in the given storage @throws com::sun::star::io::IOException if thrown when writing to the storage - @throws com::sun::star::uno::Exception - in various unspecified circumstances */ void storeToMedium( [in] string URL, [in] sequence < com::sun::star::beans::PropertyValue > Medium ) raises( com::sun::star::lang::WrappedTargetException, - com::sun::star::io::IOException, - com::sun::star::uno::Exception ); + com::sun::star::io::IOException ); }; //============================================================================= diff --git a/offapi/com/sun/star/document/XDocumentPropertiesSupplier.idl b/offapi/com/sun/star/document/XDocumentPropertiesSupplier.idl index 6db58dc7c..8fa61d44a 100644 --- a/offapi/com/sun/star/document/XDocumentPropertiesSupplier.idl +++ b/offapi/com/sun/star/document/XDocumentPropertiesSupplier.idl @@ -52,7 +52,7 @@ module com { module sun { module star { module document { @see XDocumentProperties @see DocumentProperties */ -interface XDocumentPropertiesSupplier +published interface XDocumentPropertiesSupplier { //------------------------------------------------------------------------- /** provides the document properties object. diff --git a/offapi/com/sun/star/drawing/EnhancedCustomShapeHandle.idl b/offapi/com/sun/star/drawing/EnhancedCustomShapeHandle.idl index c5afa44ab..2d5f57d57 100644 --- a/offapi/com/sun/star/drawing/EnhancedCustomShapeHandle.idl +++ b/offapi/com/sun/star/drawing/EnhancedCustomShapeHandle.idl @@ -68,6 +68,26 @@ service EnhancedCustomShapeHandle */ [optional, property] ::com::sun::star::drawing::EnhancedCustomShapeParameterPair Polar; + /** RefX, if this attribute is set, it specifies the index of the adjustment + value which is connected to the horizontal position of the handle + */ + [optional, property] long RefX; + + /** RefY, if this attribute is set, it specifies the index of the adjustment + value which is connected to the vertical position of the handle + */ + [optional, property] long RefY; + + /** RefAngle, if this attribute is set, it specifies the index of the adjustment + value which is connected to the angle of the handle + */ + [optional, property] long RefAngle; + + /** RefR, if this attribute is set, it specifies the index of the adjustment + value which is connected to the radius of the handle + */ + [optional, property] long RefR; + /** If the attribute RangeXMinimum is set, it specifies the horizontal minimum range of the handle. */ [optional, property] ::com::sun::star::drawing::EnhancedCustomShapeParameter RangeXMinimum; diff --git a/offapi/com/sun/star/drawing/Shape.idl b/offapi/com/sun/star/drawing/Shape.idl index 024587c28..360352a91 100644 --- a/offapi/com/sun/star/drawing/Shape.idl +++ b/offapi/com/sun/star/drawing/Shape.idl @@ -136,6 +136,14 @@ published service Shape //------------------------------------------------------------------------- /** If this is <FALSE/>, the <type>Shape</type> is not visible + on screen outputs. Please note that the <type>Shape</type> may still + be visible when printed, see <member>Printable</member>. + */ + [optional, property] boolean Visible; + + //------------------------------------------------------------------------- + + /** If this is <FALSE/>, the <type>Shape</type> is not visible on printer outputs. */ [optional, property] boolean Printable; diff --git a/offapi/com/sun/star/drawing/framework/XResourceFactory.idl b/offapi/com/sun/star/drawing/framework/XResourceFactory.idl index 59feae808..5193d09f8 100644 --- a/offapi/com/sun/star/drawing/framework/XResourceFactory.idl +++ b/offapi/com/sun/star/drawing/framework/XResourceFactory.idl @@ -31,6 +31,12 @@ #ifndef __com_sun_star_uno_XInterface_idl__ #include <com/sun/star/uno/XInterface.idl> #endif +#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ +#include <com/sun/star/lang/IllegalArgumentException.idl> +#endif +#ifndef __com_sun_star_lang_WrappedTargetException_idl__ +#include <com/sun/star/lang/WrappedTargetException.idl> +#endif module com { module sun { module star { module drawing { module framework { @@ -65,7 +71,10 @@ interface XResourceFactory when the given URL is not supported by the factory. */ XResource createResource ( - [in] XResourceId xResourceId); + [in] XResourceId xResourceId) + raises ( ::com::sun::star::lang::IllegalArgumentException, + ::com::sun::star::lang::WrappedTargetException + ); /** Call this method to tell a factory that the given resource is no longer in use. The factory can decide whether to destroy the diff --git a/offapi/com/sun/star/drawing/framework/XView.idl b/offapi/com/sun/star/drawing/framework/XView.idl index d13fe0a6c..552915290 100644 --- a/offapi/com/sun/star/drawing/framework/XView.idl +++ b/offapi/com/sun/star/drawing/framework/XView.idl @@ -45,8 +45,6 @@ module com { module sun { module star { module drawing { module framework { view is. It just needs to identify view objects and a typesafe way to reference them.</p> <p>The URL prefix of views is <code>private:resource/view</code></p> - @see XViewController - @see XViewFactory */ interface XView { diff --git a/offapi/com/sun/star/embed/Actions.idl b/offapi/com/sun/star/embed/Actions.idl index 935cf1c66..e57f4aeca 100644 --- a/offapi/com/sun/star/embed/Actions.idl +++ b/offapi/com/sun/star/embed/Actions.idl @@ -35,7 +35,7 @@ module com { module sun { module star { module embed { /** This constant set contains possible actions that could be approved by <type>ActionsApproval</type> implementation. */ -constants Actions +published constants Actions { //------------------------------------------------------------------------ /** "Prevent Close" - throws veto excetion if target object is going to diff --git a/offapi/com/sun/star/embed/Aspects.idl b/offapi/com/sun/star/embed/Aspects.idl index e083b9f54..bc15254b5 100644 --- a/offapi/com/sun/star/embed/Aspects.idl +++ b/offapi/com/sun/star/embed/Aspects.idl @@ -49,7 +49,7 @@ module com { module sun { module star { module embed { @see XEmbeddedObject */ -constants Aspects +published constants Aspects { // MS OLE aspects diff --git a/offapi/com/sun/star/embed/BaseStorage.idl b/offapi/com/sun/star/embed/BaseStorage.idl index a63f89a70..cc55208ca 100644 --- a/offapi/com/sun/star/embed/BaseStorage.idl +++ b/offapi/com/sun/star/embed/BaseStorage.idl @@ -44,7 +44,7 @@ //============================================================================ /** This is a service that allows to get access to a storage hierarchy. */ -service BaseStorage +published service BaseStorage { // ----------------------------------------------------------------------- /** This is a general interface representing storage functionality. diff --git a/offapi/com/sun/star/embed/DocumentCloser.idl b/offapi/com/sun/star/embed/DocumentCloser.idl index c5b379f29..89e52c794 100644 --- a/offapi/com/sun/star/embed/DocumentCloser.idl +++ b/offapi/com/sun/star/embed/DocumentCloser.idl @@ -65,7 +65,7 @@ module com { module sun { module star { module embed { from the container system window. </p> */ -service DocumentCloser : com::sun::star::lang::XComponent +published service DocumentCloser : com::sun::star::lang::XComponent { /** is used to initialize the object on it's creation. diff --git a/offapi/com/sun/star/embed/ElementModes.idl b/offapi/com/sun/star/embed/ElementModes.idl index 849eff366..c43247ba4 100644 --- a/offapi/com/sun/star/embed/ElementModes.idl +++ b/offapi/com/sun/star/embed/ElementModes.idl @@ -43,7 +43,7 @@ module com { module sun { module star { module embed { @see <type>XStorage</type> */ -constants ElementModes +published constants ElementModes { //------------------------------------------------------------------------ /** specifies opening of an element for reading. diff --git a/offapi/com/sun/star/embed/EmbedMapUnits.idl b/offapi/com/sun/star/embed/EmbedMapUnits.idl index 448b022c1..045590dfa 100644 --- a/offapi/com/sun/star/embed/EmbedMapUnits.idl +++ b/offapi/com/sun/star/embed/EmbedMapUnits.idl @@ -37,7 +37,7 @@ module com { module sun { module star { module embed { @see XVisualObject */ -constants EmbedMapUnits +published constants EmbedMapUnits { // ---------------------------------------------------------------------- /** In this type of map mode one logical point is equal to one-hundredth diff --git a/offapi/com/sun/star/embed/EmbedMisc.idl b/offapi/com/sun/star/embed/EmbedMisc.idl index 441d0cf34..379f4d18b 100644 --- a/offapi/com/sun/star/embed/EmbedMisc.idl +++ b/offapi/com/sun/star/embed/EmbedMisc.idl @@ -47,7 +47,7 @@ module com { module sun { module star { module embed { @see XEmbeddedObject */ -constants EmbedMisc +published constants EmbedMisc { // analog of the MS OLEMISC enum diff --git a/offapi/com/sun/star/embed/EmbedStates.idl b/offapi/com/sun/star/embed/EmbedStates.idl index f166a7e5c..89536b5fa 100644 --- a/offapi/com/sun/star/embed/EmbedStates.idl +++ b/offapi/com/sun/star/embed/EmbedStates.idl @@ -36,7 +36,7 @@ module com { module sun { module star { module embed { /** This constant set contains possible states for <type>EmbeddedObject</type>. */ -constants EmbedStates +published constants EmbedStates { //------------------------------------------------------------------------ /** "Loaded" - the persistent representation of the object is loaded in diff --git a/offapi/com/sun/star/embed/EmbedUpdateModes.idl b/offapi/com/sun/star/embed/EmbedUpdateModes.idl index ea387d19b..725469b0c 100644 --- a/offapi/com/sun/star/embed/EmbedUpdateModes.idl +++ b/offapi/com/sun/star/embed/EmbedUpdateModes.idl @@ -37,7 +37,7 @@ module com { module sun { module star { module embed { @see XEmbeddedObject */ -constants EmbedUpdateModes +published constants EmbedUpdateModes { // ----------------------------------------------------------------------- /** An object representation should be updated as often as possible. diff --git a/offapi/com/sun/star/embed/EmbedVerbs.idl b/offapi/com/sun/star/embed/EmbedVerbs.idl index f468ec4d0..74b3584e4 100644 --- a/offapi/com/sun/star/embed/EmbedVerbs.idl +++ b/offapi/com/sun/star/embed/EmbedVerbs.idl @@ -37,7 +37,7 @@ module com { module sun { module star { module embed { @see XEmbeddedObject */ -constants EmbedVerbs +published constants EmbedVerbs { //------------------------------------------------------------------------ /** lets the object do default activation, as by doubleclick. diff --git a/offapi/com/sun/star/embed/EmbeddedObjectDescriptor.idl b/offapi/com/sun/star/embed/EmbeddedObjectDescriptor.idl index e9683f301..ec4e56c23 100644 --- a/offapi/com/sun/star/embed/EmbeddedObjectDescriptor.idl +++ b/offapi/com/sun/star/embed/EmbeddedObjectDescriptor.idl @@ -71,7 +71,7 @@ module com { module sun { module star { module embed { @see com::sun::star::beans::PropertyValue */ -service EmbeddedObjectDescriptor +published service EmbeddedObjectDescriptor { //------------------------------------------------------------------------ /** lets the graphical representation of embedded document be stored. diff --git a/offapi/com/sun/star/embed/EntryInitModes.idl b/offapi/com/sun/star/embed/EntryInitModes.idl index 3bcd51eb3..f2a9bb920 100644 --- a/offapi/com/sun/star/embed/EntryInitModes.idl +++ b/offapi/com/sun/star/embed/EntryInitModes.idl @@ -38,7 +38,7 @@ module com { module sun { module star { module embed { @see XEmbedPersist */ -constants EntryInitModes +published constants EntryInitModes { // ----------------------------------------------------------------------- /** In case object persistance is created based on existing entry, diff --git a/offapi/com/sun/star/embed/FileSystemStorage.idl b/offapi/com/sun/star/embed/FileSystemStorage.idl index 486e53912..f8b6b6eb6 100644 --- a/offapi/com/sun/star/embed/FileSystemStorage.idl +++ b/offapi/com/sun/star/embed/FileSystemStorage.idl @@ -40,7 +40,7 @@ /** This is a service that allows to get access to a file system folder using storage hierarchy. */ -service FileSystemStorage +published service FileSystemStorage { // ----------------------------------------------------------------------- /** This service describes the base functionality of storages. diff --git a/offapi/com/sun/star/embed/FileSystemStorageFactory.idl b/offapi/com/sun/star/embed/FileSystemStorageFactory.idl index b4db095c9..5fc37023c 100644 --- a/offapi/com/sun/star/embed/FileSystemStorageFactory.idl +++ b/offapi/com/sun/star/embed/FileSystemStorageFactory.idl @@ -42,7 +42,7 @@ create a <type>FileSystemStorage</type> based on URL. The URL must point to a folder. */ -service FileSystemStorageFactory +published service FileSystemStorageFactory { // ---------------------------------------------------------------------- /** A storage can be created through this interface. diff --git a/offapi/com/sun/star/embed/InsertedObjectInfo.idl b/offapi/com/sun/star/embed/InsertedObjectInfo.idl index 14bcb4c90..8453743d3 100644 --- a/offapi/com/sun/star/embed/InsertedObjectInfo.idl +++ b/offapi/com/sun/star/embed/InsertedObjectInfo.idl @@ -43,7 +43,7 @@ /** is intended to provide result of creation of an embedded object by dialog. */ -struct InsertedObjectInfo +published struct InsertedObjectInfo { //------------------------------------------------------------------------- /** The new created embedded object. diff --git a/offapi/com/sun/star/embed/InstanceLocker.idl b/offapi/com/sun/star/embed/InstanceLocker.idl index 0ac9964a5..b5e378711 100644 --- a/offapi/com/sun/star/embed/InstanceLocker.idl +++ b/offapi/com/sun/star/embed/InstanceLocker.idl @@ -57,7 +57,7 @@ module com { module sun { module star { module embed { the listener throw related veto exception until the service is disposed. </p> */ -service InstanceLocker : com::sun::star::lang::XComponent +published service InstanceLocker : com::sun::star::lang::XComponent { /** is used to initialize the object on it's creation. diff --git a/offapi/com/sun/star/embed/InvalidStorageException.idl b/offapi/com/sun/star/embed/InvalidStorageException.idl index 5bedad026..4e74f8a6e 100644 --- a/offapi/com/sun/star/embed/InvalidStorageException.idl +++ b/offapi/com/sun/star/embed/InvalidStorageException.idl @@ -44,7 +44,7 @@ For example in case it is broken one. </p> */ -exception InvalidStorageException: com::sun::star::io::IOException +published exception InvalidStorageException: com::sun::star::io::IOException { }; diff --git a/offapi/com/sun/star/embed/LinkageMisuseException.idl b/offapi/com/sun/star/embed/LinkageMisuseException.idl index 4e064093a..88153d25c 100644 --- a/offapi/com/sun/star/embed/LinkageMisuseException.idl +++ b/offapi/com/sun/star/embed/LinkageMisuseException.idl @@ -44,7 +44,7 @@ Or if embedded object is misused as a linked object. </p> */ -exception LinkageMisuseException: com::sun::star::uno::Exception +published exception LinkageMisuseException: com::sun::star::uno::Exception { }; diff --git a/offapi/com/sun/star/embed/NeedsRunningStateException.idl b/offapi/com/sun/star/embed/NeedsRunningStateException.idl index aaaa6f078..adf3c7e25 100644 --- a/offapi/com/sun/star/embed/NeedsRunningStateException.idl +++ b/offapi/com/sun/star/embed/NeedsRunningStateException.idl @@ -47,7 +47,7 @@ addition to the loaded state. Other states and possible verbs can be detected only after object is switched to running state. */ -exception NeedsRunningStateException: WrongStateException +published exception NeedsRunningStateException: WrongStateException { }; diff --git a/offapi/com/sun/star/embed/NoVisualAreaSizeException.idl b/offapi/com/sun/star/embed/NoVisualAreaSizeException.idl index 2fccc138e..bdebbefa6 100644 --- a/offapi/com/sun/star/embed/NoVisualAreaSizeException.idl +++ b/offapi/com/sun/star/embed/NoVisualAreaSizeException.idl @@ -41,7 +41,7 @@ /** This exception can be thrown in case the object can not provide own visual area currently. */ -exception NoVisualAreaSizeException: com::sun::star::uno::Exception +published exception NoVisualAreaSizeException: com::sun::star::uno::Exception { }; diff --git a/offapi/com/sun/star/embed/OLESimpleStorage.idl b/offapi/com/sun/star/embed/OLESimpleStorage.idl index d432089ac..59c3470ef 100644 --- a/offapi/com/sun/star/embed/OLESimpleStorage.idl +++ b/offapi/com/sun/star/embed/OLESimpleStorage.idl @@ -45,7 +45,7 @@ module com { module sun { module star { module embed { /** This service provides a simple functionality to allow read/write the storages in OLE storage format. */ -service OLESimpleStorage: XOLESimpleStorage +published service OLESimpleStorage: XOLESimpleStorage { // CONSTRUCTORS ---------------------------------------------------------- /** is used to initialize the object on it's creation. diff --git a/offapi/com/sun/star/embed/ObjectSaveVetoException.idl b/offapi/com/sun/star/embed/ObjectSaveVetoException.idl index da4f5dba7..c99970a25 100644 --- a/offapi/com/sun/star/embed/ObjectSaveVetoException.idl +++ b/offapi/com/sun/star/embed/ObjectSaveVetoException.idl @@ -43,7 +43,7 @@ @see XEmbeddedClient */ -exception ObjectSaveVetoException: com::sun::star::uno::Exception +published exception ObjectSaveVetoException: com::sun::star::uno::Exception { }; diff --git a/offapi/com/sun/star/embed/StateChangeInProgressException.idl b/offapi/com/sun/star/embed/StateChangeInProgressException.idl index ae64fb193..932039abe 100644 --- a/offapi/com/sun/star/embed/StateChangeInProgressException.idl +++ b/offapi/com/sun/star/embed/StateChangeInProgressException.idl @@ -42,7 +42,7 @@ to call requested functionality currently because the object is changing state. */ -exception StateChangeInProgressException: com::sun::star::embed::WrongStateException +published exception StateChangeInProgressException: com::sun::star::embed::WrongStateException { //------------------------------------------------------------------------ /** contains the target state the object tries to reach currently. diff --git a/offapi/com/sun/star/embed/Storage.idl b/offapi/com/sun/star/embed/Storage.idl index 83c020f28..f12065ce2 100644 --- a/offapi/com/sun/star/embed/Storage.idl +++ b/offapi/com/sun/star/embed/Storage.idl @@ -75,7 +75,7 @@ of a parent storage. </p> */ -service Storage +published service Storage { // ----------------------------------------------------------------------- /** This service describes the base functionality of storages. diff --git a/offapi/com/sun/star/embed/StorageFactory.idl b/offapi/com/sun/star/embed/StorageFactory.idl index 6e73182f3..e36325ee1 100644 --- a/offapi/com/sun/star/embed/StorageFactory.idl +++ b/offapi/com/sun/star/embed/StorageFactory.idl @@ -41,7 +41,7 @@ /** The <type>StorageFactory</type> is a service that allows to create a storage based on either stream or URL. */ -service StorageFactory +published service StorageFactory { // ---------------------------------------------------------------------- /** A storage can be created through this interface. @@ -82,13 +82,22 @@ service StorageFactory <dt>parameter 3</dt> <dd> - allowes to provide + this paramenter represents + <type scope="com::sun::star::uno">Any</type> + containing a sequence of + <type scope="com::sun::star::beans">PropertyValue</type>.<br> + The parameter can contain entries from <type scope="com::sun::star::document">MediaDescryptor</type> - to the storage so some parts can be used for + to transport some document info during the storage initialization, it can be for example <type scope="com::sun::star::task">XInteractionHandler</type> implementation, password for the storage and repair - package flag. + package flag.<br> + Additionaly the parameter might contain property with the name + "StorageFormat" that can take values from + <type scope="com::sun::star::embed">StorageFormats</type>. + If the property is not provided a storage of package format + is created. </dd> </dl> diff --git a/offapi/com/sun/star/embed/StorageFormats.idl b/offapi/com/sun/star/embed/StorageFormats.idl new file mode 100644 index 000000000..99115e5aa --- /dev/null +++ b/offapi/com/sun/star/embed/StorageFormats.idl @@ -0,0 +1,65 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_embed_StorageFormats_idl__ +#define __com_sun_star_embed_StorageFormats_idl__ + + +//============================================================================ + +module com { module sun { module star { module embed { + +//============================================================================ +/** The constant set contains IDs of formats that are supported by + <type>StorageFactory</type>. + + @see <type>StorageFactory</type> + @since OOo 3.3 +*/ +published constants StorageFormats +{ + //------------------------------------------------------------------------ + /** specifies package format + */ + const long PACKAGE = 1; + + //------------------------------------------------------------------------ + /** specifies zip format + */ + const long ZIP = 2; + + //------------------------------------------------------------------------ + /** specifies Office Open XML format + */ + const long OFOPXML = 3; +}; + +//============================================================================ + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/embed/StorageStream.idl b/offapi/com/sun/star/embed/StorageStream.idl index c845b70de..ec7afd2e2 100644 --- a/offapi/com/sun/star/embed/StorageStream.idl +++ b/offapi/com/sun/star/embed/StorageStream.idl @@ -64,7 +64,7 @@ of the stream can exist. </p> */ -service StorageStream +published service StorageStream { // ----------------------------------------------------------------------- /** allows to get access to <type scope="com::sun::star::io">XInputStream</type> diff --git a/offapi/com/sun/star/embed/StorageWrappedTargetException.idl b/offapi/com/sun/star/embed/StorageWrappedTargetException.idl index 3ae23a57d..eecd166a9 100644 --- a/offapi/com/sun/star/embed/StorageWrappedTargetException.idl +++ b/offapi/com/sun/star/embed/StorageWrappedTargetException.idl @@ -41,7 +41,7 @@ /** This exception can wrap an exception thrown during <type>XStorage</type> methods execution. */ -exception StorageWrappedTargetException: com::sun::star::lang::WrappedTargetException +published exception StorageWrappedTargetException: com::sun::star::lang::WrappedTargetException { }; diff --git a/offapi/com/sun/star/embed/UnreachableStateException.idl b/offapi/com/sun/star/embed/UnreachableStateException.idl index 9fb674c85..6c852c05a 100644 --- a/offapi/com/sun/star/embed/UnreachableStateException.idl +++ b/offapi/com/sun/star/embed/UnreachableStateException.idl @@ -40,7 +40,7 @@ /** This exception can be thrown in case specified state can not be reached. */ -exception UnreachableStateException: com::sun::star::uno::Exception +published exception UnreachableStateException: com::sun::star::uno::Exception { // ----------------------------------------------------------------------- /** The current state of the object. diff --git a/offapi/com/sun/star/embed/UseBackupException.idl b/offapi/com/sun/star/embed/UseBackupException.idl index d487bd322..aef41fde2 100644 --- a/offapi/com/sun/star/embed/UseBackupException.idl +++ b/offapi/com/sun/star/embed/UseBackupException.idl @@ -51,7 +51,7 @@ internally, and can be used as a temporary storage usually used. </p> */ -exception UseBackupException: com::sun::star::io::IOException +published exception UseBackupException: com::sun::star::io::IOException { /** The URL of the temporary file the storage is based on now. */ diff --git a/offapi/com/sun/star/embed/VerbAttributes.idl b/offapi/com/sun/star/embed/VerbAttributes.idl index 27249c3b4..e24124216 100644 --- a/offapi/com/sun/star/embed/VerbAttributes.idl +++ b/offapi/com/sun/star/embed/VerbAttributes.idl @@ -37,7 +37,7 @@ module com { module sun { module star { module embed { @see VerbDescriptor */ -constants VerbAttributes +published constants VerbAttributes { // ----------------------------------------------------------------------- /** Execution of the verb with this attribute must not modify the diff --git a/offapi/com/sun/star/embed/VerbDescriptor.idl b/offapi/com/sun/star/embed/VerbDescriptor.idl index 99b169ace..de3b0861f 100644 --- a/offapi/com/sun/star/embed/VerbDescriptor.idl +++ b/offapi/com/sun/star/embed/VerbDescriptor.idl @@ -36,7 +36,7 @@ /** describes a verb. */ -struct VerbDescriptor +published struct VerbDescriptor { //------------------------------------------------------------------------ /** specifies the id of the verb. diff --git a/offapi/com/sun/star/embed/VisualRepresentation.idl b/offapi/com/sun/star/embed/VisualRepresentation.idl index bee8d4020..b118f88a2 100644 --- a/offapi/com/sun/star/embed/VisualRepresentation.idl +++ b/offapi/com/sun/star/embed/VisualRepresentation.idl @@ -39,7 +39,7 @@ /** can contain a graphical representation in an arbitrary format. */ -struct VisualRepresentation +published struct VisualRepresentation { //------------------------------------------------------------------------- /** The format of the visual representation. diff --git a/offapi/com/sun/star/embed/WrongStateException.idl b/offapi/com/sun/star/embed/WrongStateException.idl index 792934774..18c625bbf 100644 --- a/offapi/com/sun/star/embed/WrongStateException.idl +++ b/offapi/com/sun/star/embed/WrongStateException.idl @@ -41,7 +41,7 @@ /** This exception can be thrown in case the object's state does not allow to call requested functionality. */ -exception WrongStateException: com::sun::star::uno::Exception +published exception WrongStateException: com::sun::star::uno::Exception { }; diff --git a/offapi/com/sun/star/embed/XActionsApproval.idl b/offapi/com/sun/star/embed/XActionsApproval.idl index a19b7bf56..8aaa53e18 100644 --- a/offapi/com/sun/star/embed/XActionsApproval.idl +++ b/offapi/com/sun/star/embed/XActionsApproval.idl @@ -44,7 +44,7 @@ possible actions must be documented in documentation of the object. </p> */ -interface XActionsApproval: com::sun::star::uno::XInterface +published interface XActionsApproval: com::sun::star::uno::XInterface { //------------------------------------------------------------------------ /** requests an approval for the specified action. diff --git a/offapi/com/sun/star/embed/XClassifiedObject.idl b/offapi/com/sun/star/embed/XClassifiedObject.idl index c9a701f78..758a69eb5 100644 --- a/offapi/com/sun/star/embed/XClassifiedObject.idl +++ b/offapi/com/sun/star/embed/XClassifiedObject.idl @@ -43,7 +43,7 @@ //============================================================================ /** represents common functionality for embedded objects */ -interface XClassifiedObject: com::sun::star::uno::XInterface +published interface XClassifiedObject: com::sun::star::uno::XInterface { // ----------------------------------------------------------------------- /** retrieves class ID of the object. diff --git a/offapi/com/sun/star/embed/XCommonEmbedPersist.idl b/offapi/com/sun/star/embed/XCommonEmbedPersist.idl index 071e5fcbe..00445ebfd 100644 --- a/offapi/com/sun/star/embed/XCommonEmbedPersist.idl +++ b/offapi/com/sun/star/embed/XCommonEmbedPersist.idl @@ -59,7 +59,7 @@ /** specifies common implementation for embedded objects and links persistence. */ -interface XCommonEmbedPersist: com::sun::star::uno::XInterface +published interface XCommonEmbedPersist: com::sun::star::uno::XInterface { //------------------------------------------------------------------------ /** lets the object or the link store itself. diff --git a/offapi/com/sun/star/embed/XComponentSupplier.idl b/offapi/com/sun/star/embed/XComponentSupplier.idl index bb544e388..b266b0761 100644 --- a/offapi/com/sun/star/embed/XComponentSupplier.idl +++ b/offapi/com/sun/star/embed/XComponentSupplier.idl @@ -38,7 +38,7 @@ //============================================================================= /** provides access to a component. */ -interface XComponentSupplier: com::sun::star::uno::XInterface +published interface XComponentSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- /** allows to get access to a component. diff --git a/offapi/com/sun/star/embed/XEmbedObjectClipboardCreator.idl b/offapi/com/sun/star/embed/XEmbedObjectClipboardCreator.idl index 01cc28434..74940a823 100644 --- a/offapi/com/sun/star/embed/XEmbedObjectClipboardCreator.idl +++ b/offapi/com/sun/star/embed/XEmbedObjectClipboardCreator.idl @@ -67,7 +67,7 @@ an embedded object based on system clipboard. </p> */ -interface XEmbedObjectClipboardCreator: com::sun::star::uno::XInterface +published interface XEmbedObjectClipboardCreator: com::sun::star::uno::XInterface { // ----------------------------------------------------------------------- /** creates a new object and initializes it from the system clipboard. diff --git a/offapi/com/sun/star/embed/XEmbedObjectCreator.idl b/offapi/com/sun/star/embed/XEmbedObjectCreator.idl index 799abd6de..11cb6bf26 100644 --- a/offapi/com/sun/star/embed/XEmbedObjectCreator.idl +++ b/offapi/com/sun/star/embed/XEmbedObjectCreator.idl @@ -63,7 +63,7 @@ an embedded object. </p> */ -interface XEmbedObjectCreator: com::sun::star::uno::XInterface +published interface XEmbedObjectCreator: com::sun::star::uno::XInterface { // ----------------------------------------------------------------------- /** creates a new object and initializes it as a new one. diff --git a/offapi/com/sun/star/embed/XEmbedObjectFactory.idl b/offapi/com/sun/star/embed/XEmbedObjectFactory.idl index a929fc523..19a3c9cc3 100644 --- a/offapi/com/sun/star/embed/XEmbedObjectFactory.idl +++ b/offapi/com/sun/star/embed/XEmbedObjectFactory.idl @@ -61,7 +61,7 @@ This interface provides user with full control over object creation. </p> */ -interface XEmbedObjectFactory: com::sun::star::uno::XInterface +published interface XEmbedObjectFactory: com::sun::star::uno::XInterface { //------------------------------------------------------------------------ /** creates a new object and transport parameters for persistent diff --git a/offapi/com/sun/star/embed/XEmbedPersist.idl b/offapi/com/sun/star/embed/XEmbedPersist.idl index 8456d221d..daecb3c1b 100644 --- a/offapi/com/sun/star/embed/XEmbedPersist.idl +++ b/offapi/com/sun/star/embed/XEmbedPersist.idl @@ -67,7 +67,7 @@ representation. </p> */ -interface XEmbedPersist: XCommonEmbedPersist +published interface XEmbedPersist: XCommonEmbedPersist { //------------------------------------------------------------------------ /** provides object with a parent storage and a name for object's entry. diff --git a/offapi/com/sun/star/embed/XEmbeddedClient.idl b/offapi/com/sun/star/embed/XEmbeddedClient.idl index 9dd99ad92..5dedbbc7e 100644 --- a/offapi/com/sun/star/embed/XEmbeddedClient.idl +++ b/offapi/com/sun/star/embed/XEmbeddedClient.idl @@ -52,7 +52,7 @@ //============================================================================ /** represents common functionality for embedded clients. */ -interface XEmbeddedClient: XComponentSupplier +published interface XEmbeddedClient: XComponentSupplier { //------------------------------------------------------------------------ /** asks client to let the object store itself. diff --git a/offapi/com/sun/star/embed/XEmbeddedObject.idl b/offapi/com/sun/star/embed/XEmbeddedObject.idl index c26182081..96adbbd66 100644 --- a/offapi/com/sun/star/embed/XEmbeddedObject.idl +++ b/offapi/com/sun/star/embed/XEmbeddedObject.idl @@ -92,7 +92,7 @@ //============================================================================ /** represents common functionality for embedded objects. */ -interface XEmbeddedObject +published interface XEmbeddedObject { // INTERFACES // diff --git a/offapi/com/sun/star/embed/XEncryptionProtectedSource.idl b/offapi/com/sun/star/embed/XEncryptionProtectedSource.idl index ef44f798d..c31cab6c3 100644 --- a/offapi/com/sun/star/embed/XEncryptionProtectedSource.idl +++ b/offapi/com/sun/star/embed/XEncryptionProtectedSource.idl @@ -42,7 +42,7 @@ //============================================================================ /** This interface allows to set a password for an object. */ -interface XEncryptionProtectedSource: com::sun::star::uno::XInterface +published interface XEncryptionProtectedSource: com::sun::star::uno::XInterface { // ----------------------------------------------------------------------- /** sets a password for the object. diff --git a/offapi/com/sun/star/embed/XExtendedStorageStream.idl b/offapi/com/sun/star/embed/XExtendedStorageStream.idl index bb46f4ae3..39ca580aa 100644 --- a/offapi/com/sun/star/embed/XExtendedStorageStream.idl +++ b/offapi/com/sun/star/embed/XExtendedStorageStream.idl @@ -63,7 +63,7 @@ /** This interface allows access to an extended storage stream that might be transacted. */ -interface XExtendedStorageStream +published interface XExtendedStorageStream { // INTERFACES // diff --git a/offapi/com/sun/star/embed/XHatchWindow.idl b/offapi/com/sun/star/embed/XHatchWindow.idl index 1c050e063..0c6c68c8b 100644 --- a/offapi/com/sun/star/embed/XHatchWindow.idl +++ b/offapi/com/sun/star/embed/XHatchWindow.idl @@ -56,7 +56,7 @@ Thus the window can not resize/move itself. </p> */ -interface XHatchWindow: com::sun::star::lang::XComponent +published interface XHatchWindow: com::sun::star::lang::XComponent { //------------------------------------------------------------------------ /** sets the object that will control resizing/moving, if the object is diff --git a/offapi/com/sun/star/embed/XHatchWindowController.idl b/offapi/com/sun/star/embed/XHatchWindowController.idl index 9fc068468..06f31eb51 100644 --- a/offapi/com/sun/star/embed/XHatchWindowController.idl +++ b/offapi/com/sun/star/embed/XHatchWindowController.idl @@ -49,7 +49,7 @@ rectangle size. </p> */ -interface XHatchWindowController: com::sun::star::uno::XInterface +published interface XHatchWindowController: com::sun::star::uno::XInterface { //------------------------------------------------------------------------ /** requests window owner to resize/move the window. diff --git a/offapi/com/sun/star/embed/XHatchWindowFactory.idl b/offapi/com/sun/star/embed/XHatchWindowFactory.idl index cdf55d667..cce67b8e8 100644 --- a/offapi/com/sun/star/embed/XHatchWindowFactory.idl +++ b/offapi/com/sun/star/embed/XHatchWindowFactory.idl @@ -55,7 +55,7 @@ /** creates a hatch window implementation. */ -interface XHatchWindowFactory: com::sun::star::uno::XInterface +published interface XHatchWindowFactory: com::sun::star::uno::XInterface { //------------------------------------------------------------------------ /** creates a new hatch window instance. diff --git a/offapi/com/sun/star/embed/XHierarchicalStorageAccess.idl b/offapi/com/sun/star/embed/XHierarchicalStorageAccess.idl index eefc56cba..d5b399015 100644 --- a/offapi/com/sun/star/embed/XHierarchicalStorageAccess.idl +++ b/offapi/com/sun/star/embed/XHierarchicalStorageAccess.idl @@ -95,7 +95,7 @@ opened ( it is locked by hierarchical access ). </p> */ -interface XHierarchicalStorageAccess +published interface XHierarchicalStorageAccess { // METHODS // diff --git a/offapi/com/sun/star/embed/XInplaceObject.idl b/offapi/com/sun/star/embed/XInplaceObject.idl index edf52ab80..840b0b1cb 100644 --- a/offapi/com/sun/star/embed/XInplaceObject.idl +++ b/offapi/com/sun/star/embed/XInplaceObject.idl @@ -52,7 +52,7 @@ //============================================================================ /** represents common functionality for inplace embedded objects. */ -interface XInplaceObject: com::sun::star::uno::XInterface +published interface XInplaceObject: com::sun::star::uno::XInterface { //------------------------------------------------------------------------ /** sets the visible part of the inplace object. diff --git a/offapi/com/sun/star/embed/XInsertObjectDialog.idl b/offapi/com/sun/star/embed/XInsertObjectDialog.idl index e5231947d..a5e30c79f 100644 --- a/offapi/com/sun/star/embed/XInsertObjectDialog.idl +++ b/offapi/com/sun/star/embed/XInsertObjectDialog.idl @@ -62,7 +62,7 @@ //============================================================================= /** allows to create and initialize a new embedded object using GUI dialog. */ -interface XInsertObjectDialog: com::sun::star::uno::XInterface +published interface XInsertObjectDialog: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- /** creates a new object using GUI dialog. diff --git a/offapi/com/sun/star/embed/XLinkCreator.idl b/offapi/com/sun/star/embed/XLinkCreator.idl index 0a565f1e8..8c071ae40 100644 --- a/offapi/com/sun/star/embed/XLinkCreator.idl +++ b/offapi/com/sun/star/embed/XLinkCreator.idl @@ -62,7 +62,7 @@ it will be detected. </p> */ -interface XLinkCreator: com::sun::star::uno::XInterface +published interface XLinkCreator: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- /** creates a new object based on diff --git a/offapi/com/sun/star/embed/XLinkFactory.idl b/offapi/com/sun/star/embed/XLinkFactory.idl index cd65379f7..e7cf1aee1 100644 --- a/offapi/com/sun/star/embed/XLinkFactory.idl +++ b/offapi/com/sun/star/embed/XLinkFactory.idl @@ -58,7 +58,7 @@ //============================================================================ /** allows to create and initialize a new link of specified type. */ -interface XLinkFactory: com::sun::star::uno::XInterface +published interface XLinkFactory: com::sun::star::uno::XInterface { //------------------------------------------------------------------------ /** creates a new link and transport parameters for persistent diff --git a/offapi/com/sun/star/embed/XLinkageSupport.idl b/offapi/com/sun/star/embed/XLinkageSupport.idl index db58f96c3..033150c72 100644 --- a/offapi/com/sun/star/embed/XLinkageSupport.idl +++ b/offapi/com/sun/star/embed/XLinkageSupport.idl @@ -54,7 +54,7 @@ //============================================================================ /** specifies an additional implementation for linked embedded object support. */ -interface XLinkageSupport: XCommonEmbedPersist +published interface XLinkageSupport: XCommonEmbedPersist { //------------------------------------------------------------------------ /** breaks the link and provides the object with a parent storage and a diff --git a/offapi/com/sun/star/embed/XOLESimpleStorage.idl b/offapi/com/sun/star/embed/XOLESimpleStorage.idl index 48ee9b539..cf378c28c 100644 --- a/offapi/com/sun/star/embed/XOLESimpleStorage.idl +++ b/offapi/com/sun/star/embed/XOLESimpleStorage.idl @@ -58,7 +58,7 @@ module com { module sun { module star { module embed { subcomponents are either OLE storages themself or streams. </p> */ -interface XOLESimpleStorage +published interface XOLESimpleStorage { //INTERFACES // diff --git a/offapi/com/sun/star/embed/XOptimizedStorage.idl b/offapi/com/sun/star/embed/XOptimizedStorage.idl index 2a83c698e..92c86c0d0 100644 --- a/offapi/com/sun/star/embed/XOptimizedStorage.idl +++ b/offapi/com/sun/star/embed/XOptimizedStorage.idl @@ -97,7 +97,7 @@ time and will be depricated soon! Another solution will be introduced as final one. */ -interface XOptimizedStorage +published interface XOptimizedStorage { // ----------------------------------------------------------------------- /** allows to insert a raw stream representing nonencrypted stream with diff --git a/offapi/com/sun/star/embed/XPackageStructureCreator.idl b/offapi/com/sun/star/embed/XPackageStructureCreator.idl index 9d8a8b3b1..b83282fd0 100644 --- a/offapi/com/sun/star/embed/XPackageStructureCreator.idl +++ b/offapi/com/sun/star/embed/XPackageStructureCreator.idl @@ -42,7 +42,7 @@ //============================================================================= /** allows to convert file system folder tree in to a package. */ -interface XPackageStructureCreator: com::sun::star::uno::XInterface +published interface XPackageStructureCreator: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- /** converts file system folder tree in to a package. diff --git a/offapi/com/sun/star/embed/XPersistanceHolder.idl b/offapi/com/sun/star/embed/XPersistanceHolder.idl index d8726f271..e5546cc08 100644 --- a/offapi/com/sun/star/embed/XPersistanceHolder.idl +++ b/offapi/com/sun/star/embed/XPersistanceHolder.idl @@ -46,7 +46,7 @@ //============================================================================= /** allows to disconnect an object from its persistence. */ -interface XPersistanceHolder: com::sun::star::uno::XInterface +published interface XPersistanceHolder: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- /** disconnects the object from the persistance. diff --git a/offapi/com/sun/star/embed/XRelationshipAccess.idl b/offapi/com/sun/star/embed/XRelationshipAccess.idl index 462fac2d2..ff6b72a78 100644 --- a/offapi/com/sun/star/embed/XRelationshipAccess.idl +++ b/offapi/com/sun/star/embed/XRelationshipAccess.idl @@ -62,7 +62,7 @@ this tag is used as a uniqued identified of an entry. </p> */ -interface XRelationshipAccess : ::com::sun::star::uno::XInterface +published interface XRelationshipAccess : ::com::sun::star::uno::XInterface { // ----------------------------------------------------------------------- /** allows to detect whether there is an entry with specified value of diff --git a/offapi/com/sun/star/embed/XStateChangeBroadcaster.idl b/offapi/com/sun/star/embed/XStateChangeBroadcaster.idl index 6ea323755..291cfae53 100644 --- a/offapi/com/sun/star/embed/XStateChangeBroadcaster.idl +++ b/offapi/com/sun/star/embed/XStateChangeBroadcaster.idl @@ -44,7 +44,7 @@ module com { module sun { module star { module embed { /** broadcasts message in case embedded object object changes it's state. */ -interface XStateChangeBroadcaster: com::sun::star::uno::XInterface +published interface XStateChangeBroadcaster: com::sun::star::uno::XInterface { //------------------------------------------------------------------------ /** adds the specified listener to receive events about states change diff --git a/offapi/com/sun/star/embed/XStateChangeListener.idl b/offapi/com/sun/star/embed/XStateChangeListener.idl index a3b46c312..367a587c5 100644 --- a/offapi/com/sun/star/embed/XStateChangeListener.idl +++ b/offapi/com/sun/star/embed/XStateChangeListener.idl @@ -48,7 +48,7 @@ module com { module sun { module star { module embed { /** makes it possible to receive events when an embedded object changes it's state. */ -interface XStateChangeListener: com::sun::star::lang::XEventListener +published interface XStateChangeListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------ /** is called just before the object changes state. diff --git a/offapi/com/sun/star/embed/XStorage.idl b/offapi/com/sun/star/embed/XStorage.idl index aab4f23bc..c6f216dcd 100644 --- a/offapi/com/sun/star/embed/XStorage.idl +++ b/offapi/com/sun/star/embed/XStorage.idl @@ -91,7 +91,7 @@ //============================================================================ /** This interface represents main storage functionality. */ -interface XStorage +published interface XStorage { // INTERFACES // diff --git a/offapi/com/sun/star/embed/XStorageRawAccess.idl b/offapi/com/sun/star/embed/XStorageRawAccess.idl index d433af6fb..482b676c0 100644 --- a/offapi/com/sun/star/embed/XStorageRawAccess.idl +++ b/offapi/com/sun/star/embed/XStorageRawAccess.idl @@ -79,7 +79,7 @@ //============================================================================ /** This interface represents main storage functionality. */ -interface XStorageRawAccess +published interface XStorageRawAccess { // ----------------------------------------------------------------------- /** allows to get a plain raw stream representing a package stream. diff --git a/offapi/com/sun/star/embed/XTransactedObject.idl b/offapi/com/sun/star/embed/XTransactedObject.idl index d7740cf77..d27878f26 100644 --- a/offapi/com/sun/star/embed/XTransactedObject.idl +++ b/offapi/com/sun/star/embed/XTransactedObject.idl @@ -46,7 +46,7 @@ //============================================================================ /** allows transacted access to an object. */ -interface XTransactedObject: com::sun::star::uno::XInterface +published interface XTransactedObject: com::sun::star::uno::XInterface { // ----------------------------------------------------------------------- /** commits the changes made for object. diff --git a/offapi/com/sun/star/embed/XTransactionBroadcaster.idl b/offapi/com/sun/star/embed/XTransactionBroadcaster.idl index 6a32df7d3..29e86ce96 100644 --- a/offapi/com/sun/star/embed/XTransactionBroadcaster.idl +++ b/offapi/com/sun/star/embed/XTransactionBroadcaster.idl @@ -44,7 +44,7 @@ module com { module sun { module star { module embed { /** broadcasts messege in case transacted object is commited or reverted. */ -interface XTransactionBroadcaster: com::sun::star::uno::XInterface +published interface XTransactionBroadcaster: com::sun::star::uno::XInterface { //------------------------------------------------------------------------ /** adds the specified listener to receive events about commits and diff --git a/offapi/com/sun/star/embed/XTransactionListener.idl b/offapi/com/sun/star/embed/XTransactionListener.idl index 49c9374a0..57b172574 100644 --- a/offapi/com/sun/star/embed/XTransactionListener.idl +++ b/offapi/com/sun/star/embed/XTransactionListener.idl @@ -48,7 +48,7 @@ module com { module sun { module star { module embed { /** makes it possible to receive events when a transacted object is commited or reverted. */ -interface XTransactionListener: com::sun::star::lang::XEventListener +published interface XTransactionListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------ /** is called just before the object is commited. diff --git a/offapi/com/sun/star/embed/XTransferableSupplier.idl b/offapi/com/sun/star/embed/XTransferableSupplier.idl index fbfa56f52..1a5360aba 100644 --- a/offapi/com/sun/star/embed/XTransferableSupplier.idl +++ b/offapi/com/sun/star/embed/XTransferableSupplier.idl @@ -40,7 +40,7 @@ <type scope="com::sun::star::datatransfer">XTransferable</type> implementation from the object. */ -interface XTransferableSupplier: com::sun::star::uno::XInterface +published interface XTransferableSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------ /** allows to get access to diff --git a/offapi/com/sun/star/embed/XVisualObject.idl b/offapi/com/sun/star/embed/XVisualObject.idl index bd64941d9..913507d42 100644 --- a/offapi/com/sun/star/embed/XVisualObject.idl +++ b/offapi/com/sun/star/embed/XVisualObject.idl @@ -55,7 +55,7 @@ //============================================================================= /** represents common visualisation functionality for embedded objects. */ -interface XVisualObject: ::com::sun::star::uno::XInterface +published interface XVisualObject: ::com::sun::star::uno::XInterface { //------------------------------------------------------------------------- /** sets the size of object's visual area. diff --git a/offapi/com/sun/star/embed/XWindowSupplier.idl b/offapi/com/sun/star/embed/XWindowSupplier.idl index 1f0847955..2cabfaada 100644 --- a/offapi/com/sun/star/embed/XWindowSupplier.idl +++ b/offapi/com/sun/star/embed/XWindowSupplier.idl @@ -38,7 +38,7 @@ //============================================================================ /** provides access to a vcl window implementation. */ -interface XWindowSupplier: com::sun::star::uno::XInterface +published interface XWindowSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------ /** allows to get access to a vcl window implementation. diff --git a/offapi/com/sun/star/embed/makefile.mk b/offapi/com/sun/star/embed/makefile.mk index 404f14cea..349017452 100644 --- a/offapi/com/sun/star/embed/makefile.mk +++ b/offapi/com/sun/star/embed/makefile.mk @@ -57,6 +57,7 @@ IDLFILES=\ Storage.idl\ StorageStream.idl\ StorageFactory.idl\ + StorageFormats.idl\ VerbAttributes.idl\ VisualRepresentation.idl\ VerbDescriptor.idl\ diff --git a/offapi/com/sun/star/i18n/TransliterationModulesExtra.idl b/offapi/com/sun/star/i18n/TransliterationModulesExtra.idl new file mode 100644 index 000000000..142cfc612 --- /dev/null +++ b/offapi/com/sun/star/i18n/TransliterationModulesExtra.idl @@ -0,0 +1,76 @@ +/************************************************************************* + * + * 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: TransliterationModulesExtra.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_i18n_TransliterationModulesExtra_idl__ +#define __com_sun_star_i18n_TransliterationModulesExtra_idl__ + +//============================================================================= + +module com { module sun { module star { module i18n { + +//============================================================================= + +/** Extra transliteration module enumeration to use with + <member>XTransliteration::loadModule()</member> + + The values used in this group need to be different from the ones in + <type>TransliterationModules</type> and <type>TransliterationModulesNew</type>! + */ + + +// using a constant group instead of enum leaves room for additional values later on... +constants TransliterationModulesExtra +{ + /** The first character of the sentence is put in upper case + */ + const short SENTENCE_CASE = 200; + + //------------------------------------------------------------------------- + + /** The first character of the word is put in upper case. + * This one is part + */ + const short TITLE_CASE = 201; + + //------------------------------------------------------------------------- + + /** All characters of the word are to change their case from small letters + * to capital letters and vice versa. + */ + const short TOGGLE_CASE = 202; + + //------------------------------------------------------------------------- + + const long END_OF_MODULE = 0; +}; + +//============================================================================= +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/i18n/makefile.mk b/offapi/com/sun/star/i18n/makefile.mk index 71907e42c..7d861fa14 100644 --- a/offapi/com/sun/star/i18n/makefile.mk +++ b/offapi/com/sun/star/i18n/makefile.mk @@ -94,6 +94,7 @@ IDLFILES=\ Transliteration.idl \ TransliterationModules.idl \ TransliterationModulesNew.idl \ + TransliterationModulesExtra.idl \ TransliterationType.idl \ UnicodeScript.idl \ UnicodeType.idl \ diff --git a/offapi/com/sun/star/packages/NoEncryptionException.idl b/offapi/com/sun/star/packages/NoEncryptionException.idl index 2086b4678..711ebf76a 100644 --- a/offapi/com/sun/star/packages/NoEncryptionException.idl +++ b/offapi/com/sun/star/packages/NoEncryptionException.idl @@ -41,7 +41,7 @@ // DocMerge from xml: exception com::sun::star::packages::NoEncryptionException /** This exception can be thrown in case object is not encrypted one as expected. */ -exception NoEncryptionException: com::sun::star::uno::Exception +published exception NoEncryptionException: com::sun::star::uno::Exception { }; diff --git a/offapi/com/sun/star/packages/NoRawFormatException.idl b/offapi/com/sun/star/packages/NoRawFormatException.idl index 78c121870..7795c2748 100644 --- a/offapi/com/sun/star/packages/NoRawFormatException.idl +++ b/offapi/com/sun/star/packages/NoRawFormatException.idl @@ -42,7 +42,7 @@ /** This exception can be thrown in case provided stream is not a raw stream representing encrypted package stream. */ -exception NoRawFormatException: com::sun::star::io::IOException +published exception NoRawFormatException: com::sun::star::io::IOException { }; diff --git a/offapi/com/sun/star/packages/WrongPasswordException.idl b/offapi/com/sun/star/packages/WrongPasswordException.idl index a74e29d66..c37744c9d 100644 --- a/offapi/com/sun/star/packages/WrongPasswordException.idl +++ b/offapi/com/sun/star/packages/WrongPasswordException.idl @@ -41,7 +41,7 @@ // DocMerge from xml: exception com::sun::star::packages::WrongPasswordException /** This exception can be thrown in case wrong password was provided. */ -exception WrongPasswordException: com::sun::star::uno::Exception +published exception WrongPasswordException: com::sun::star::uno::Exception { }; diff --git a/offapi/com/sun/star/sdb/DataAccessDescriptor.idl b/offapi/com/sun/star/sdb/DataAccessDescriptor.idl index 519742e94..738818819 100644 --- a/offapi/com/sun/star/sdb/DataAccessDescriptor.idl +++ b/offapi/com/sun/star/sdb/DataAccessDescriptor.idl @@ -49,7 +49,7 @@ module com { module sun { module star { module sdb { /** descriptor for accessing basic data access objects. <p>Various components interacting with the database access world require to specify (or provide themself) an object - such as a query, a table, a result set, a connection to a data source, a column within a table, and so on.</br> + such as a query, a table, a result set, a connection to a data source, a column within a table, and so on.<br/> All of these objects are usually not specified with a single property, but with a set of properties, and for various objects, various (but not always different) properties are needed.<br/> The <code>DataAccessDescriptor</code> describes the super set of the properties for the most common @@ -199,7 +199,7 @@ published service DataAccessDescriptor has access to an already existent result set, it can pass it along for reusage. This is encouraged to increase performance.</p> - <p>The object will at least support the <type scope="com::sun::star::sdbc">ResultSet</type>.</p> + <p>The object will at least support the <type scope="com::sun::star::sdbc">ResultSet</type> service.</p> <p>Note that any superservices of <type scope="com::sun::star::sdbc">ResultSet</type> are also allowed. Especially, this member can denote an instance of the diff --git a/offapi/com/sun/star/sdb/RowSet.idl b/offapi/com/sun/star/sdb/RowSet.idl index 64dc1c807..2afa36cac 100644 --- a/offapi/com/sun/star/sdb/RowSet.idl +++ b/offapi/com/sun/star/sdb/RowSet.idl @@ -70,6 +70,7 @@ published interface XParametersSupplier; to approve the actions and to react on them. @see com::sun::star::sdb::RowChangeAction @see com::sun::star::sdb::RowChangeEvent + @see com::sun::star::sdb::RowsChangeEvent </p> <h3>Notifications</h3> @@ -97,7 +98,8 @@ published interface XParametersSupplier; <tr><td valign="top"><em>operation done</em></td> <td valign="top">When the operation is done, you get a notification about this. It may be a <member scope="com::sun::star::sdbc">XRowSetListener::cursorMoved</member> or a - <member scope="com::sun::star::sdbc">XRowSetListener::rowChanged</member> call. + <member scope="com::sun::star::sdbc">XRowSetListener::rowChanged</member> call or a + <member>XRowsChangeListener::rowsChanged</member> call. </td> </tr> <tr><td valign="top"><em>row state</em></td> @@ -121,39 +123,40 @@ published interface XParametersSupplier; <tr><td/><td><strong>approveCursorMove</strong></td><td><strong>approveRowChange</strong></td> <td><strong>column values</strong></td> <td><strong>cursorMoved</strong></td><td><strong>rowChanged</strong></td> + <td><strong>rowsChanged</strong></td> <td><strong>IsModified</strong></td><td><strong>IsNew</strong></td> <td><strong>RowCount</strong></td><td><strong>IsRowCountFinal</strong></td> </tr> <tr><td><type scope="com::sun::star::sdbc">XResultSet</type></td><td/><td/><td/><td/><td/><td/><td/><td/></tr> - <tr><td align="right"><em>next</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td> - <tr><td align="right"><em>beforeFirst</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td/></tr> - <tr><td align="right"><em>afterLast</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td></tr> - <tr><td align="right"><em>first</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td></tr> - <tr><td align="right"><em>last</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td></tr> - <tr><td align="right"><em>absolute</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td></tr> - <tr><td align="right"><em>relative</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td></tr> - <tr><td align="right"><em>previous</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td></tr> - <tr><td align="right"><em>refreshRow</em></td><td/><td/><td align="center">X</td><td/><td/><td align="center">X</td><td align="center">X</td><td/><td/></tr> - <tr><td align="right"><em>cancelRowUpdates</em></td><td/><td/><td align="center">X</td><td/><td/><td align="center">X</td><td/><td/><td/></tr> + <tr><td align="right"><em>next</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td> + <tr><td align="right"><em>beforeFirst</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td/><td align="center">X</td><td align="center">X</td><td/><td/></tr> + <tr><td align="right"><em>afterLast</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td></tr> + <tr><td align="right"><em>first</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td></tr> + <tr><td align="right"><em>last</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td></tr> + <tr><td align="right"><em>absolute</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td></tr> + <tr><td align="right"><em>relative</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td></tr> + <tr><td align="right"><em>previous</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td></tr> + <tr><td align="right"><em>refreshRow</em></td><td/><td/><td align="center">X</td><td/><td/><td/><td align="center">X</td><td align="center">X</td><td/><td/></tr> + <tr><td align="right"><em>cancelRowUpdates</em></td><td/><td/><td align="center">X</td><td/><td/><td/><td align="center">X</td><td/><td/><td/></tr> <tr><td><type scope="com::sun::star::sdbc">XResultSetUpdate</type></td><td/><td/><td/><td/><td/><td/><td/><td/></tr> - <tr><td align="right"><em>insertRow</em></td><td/><td align="center">X</td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td></tr> - <tr><td align="right"><em>updateRow</em></td><td/><td align="center">X</td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td/><td/></tr> - <tr><td align="right"><em>deleteRow</em></td><td/><td align="center">X</td><td/><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td></tr> - <tr><td align="right"><em>moveToInsertRow</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td/><td align="center">X</td><td align="center">X</td></tr> - <tr><td align="right"><em>moveToCurrentRow</em></td><td align="center">X</td><td/><td/><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td/></tr> + <tr><td align="right"><em>insertRow</em></td><td/><td align="center">X</td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td></tr> + <tr><td align="right"><em>updateRow</em></td><td/><td align="center">X</td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td/><td/><td/></tr> + <tr><td align="right"><em>deleteRow</em></td><td/><td align="center">X</td><td/><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td></tr> + <tr><td align="right"><em>moveToInsertRow</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td/><td/><td align="center">X</td><td align="center">X</td></tr> + <tr><td align="right"><em>moveToCurrentRow</em></td><td align="center">X</td><td/><td/><td align="center">X</td><td/><td/><td align="center">X</td><td align="center">X</td><td/><td/></tr> <tr><td><type scope="com::sun::star::sdbcx">XDeleteRows</type></td><td/><td/><td/><td/><td/><td/><td/><td/></tr> - <tr><td align="right"><em>deleteRows</em></td><td/><td align="center">X</td><td/><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td></tr> + <tr><td align="right"><em>deleteRows</em></td><td/><td align="center">X</td><td/><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td></tr> <tr><td><type scope="com::sun::star::sdbcx">XRowLocate</type></td><td/><td/><td/><td/><td/><td/><td/><td/></tr> - <tr><td align="right"><em>moveToBookmark</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td/></tr> - <tr><td align="right"><em>moveRelativeToBookmark</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td></tr> + <tr><td align="right"><em>moveToBookmark</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td/><td align="center">X</td><td align="center">X</td><td/><td/></tr> + <tr><td align="right"><em>moveRelativeToBookmark</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td></tr> </tr> </table> diff --git a/offapi/com/sun/star/sdb/RowsChangeEvent.idl b/offapi/com/sun/star/sdb/RowsChangeEvent.idl new file mode 100644 index 000000000..b94dc7474 --- /dev/null +++ b/offapi/com/sun/star/sdb/RowsChangeEvent.idl @@ -0,0 +1,52 @@ +/************************************************************************* + * + * 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: RowsChangeEvent.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_sdb_RowsChangeEvent_idl__ +#define __com_sun_star_sdb_RowsChangeEvent_idl__ + +#include <com/sun/star/sdb/RowChangeEvent.idl> + + module com { module sun { module star { module sdb { + + +/** indicates which rows have changed and the type of change action on the row set. + */ +struct RowsChangeEvent: com::sun::star::sdb::RowChangeEvent +{ + + sequence< any > Bookmarks; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdb/XRowsChangeBroadcaster.idl b/offapi/com/sun/star/sdb/XRowsChangeBroadcaster.idl new file mode 100644 index 000000000..0ef9fbc5b --- /dev/null +++ b/offapi/com/sun/star/sdb/XRowsChangeBroadcaster.idl @@ -0,0 +1,66 @@ +/************************************************************************* +* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +* +* Copyright 2008 by Sun Microsystems, Inc. +* +* OpenOffice.org - a multi-platform office productivity suite +* +* $RCSfile: code,v $ +* +* $Revision: 1.3 $ +* +* This file is part of OpenOffice.org. +* +* OpenOffice.org is free software: you can redistribute it and/or modify +* it under the terms of the GNU Lesser General Public License version 3 +* only, as published by the Free Software Foundation. +* +* OpenOffice.org is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +* GNU Lesser General Public License version 3 for more details +* (a copy is included in the LICENSE file that accompanied this code). +* +* You should have received a copy of the GNU Lesser General Public License +* version 3 along with OpenOffice.org. If not, see +* <http://www.openoffice.org/license.html> +* for a copy of the LGPLv3 License. +************************************************************************/ + +#ifndef __com_sun_star_sdb_XRowsChangeBroadcaster_idl__ +#define __com_sun_star_sdb_XRowsChangeBroadcaster_idl__ + +#include <com/sun/star/uno/XInterface.idl> + +//============================================================================= + +module com { module sun { module star { module sdb { + +interface XRowsChangeListener; + +//============================================================================= + +/** broadcasts changes in the <code>RowSet</code> supplied by a component + + @see XRowSetSupplier + @see XRowsChangeListener + @since OOo 3.3 + */ +interface XRowsChangeBroadcaster +{ + /** adds a listener to be notified when the <code>RowSet</code> supplied by the component changes. + */ + void addRowsChangeListener( [in] XRowsChangeListener listener ); + + /** removes a previously added listener. + */ + void removeRowsChangeListener( [in] XRowsChangeListener listener ); +}; + +//============================================================================= + +}; }; }; }; + +//============================================================================= + +#endif diff --git a/offapi/com/sun/star/sdb/XRowsChangeListener.idl b/offapi/com/sun/star/sdb/XRowsChangeListener.idl new file mode 100644 index 000000000..e6b0e6305 --- /dev/null +++ b/offapi/com/sun/star/sdb/XRowsChangeListener.idl @@ -0,0 +1,60 @@ +/************************************************************************* + * + * 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: XRowsChangeListener.idl,v $ + * $Revision: 1.11 $ + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_sdb_XRowsChangeListener_idl__ +#define __com_sun_star_sdb_XRowsChangeListener_idl__ + +#ifndef __com_sun_star_lang_XEventListener_idl__ +#include <com/sun/star/lang/XEventListener.idl> +#endif +#include <com/sun/star/sdb/RowsChangeEvent.idl> + + module com { module sun { module star { module sdb { + + +/** is used for receiving "rowsChanged" events + posted by, for example, a rowset. + */ +interface XRowsChangeListener: com::sun::star::lang::XEventListener +{ + + /** is called when rows are inserted, updated, or deleted. + @param event + contains information about the event + */ + [oneway] void rowsChanged([in]com::sun::star::sdb::RowsChangeEvent event); +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdb/XSingleSelectQueryAnalyzer.idl b/offapi/com/sun/star/sdb/XSingleSelectQueryAnalyzer.idl index 8a55d97b6..ee764cc9e 100644 --- a/offapi/com/sun/star/sdb/XSingleSelectQueryAnalyzer.idl +++ b/offapi/com/sun/star/sdb/XSingleSelectQueryAnalyzer.idl @@ -219,6 +219,36 @@ interface XSingleSelectQueryAnalyzer : com::sun::star::uno::XInterface */ string getQueryWithSubstitution() raises (com::sun::star::sdbc::SQLException); + + /** sets a new query for the composer, which may be expanded by filters, group by, having + and sort criteria. + @param Command + is the command which should be executed, the type of command depends + on the CommandType. + + <p>In case of a <member>CommandType</member> of <member>CommandType::COMMAND</member>, + means in case the <member>Command</member> specifies an SQL statement, the inherited + <member scope="com::sun::star::sdbc">RowSet::EscapeProcessing</member> + becomes relevant:<br/> + It then can be to used to specify whether the SQL statement should be analyzed on the + client side before sending it to the database server.<br/> + The default value for <member scope="com::sun::star::sdbc">RowSet::EscapeProcessing</member> + is <TRUE/>. By switching it to <FALSE/>, you can pass backend-specific SQL statements, + which are not standard SQL, to your database.</p> + + @see com::sun::star::sdb::CommandType + @see com::sun::star::sdbc::RowSet::EscapeProcessing + @param CommandType + is the type of the command. + @see com::sun::star::sdb::CommandType + @throws com::sun::star::sdbc::SQLException + if a database access error occurs + or the statement isn't a single select statement + or the statement isn't valid + or the statement can not be parsed. + */ + void setCommand([in] string Command ,[in] long CommandType) + raises (com::sun::star::sdbc::SQLException); }; //============================================================================= diff --git a/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl b/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl index f1bfb722a..c11938c11 100644 --- a/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl +++ b/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl @@ -96,14 +96,16 @@ interface XSingleSelectQueryComposer: XSingleSelectQueryAnalyzer The value property must be supported by the <type scope="com::sun::star::sdb">DataColumn</type>. @param column the column which is used to create a filter - @paran andCriteria + @param andCriteria If <TRUE/> the filter condition will be appended as an AND condition, otherwise the new filter condition will be appended as OR criteria. E.g. (xx AND bb AND cc) OR newCriteria + @param filterOperator + The operator used, is defined by <type scope="com::sun::star::sdb">SQLFilterOperator</type>. @throws com::sun::star::sdbc::SQLException if a database access error occurs. */ - void appendFilterByColumn([in] com::sun::star::beans::XPropertySet column,[in] boolean andCriteria) + void appendFilterByColumn([in] com::sun::star::beans::XPropertySet column,[in] boolean andCriteria,[in] long filterOperator) raises (com::sun::star::sdbc::SQLException); //------------------------------------------------------------------------- @@ -170,14 +172,16 @@ interface XSingleSelectQueryComposer: XSingleSelectQueryAnalyzer providing the name and the value for the filter. @param column the column which is used to create a filter - @paran andCriteria + @param andCriteria If <TRUE/> the filter condition will be appended as an AND condition, otherwise the new filter condition will be appended as OR criteria. E.g. (xx AND bb AND cc) OR newCriteria + @param filterOperator + The operator used, is defined by <type scope="com::sun::star::sdb">SQLFilterOperator</type>. @throws com::sun::star::sdbc::SQLException if a database access error occurs. */ - void appendHavingClauseByColumn([in] com::sun::star::beans::XPropertySet column,[in] boolean andCriteria) + void appendHavingClauseByColumn([in] com::sun::star::beans::XPropertySet column,[in] boolean andCriteria,[in] long filterOperator) raises (com::sun::star::sdbc::SQLException); //------------------------------------------------------------------------- diff --git a/offapi/com/sun/star/sdb/makefile.mk b/offapi/com/sun/star/sdb/makefile.mk index 975bf03e7..f095f338b 100644 --- a/offapi/com/sun/star/sdb/makefile.mk +++ b/offapi/com/sun/star/sdb/makefile.mk @@ -90,6 +90,7 @@ IDLFILES=\ ResultSet.idl \ RowChangeAction.idl \ RowChangeEvent.idl \ + RowsChangeEvent.idl \ RowSet.idl \ RowSetVetoException.idl \ SingleSelectQueryAnalyzer.idl \ @@ -128,6 +129,8 @@ IDLFILES=\ XRowSetApproveListener.idl \ XRowSetChangeBroadcaster.idl \ XRowSetChangeListener.idl \ + XRowsChangeBroadcaster.idl \ + XRowsChangeListener.idl \ XRowSetSupplier.idl \ XSingleSelectQueryAnalyzer.idl \ XSingleSelectQueryComposer.idl \ diff --git a/offapi/com/sun/star/sdbc/XGeneratedResultSet.idl b/offapi/com/sun/star/sdbc/XGeneratedResultSet.idl index 52a9d17ab..d9382cb6b 100644 --- a/offapi/com/sun/star/sdbc/XGeneratedResultSet.idl +++ b/offapi/com/sun/star/sdbc/XGeneratedResultSet.idl @@ -41,9 +41,9 @@ /** provides a result set which gives access to automatically generated values after a new row was inserted. - The relative order of columns in the result set returned by getGeneratedValues must be the same as the relative order - of the same columns as returned when executing a "SELECT * FROM table". This ensures that clients of this interface - can reliably fetch the column values. + <p>The relative order of columns in the result set returned by <member>getGeneratedValues</member> must be the same + as the relative order of the same columns as returned when executing a "SELECT * FROM table". This ensures that + clients of this interface can reliably fetch the column values.</p> @see com::sun::star::sdbc::Statement @see com::sun::star::sdbc::PreparedStatement diff --git a/offapi/com/sun/star/sdbc/XRowSetListener.idl b/offapi/com/sun/star/sdbc/XRowSetListener.idl index 6eb2ff0ea..b2a68cd3f 100644 --- a/offapi/com/sun/star/sdbc/XRowSetListener.idl +++ b/offapi/com/sun/star/sdbc/XRowSetListener.idl @@ -50,6 +50,8 @@ published interface XRowSetListener: com::sun::star::lang::XEventListener /** is called when a row is inserted, updated, or deleted. @param event contains information about the event + @deprecated + @see com.sun.star.sdb.XRowsChangeListener */ [oneway] void rowChanged([in]com::sun::star::lang::EventObject event); //------------------------------------------------------------------------- diff --git a/offapi/com/sun/star/sheet/XExternalDocLink.idl b/offapi/com/sun/star/sheet/XExternalDocLink.idl index 0e1964ffe..2ca038f38 100644 --- a/offapi/com/sun/star/sheet/XExternalDocLink.idl +++ b/offapi/com/sun/star/sheet/XExternalDocLink.idl @@ -60,9 +60,16 @@ interface XExternalDocLink @param aSheetName sheet name + @param DynamicCache specify whether or not the cache can grow when + non-cached regions are queried. If <true/>, querying a non-cached + cell in this sheet cache will allow Calc to try to access the source + document to fetch the value in first access. If <false/>, the source + document will not be accessed, and the non-cached regions are treated + as empty cells. + @return com::sun::star::sheet::XExternalSheetCache sheet cache instance */ - com::sun::star::sheet::XExternalSheetCache addSheetCache( [in] string aSheetName ); + com::sun::star::sheet::XExternalSheetCache addSheetCache( [in] string aSheetName, [in] boolean DynamicCache ); //------------------------------------------------------------------------- diff --git a/offapi/com/sun/star/text/TextFrame.idl b/offapi/com/sun/star/text/TextFrame.idl index d723e2f12..a3af145e6 100644..100755 --- a/offapi/com/sun/star/text/TextFrame.idl +++ b/offapi/com/sun/star/text/TextFrame.idl @@ -112,6 +112,13 @@ published service TextFrame */ [property] short SizeType; //------------------------------------------------------------------------- + /** determines if the text frame should be editable in a read-only document. + (This is usually used in forms.) + + */ + [optional, property] boolean EditInReadonly; + + //------------------------------------------------------------------------- /** determines the interpretation of the width and relative width properties. @@ -119,12 +126,14 @@ published service TextFrame @since OOo 2.4 */ [optional, property] short WidthType; + //----------------------------------------------------------------------------- /** contains the writing direction, as represented by the <type scope="com::sun::star::text">WritingMode2</type> constants */ [optional, property] short WritingMode; - + + //----------------------------------------------------------------------------- /** controls, if the frame follows the text flow or can leave its layout environment <p>If set, the frame follows the text flow and doesn't leaves the layout diff --git a/offapi/com/sun/star/ui/UIElement.idl b/offapi/com/sun/star/ui/UIElement.idl index a26fd5d08..6572c7e16 100644 --- a/offapi/com/sun/star/ui/UIElement.idl +++ b/offapi/com/sun/star/ui/UIElement.idl @@ -28,10 +28,6 @@ #ifndef __com_sun_star_ui_UIElement_idl__ #define __com_sun_star_ui_UIElement_idl__ -#ifndef __com_sun_star_frame_XFrame_idl__ -#include <com/sun/star/frame/XFrame.idl> -#endif - #ifndef __com_sun_star_ui_XUIElement_idl__ #include <com/sun/star/ui/XUIElement.idl> #endif @@ -40,10 +36,6 @@ #include <com/sun/star/beans/XPropertySet.idl> #endif -#ifndef __com_sun_star_ui_UIElementType_idl__ -#include <com/sun/star/ui/UIElementType.idl> -#endif - #ifndef __com_sun_star_lang_XInitialization_idl__ #include <com/sun/star/lang/XInitialization.idl> #endif @@ -97,7 +89,7 @@ service UIElement @see com::sun::star::ui::UIElementFactoryManager; @see com::sun::star::ui::UIElementFactory */ - interface ::com::sun::star::lang::XInitialization; + [optional] interface ::com::sun::star::lang::XInitialization; /** used to notify an implementation that it needs to update its visual representation. @@ -106,31 +98,11 @@ service UIElement representation. It is up to the implementation if it ignores notifications. </p> */ - interface com::sun::star::util::XUpdatable; + [optional] interface com::sun::star::util::XUpdatable; /** controls the life-time of the object. */ interface ::com::sun::star::lang::XComponent; - - /** determines the frame to which this element is bound to. - - <p> - The life time of a user interface element does not explicitly depend on the - frame itself but on the visible component attached to the frame. It is possible - to exchange the visible component of a frame and that will lead to the end of - life of all user interface elements. - */ - [readonly, property] com::sun::star::frame::XFrame Frame; - - /** a resource URL which is a unique identifier of a user interface element. - */ - [readonly, property] string ResourceURL; - - /** determines the real type of the user interface element. - - @see UIElementType - */ - [readonly, property] short Type; }; }; }; }; }; diff --git a/offapi/com/sun/star/ui/UIElementType.idl b/offapi/com/sun/star/ui/UIElementType.idl index 0a635c9f3..f57a17ee7 100644 --- a/offapi/com/sun/star/ui/UIElementType.idl +++ b/offapi/com/sun/star/ui/UIElementType.idl @@ -71,11 +71,16 @@ constants UIElementType /** specifies a floating window, which can also be docked. */ const short PROGRESSBAR = 6; - + + //------------------------------------------------------------------------- + /** specifies a tool panel + */ + const short TOOLPANEL = 7; + //------------------------------------------------------------------------- /** specifies the number of constants. */ - const short COUNT = 7; + const short COUNT = 8; }; }; }; }; }; diff --git a/offapi/com/sun/star/ui/XToolPanel.idl b/offapi/com/sun/star/ui/XToolPanel.idl new file mode 100644 index 000000000..fb10ddece --- /dev/null +++ b/offapi/com/sun/star/ui/XToolPanel.idl @@ -0,0 +1,64 @@ +/************************************************************************* + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * +************************************************************************/ + +#ifndef __com_sun_star_ui_XToolPanel_idl__ +#define __com_sun_star_ui_XToolPanel_idl__ + +#include <com/sun/star/awt/XWindow.idl> +#include <com/sun/star/accessibility/XAccessible.idl> + +//============================================================================= + +module com { module sun { module star { module ui { + +//============================================================================= + +/** describes the basic interface to be implemented by a tool panel + */ +interface XToolPanel +{ + /** provides access to the tool panel's main window. + + <p>It is allowed for an implementation to return <NULL/> here, but in this case some functionality, for instance + automatic positioning of the tool panel, might not be available, and must be implemented by the tool panel itself.</p> + */ + [attribute, readonly] ::com::sun::star::awt::XWindow Window; + + /** creates the root of the Accessibility object tree for the tool panel + @param ParentAccessible + the parent object in the Accessibility object tree + */ + ::com::sun::star::accessibility::XAccessible + createAccessible( [in] ::com::sun::star::accessibility::XAccessible ParentAccessible ); +}; + +//============================================================================= + +}; }; }; }; + +//============================================================================= + +#endif diff --git a/offapi/com/sun/star/ui/XUIElement.idl b/offapi/com/sun/star/ui/XUIElement.idl index 0ab38b36d..63467eb67 100644 --- a/offapi/com/sun/star/ui/XUIElement.idl +++ b/offapi/com/sun/star/ui/XUIElement.idl @@ -36,6 +36,10 @@ #include <com/sun/star/beans/XPropertySet.idl> #endif +#ifndef __com_sun_star_frame_XFrame_idl__ +#include <com/sun/star/frame/XFrame.idl> +#endif + //============================================================================= module com { module sun { module star { module ui { @@ -64,7 +68,26 @@ interface XUIElement : com::sun::star::uno::XInterface a special purpose interface which depends on the type of the user interface element. */ - com::sun::star::uno::XInterface getRealInterface(); + ::com::sun::star::uno::XInterface getRealInterface(); + + /** determines the document frame to which this element is bound to. + + <p>The life time of a user interface element does not explicitly depend on the + frame itself but on the visible component attached to the frame. It is possible + to exchange the visible component of a frame and that will lead to the end of + life of all user interface elements.</p> + */ + [readonly, attribute] ::com::sun::star::frame::XFrame Frame; + + /** a resource URL which is a unique identifier of a user interface element. + */ + [readonly, attribute] string ResourceURL; + + /** determines the type of the user interface element. + + @see UIElementType + */ + [readonly, attribute] short Type; }; }; }; }; }; diff --git a/offapi/com/sun/star/ui/XUIElementFactory.idl b/offapi/com/sun/star/ui/XUIElementFactory.idl index 24a014741..4d39e73b3 100644 --- a/offapi/com/sun/star/ui/XUIElementFactory.idl +++ b/offapi/com/sun/star/ui/XUIElementFactory.idl @@ -97,6 +97,11 @@ interface XUIElementFactory : ::com::sun::star::uno::XInterface configuration manager. This argument is <b>mandatory</b> to have a working configurable user interface element instance. </li> + <li><b>ParentWindow</b><br/> + specifies a parent window to use for the window(s) representing + the UI element. Depending on the concrete UI element type, this parameter + might be required or ignored by an implementation. + </li> <li><b>Persistent</b><br>specifies if changes to a configurable user interface element should be persistent. This is an optional argument. The default value is <TRUE/>.</li> diff --git a/offapi/com/sun/star/ui/dialogs/Wizard.idl b/offapi/com/sun/star/ui/dialogs/Wizard.idl new file mode 100644 index 000000000..b3237be3f --- /dev/null +++ b/offapi/com/sun/star/ui/dialogs/Wizard.idl @@ -0,0 +1,75 @@ +/************************************************************************* + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_ui_dialogs_Wizard_idl__ +#define __com_sun_star_ui_dialogs_Wizard_idl__ + +#include <com/sun/star/ui/dialogs/XWizard.idl> +#include <com/sun/star/lang/IllegalArgumentException.idl> + +//================================================================================================================== + +module com { module sun { module star { module ui { module dialogs { + +interface XWizardController; + +//================================================================================================================== + +/** provides a framework for implementing a wizard dialog. + */ +service Wizard : XWizard +{ + /** creates a wizard with a single execution path + @param PageIds + the IDs of the pages which constitute the execution path. IDs must be in ascending order. + */ + createSinglePathWizard( + [in] sequence< short > PageIds, + [in] XWizardController Controller + ) + raises ( ::com::sun::star::lang::IllegalArgumentException + ); + + /** creates a wizard with a multiple possible execution paths + + @param PageIds + the IDs of the pages which constitute the execution paths. IDs in each path must be in ascending order. + */ + createMultiplePathsWizard( + [in] sequence< sequence< short > > PageIds, + [in] XWizardController Controller + ) + raises ( ::com::sun::star::lang::IllegalArgumentException + ); +}; + +//================================================================================================================== + +}; }; }; }; }; + +//================================================================================================================== + +#endif diff --git a/offapi/com/sun/star/ui/dialogs/WizardButton.idl b/offapi/com/sun/star/ui/dialogs/WizardButton.idl new file mode 100644 index 000000000..acba104e3 --- /dev/null +++ b/offapi/com/sun/star/ui/dialogs/WizardButton.idl @@ -0,0 +1,60 @@ +/************************************************************************* + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_ui_dialogs_WizardButton_idl__ +#define __com_sun_star_ui_dialogs_WizardButton_idl__ + +//================================================================================================================== + +module com { module sun { module star { module ui { module dialogs { + +//================================================================================================================== + +/** denotes the buttons found in a <type>Wizard</type> + */ +constants WizardButton +{ + /// denotes none of the buttons in the wizard + const short NONE = 0; + /// denotes the button used to travel forward through the wizard + const short NEXT = 1; + /// denotes the button used to travel backward through the wizard + const short PREVIOUS = 2; + /// denotes the button used to finish the wizard + const short FINISH = 3; + /// denotes the button used to cancel the wizard + const short CANCEL = 4; + /// denotes the button used to request help + const short HELP = 5; +}; + +//================================================================================================================== + +}; }; }; }; }; + +//================================================================================================================== + +#endif diff --git a/offapi/com/sun/star/ui/dialogs/WizardTravelType.idl b/offapi/com/sun/star/ui/dialogs/WizardTravelType.idl new file mode 100644 index 000000000..d46021266 --- /dev/null +++ b/offapi/com/sun/star/ui/dialogs/WizardTravelType.idl @@ -0,0 +1,54 @@ +/************************************************************************* + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_ui_dialogs_WizardTravelType_idl__ +#define __com_sun_star_ui_dialogs_WizardTravelType_idl__ + +//================================================================================================================== + +module com { module sun { module star { module ui { module dialogs { + +//================================================================================================================== + +/** denotes ways to leave a <type>Wizard</type>'s page + */ +constants WizardTravelType +{ + /// indicates the wizard page is left due to forward traveling through the wizard + const short FORWARD = 1; + /// indicates the wizard page is left due to backward traveling through the wizard + const short BACKWARD = 2; + /// indicates the wizard page is left since the wizard is about to be finished + const short FINISH = 3; +}; + +//================================================================================================================== + +}; }; }; }; }; + +//================================================================================================================== + +#endif diff --git a/offapi/com/sun/star/ui/dialogs/XWizard.idl b/offapi/com/sun/star/ui/dialogs/XWizard.idl new file mode 100644 index 000000000..445f7bbf2 --- /dev/null +++ b/offapi/com/sun/star/ui/dialogs/XWizard.idl @@ -0,0 +1,228 @@ +/************************************************************************* + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_ui_dialogs_XWizard_idl__ +#define __com_sun_star_ui_dialogs_XWizard_idl__ + +#include <com/sun/star/ui/dialogs/XExecutableDialog.idl> +#include <com/sun/star/util/InvalidStateException.idl> +#include <com/sun/star/container/NoSuchElementException.idl> +#include <com/sun/star/awt/XWindow.idl> + +//================================================================================================================== +module com { module sun { module star { module ui { module dialogs { + +//================================================================================================================== + +interface XWizardPage; + +/** is the main interface implemented by the <type>Wizard</type> services. + + <p>A wizard is a dialog which guides the user through a number of tasks (usually input of data), which the user can + accomplish either sequentially or out-of-order. For this, a wizard is comprised of a number of tab pages, + each page representing a single <em>step</em>.</p> + + <p>Sequential navigation in a wizard is done via a <em>Next</em> and a <em>Back</em> button. Non-sequential navigation + is done via a roadmap, which is displayed on the left hand side of the wizard dialog, lists all available + steps, and allows jumping to a certain step (where the creator of the wizard can restrict the available steps + depending on the current situation in the wizard, see below).</p> + + <p>A sequence of steps in a wizard dialog is called a <em>path</em>. A given wizard can support one or multiple paths, + which are declared at the time of construction of the wizard.</p> + + <p>In the simplest case, where the wizard supports only one path, all available steps are displayed in the roadmap, + and the user can simply travel through them as desired.</p> + + <p>If the wizard is more complex, and supports multiple paths, things become more complicated. In a given situation + of the wizard, where the user is at step <em>k</em> of the current path, the <em>potential</em> or <em>conflicting</em> + paths are those whose first <em>k</em> steps are the same as in the current path. Obviously, there's at least one + potential path in every situation: the current one. If there is more than one, then the future steps in the dialog + are not finally decided. In such a case, the roadmap will display future steps up to the point where the potential + paths diverge, and then an item <quot><code>...</code></quot> indicating that the order of steps is undecided.</p> + + <p>An <type>XWizardController</type> can declare a certain path as active path by calling the <member>activatePath</member> + method. Usually, this is done depending on user input. For instance, your wizard could have radio buttons on the + first page which effectively decide about which path to take in the wizard.</p> + + <p>Single steps in the wizard can be freely enabled and disabled, using the <member>enablePage</member> method. + Disabled pages are skipped during sequential traveling, and not selectable in the roadmap.</p> + + <p>The state of the <em>Next</em> button in the dialog will be automatically maintained in most situations, + depending on the results of calls to the <member>XWizardController::canAdvance</member> and <member>XWizardPage::canAdvance</member> + methods. More sophisticated wizard logic, however, will need manual calls to the <member>enableButton</member> method. + Also, the <em>Finish</em> button needs to be maintained by the wizard's controller, too, as it cannot be decided + generically in which situations it should be enabled or disabled.</p> + + @see XWizardController + @see XWizardPage + */ +interface XWizard +{ + interface XExecutableDialog; + + /** is the help URL of the wizard's main window. + */ + [attribute] string HelpURL; + + [attribute, readonly] ::com::sun::star::awt::XWindow + DialogWindow; + + /** provides access to the current page of the wizard + */ + XWizardPage + getCurrentPage(); + + /** enables or disables a certain button in the wizard + + <p>Normally, you will want to use this method for the <em>Finish</em> button only: The <em>Next</em> + and <em>Back</em> buttons are usually maintained automatically, the <em>Help</em> and <em>Cancel</em> + buttons are unlikely to ever being disabled.</p> + + @param WizardButton + denotes the button to enable or disable, as one of the <type>WizardButton</type> constants. Must not be + <member>WizardButton::NONE</member>. + @param Enable + specifies whether the button should be enabled (<TRUE/>) or disabled (<FALSE/>) + */ + void enableButton( [in] short WizardButton, [in] boolean Enable ); + + /** sets a button in the wizard as default button + + <p>In general, the default button in a wizard is the one which is activated when the user presses + the <em>return</em> key while the focus is in a control which does not handle this key itself (such as + ordinary input controls).</p> + + <p>You can use this method, for instance, to make the <em>Next</em> button the default button on all pages + except the last one, where <em>Finish</em> should be defaulted.</p> + */ + void setDefaultButton( [in] short WizardButton ); + + /** travels to the next page, if possible + + <p>Calling this method is equivalent to the user pressing the <em>Next</em> button in the wizard. Consequently, + the method will fail if in the current state of the wizard, it is not allowed to advance to a next page.</p> + */ + boolean travelNext(); + + /** travels to the next page, if possible + + <p>Calling this method is equivalent to the user pressing the <em>Back</em> button in the wizard.</p> + */ + boolean travelPrevious(); + + /** enables or disables the given page + + <p>You can use this method when not all pages of your wizard are necessarily needed in all cases. For instance, + assume that your first wizard page contains a check box, which the user can check to enter additional data. + If you place this data on the second page, then you will want to enable this second page if and only if the + checkbox is checked.</p> + + <p>If a page is disabled, it can reached neither by clicking the respective item in the wizard's roadmap, + nor by sequential traveling. Still, the page's item is displayed in the roadmap, though disabled.</p> + + @throws ::com::sun::star::container::NoSuchElementException + if there is no page with the given ID + @throws ::com::sun::star::util::InvalidStateException + if the page shall be disabled, but is active currently. + */ + void enablePage( [in] short PageID, [in] boolean Enable ) + raises ( ::com::sun::star::container::NoSuchElementException + , ::com::sun::star::util::InvalidStateException ); + + /** updates the wizard elements which are related to traveling. + + <p>For instance, the <em>Next</em> button is disabled if the current page's <member>XWizardPage::canAdvance</member> + method returns <FALSE/>.</p> + + <p>You usually call this method from within a wizard page whose state changed in a way that it affects the + user's ability to reach other pages.</p> + */ + void updateTravelUI(); + + /** advances to the given page, if possible. + + <p>Calling this method is equivalent to the user repeatedly pressing the <em>Next</em> button, until the + given page is reached. Consequently, the method will fail if one of the intermediate pages does not allow + advancing to the next page.</p> + */ + boolean advanceTo( [in] short PageId ); + + /** goes back to the given page, if possible. + + <p>Calling this method is equivalent to the user repeatedly pressing the <em>Back</em> button, until the + given page is reached.</p> + */ + boolean goBackTo( [in] short PageId ); + + /** activates a path + + <p>If the wizard has been created with multiple paths of control flow, then this method allows switching to + another path.</p> + + <p>You can only activate a path which shares the first <code>k</code> pages with the path + which is previously active (if any), where <code>k</code> is the index of the current page within the current + path.</p> + + <p><strong>Example</strong>: Say you have paths, <code>(0,1,2,5)</code> and <code>(0,1,4,5)</code> (with + the numbers denoting page IDs). This means that after page <code>1</code>, you either continue with page + <code>2</code> or state <code>4</code>,and after this, you finish in state <code>5</code>.<br/> + Now if the first path is active, and your current state is <code>1</code>, then you can easily switch to the + second path, since both paths start with <code>(0,1)</code>.<br/> + However, if your current state is <code>2</code>, then you can not switch to the second path anymore.</p> + + @param PathIndex + the index of the path, as used in the <member>Wizard::createMultiplePathsWizard</member> constructor. + @param Final + <p>If <TRUE/>, the path will be completely activated, even if it is a conflicting path (i.e. there is another + path which shares the first <code>k</code> states with the to-be-activated path.)</p> + + <p>If <FALSE/>, then the new path is checked for conflicts with other paths. If such conflicts exists, the path + is not completely activated, but only up to the point where it does <em>not</em> conflict.</p> + + <p>In this latter case, you need another activatePath method (usually triggered by the user doing some decisions + and entering some data on the reachable pages) before the wizard can actually be finished.</p> + + <p>With the paths in the example above, if you activate the second path, then only steps <code>0</code> and + <code>1</code> are activated, since they are common to both paths. Steps <code>2</code>, <code>4</code>, + and <code>5</code> are not reachable, yet.</p> + + @throws ::com::sun::star::container::NoSuchElementException + if there is no path with the given index + @throws ::com::sun::star::util::InvalidStateException + if the path cannot be activated in the current state of the wizard. + */ + void activatePath( [in] short PathIndex, [in] boolean Final ) + raises ( ::com::sun::star::container::NoSuchElementException + , ::com::sun::star::util::InvalidStateException ); +}; + +//================================================================================================================== + +}; }; }; }; }; + +//================================================================================================================== + +#endif diff --git a/offapi/com/sun/star/ui/dialogs/XWizardController.idl b/offapi/com/sun/star/ui/dialogs/XWizardController.idl new file mode 100644 index 000000000..52a245422 --- /dev/null +++ b/offapi/com/sun/star/ui/dialogs/XWizardController.idl @@ -0,0 +1,85 @@ +/************************************************************************* + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_ui_dialogs_XWizardController_idl__ +#define __com_sun_star_ui_dialogs_XWizardController_idl__ + +#include <com/sun/star/ui/dialogs/XWizardPage.idl> + +//================================================================================================================== + +module com { module sun { module star { module ui { module dialogs { + +//================================================================================================================== + +/** is the interface of a client-provided controller of a custom <type>Wizard</type>. + */ +interface XWizardController +{ + /** creates a page + + <p>Wizard pages are created on demand, when the respective page is reached during traveling through the + wizard. Effectively, this means the method is called at most once for each possible page ID.</p> + + @param ParentWindow + the parent window to use for the page window + @param PageId + the ID of the page. + @return + the requested page. + */ + XWizardPage createPage( [in] ::com::sun::star::awt::XWindow ParentWindow, [in] short PageId ); + + /** provides the title of a page given by ID + + <p>The page titles are displayed in the wizard's roadmap.</p> + */ + string getPageTitle( [in] short PageId ); + + boolean canAdvance(); + + /** called when a new page in the wizard is being activated + */ + void onActivatePage( [in] short PageId ); + + /** called when a page in the wizard is being deactivated + */ + void onDeactivatePage( [in] short PageId ); + + /** called when the wizard is about to be finished. + + <p>This method allows the controller to do any final checks, and ultimatively veto finishing the wizard.</p> + */ + boolean confirmFinish(); +}; + +//================================================================================================================== + +}; }; }; }; }; + +//================================================================================================================== + +#endif diff --git a/offapi/com/sun/star/ui/dialogs/XWizardPage.idl b/offapi/com/sun/star/ui/dialogs/XWizardPage.idl new file mode 100644 index 000000000..4eef97d00 --- /dev/null +++ b/offapi/com/sun/star/ui/dialogs/XWizardPage.idl @@ -0,0 +1,86 @@ +/************************************************************************* + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_ui_dialogs_XWizardPage_idl__ +#define __com_sun_star_ui_dialogs_XWizardPage_idl__ + +#include <com/sun/star/awt/XWindow.idl> + +//================================================================================================================== + +module com { module sun { module star { module ui { module dialogs { + +//================================================================================================================== + +/** is a single page of a <type>Wizard</type> + */ +interface XWizardPage : ::com::sun::star::lang::XComponent +{ + /** provides read-only access to the window of the page + */ + [attribute, readonly] ::com::sun::star::awt::XWindow Window; + + /** denotes the ID of the page. + + <p>Within a wizard, no two pages are allowed to have the same ID.</p> + */ + [attribute, readonly] short PageId; + + /** called when the page is activated + */ + void activatePage(); + + /** is called when the page is about to be left + + <p>An implementation can veto the leave by returning <FALSE/> here. Usually, the decision about this + depends on the current state of the page.</p> + + @param Reason + is one of the <type>WizardTravelType</type> contants denoting the reason why the page should be + committed. + */ + boolean commitPage( [in] short Reason ); + + /** determines whether it is allowed to travel to a later page in the wizard + + <p>You should base this decision on the state of the page only, not on a global state of the wizard. Usually, + you return <FALSE/> here if and only if not all necessary input on the page has been provided by the user, + or the provided input is not valid.</p> + + <p>If checked for validity is expensive, or if you prefer giving your user more detailed feedback on validity + than a disabled <code>Next</code> button in the wizard, then move your checks to the <member>commitPage</member> + method.</p> + */ + boolean canAdvance(); +}; + +//================================================================================================================== + +}; }; }; }; }; + +//================================================================================================================== + +#endif diff --git a/offapi/com/sun/star/ui/dialogs/makefile.mk b/offapi/com/sun/star/ui/dialogs/makefile.mk index fa11ba35e..07d762fb0 100644 --- a/offapi/com/sun/star/ui/dialogs/makefile.mk +++ b/offapi/com/sun/star/ui/dialogs/makefile.mk @@ -64,7 +64,13 @@ IDLFILES=\ XControlInformation.idl \ XAsynchronousExecutableDialog.idl \ XDialogClosedListener.idl \ - DialogClosedEvent.idl + DialogClosedEvent.idl \ + XWizard.idl \ + XWizardController.idl \ + Wizard.idl \ + XWizardPage.idl \ + WizardButton.idl \ + WizardTravelType.idl # ------------------------------------------------------------------ diff --git a/offapi/com/sun/star/ui/makefile.mk b/offapi/com/sun/star/ui/makefile.mk index 944c8ee68..313d74dcd 100644 --- a/offapi/com/sun/star/ui/makefile.mk +++ b/offapi/com/sun/star/ui/makefile.mk @@ -84,7 +84,8 @@ IDLFILES=\ XUIElementFactory.idl \ XUIElementFactoryRegistration.idl \ XUIElementSettings.idl \ - XUIFunctionListener.idl + XUIFunctionListener.idl \ + XToolPanel.idl # ------------------------------------------------------------------ diff --git a/offapi/com/sun/star/util/InvalidStateException.idl b/offapi/com/sun/star/util/InvalidStateException.idl new file mode 100644 index 000000000..58e368bd4 --- /dev/null +++ b/offapi/com/sun/star/util/InvalidStateException.idl @@ -0,0 +1,50 @@ +/************************************************************************* + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_util_InvalidStateException_idl__ +#define __com_sun_star_util_InvalidStateException_idl__ + +#include <com/sun/star/uno/Exception.idl> + +//================================================================================================================== + +module com { module sun { module star { module util { + +//================================================================================================================== + +/** is thrown when an object's state does not allow to call requested functionality. + */ +exception InvalidStateException : com::sun::star::uno::Exception +{ +}; + +//================================================================================================================== + +}; }; }; }; + +//================================================================================================================== + +#endif diff --git a/offapi/com/sun/star/util/makefile.mk b/offapi/com/sun/star/util/makefile.mk index 75b5dde89..aa0374296 100644 --- a/offapi/com/sun/star/util/makefile.mk +++ b/offapi/com/sun/star/util/makefile.mk @@ -53,6 +53,7 @@ IDLFILES=\ ElementChange.idl \ Endianness.idl \ FileIOException.idl\ + InvalidStateException.idl\ Language.idl\ NumberFormat.idl\ NumberFormatProperties.idl\ |