diff options
Diffstat (limited to 'offapi/com/sun')
54 files changed, 2453 insertions, 115 deletions
diff --git a/offapi/com/sun/star/awt/ItemListEvent.idl b/offapi/com/sun/star/awt/ItemListEvent.idl new file mode 100644 index 000000000000..f9d2658bd5bd --- /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 5017b05635ad..1cd36de93231 100644 --- a/offapi/com/sun/star/awt/UnoControlListBoxModel.idl +++ b/offapi/com/sun/star/awt/UnoControlListBoxModel.idl @@ -39,6 +39,8 @@ #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 63364622c4ce..cf45f0aea0f0 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 1460adaa49d1..ca301483263f 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 a798d1d842e2..f5194075019a 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 9b2f31853f2d..f2eacad5b76b 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 000000000000..6419ea94d0b0 --- /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 000000000000..d41d8b104a02 --- /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 174e69c8184c..1cfd758590b9 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 934f85e8aa22..0a4ac133524a 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 1e2350a3a1d3..55734fd75ca6 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 a65b9eece27f..a5341257ba45 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 dd52f2e02ba3..2c5227329778 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/deployment/LicenseIndividualAgreementException.idl b/offapi/com/sun/star/deployment/ExtensionManager.idl index 4239d14f075f..1911ce04dd81 100644 --- a/offapi/com/sun/star/deployment/LicenseIndividualAgreementException.idl +++ b/offapi/com/sun/star/deployment/ExtensionManager.idl @@ -25,34 +25,24 @@ * ************************************************************************/ -#if ! defined INCLUDED_com_sun_star_deployment_LicenseIndividualAgreementException_idl -#define INCLUDED_com_sun_star_deployment_LicenseIndividualAgreementException_idl +#if ! defined INCLUDED_com_sun_star_deployment_ExtensionManagerFactory_idl +#define INCLUDED_com_sun_star_deployment_ExtensionManagerFactory_idl -#include <com/sun/star/uno/Exception.idl> +#include <com/sun/star/deployment/XExtensionManager.idl> module com { module sun { module star { module deployment { -/** The exception signals that an extension is about to be installed for more than - one user, allthough every user needs to agree to the license. - - @since OOo 2.0.6 - */ -exception LicenseIndividualAgreementException : com::sun::star::uno::Exception -{ - /** name of the extension. - - Contains the file name only. - */ - string ExtensionName; - /** indicates if the user can prevent to show the license - - Represents the attribute value - /description/registration/simple-license/@suppress-if-required - from the description.xml - */ - boolean SuppressIfRequired; -}; +/** the ExtensionManager service. + + The component context entry is + <code> + /singletons/com.sun.star.deployment.ExtensionManager + </code>. + + @since OOo 3.3.0 +*/ +singleton ExtensionManager : XExtensionManager; }; }; }; }; diff --git a/offapi/com/sun/star/deployment/ExtensionRemovedException.idl b/offapi/com/sun/star/deployment/ExtensionRemovedException.idl new file mode 100644 index 000000000000..bb3116c9f554 --- /dev/null +++ b/offapi/com/sun/star/deployment/ExtensionRemovedException.idl @@ -0,0 +1,53 @@ +/************************************************************************* + * + * 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: VersionException.idl,v $ + * $Revision: 1.3 $ + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef INCLUDED_COM_SUN_STAR_DEPLOYMENT_EXTENSIONREMOVEDEXCEPTION_IDL +#define INCLUDED_COM_SUN_STAR_DEPLOYMENT_EXTENSIONREMOVEDEXCEPTION_IDL + +#include "com/sun/star/uno/Exception.idl" + +module com { module sun { module star { module deployment { + +interface XPackage; + +/** + indicates that a function call with the given arguments is not supported + because the extension was removed. <member>XPackage::isRemoved</member> will + return true on that object. + + @since OOo 3.3.0 +*/ +exception ExtensionRemovedException: com::sun::star::uno::Exception { + +}; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/deployment/InstallException.idl b/offapi/com/sun/star/deployment/InstallException.idl index 6c16e058b38d..3186ecedbdfc 100644 --- a/offapi/com/sun/star/deployment/InstallException.idl +++ b/offapi/com/sun/star/deployment/InstallException.idl @@ -44,11 +44,10 @@ interface XPackage; */ exception InstallException: com::sun::star::uno::Exception { /** - represents the new deployment unit. + the display name of the extension, which is to be installed. - <p>Must not be <NULL/>.</p> */ - XPackage New; + string displayName; }; diff --git a/offapi/com/sun/star/deployment/InvalidRemovedParameterException.idl b/offapi/com/sun/star/deployment/InvalidRemovedParameterException.idl new file mode 100644 index 000000000000..3a2cb5e330cc --- /dev/null +++ b/offapi/com/sun/star/deployment/InvalidRemovedParameterException.idl @@ -0,0 +1,65 @@ +/************************************************************************* + * + * 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: VersionException.idl,v $ + * $Revision: 1.3 $ + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef INCLUDED_COM_SUN_STAR_DEPLOYMENT_INVALIDREMOVEDPARAMETEREXCEPTION_IDL +#define INCLUDED_COM_SUN_STAR_DEPLOYMENT_INVALIDREMOVEDPARAMETEREXCEPTION_IDL + +#include "com/sun/star/uno/Exception.idl" + +module com { module sun { module star { module deployment { + +interface XPackage; + +/** + indicates that <member>XPackageRegistry::bindPackage</member> was previously + called with a different value for the <code>removed</code> parameter and that + the <type>XPackage</type> object created by that call still exist. + + @since OOo 3.3.0 +*/ +exception InvalidRemovedParameterException: com::sun::star::uno::Exception { + /** the value of the <code>removed</code> parameter which was used in + <member>XPackageRegistry::bindPackage</member> to create the currently + existing <type>XPackage</type> object. + */ + boolean PreviousValue; + /** + the <type>XPackage</type> that was already bound to the provided + <code>url</code> paramter during + <member>XPackageRegistry::bindPackage</member>. + + <p>Must not be <NULL/>.</p> + */ + XPackage Extension; +}; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/deployment/LicenseException.idl b/offapi/com/sun/star/deployment/LicenseException.idl index 4d3996da191b..a80a5e463dd6 100644 --- a/offapi/com/sun/star/deployment/LicenseException.idl +++ b/offapi/com/sun/star/deployment/LicenseException.idl @@ -41,20 +41,19 @@ exception LicenseException : com::sun::star::uno::Exception { /** name of the extension. - Contains the file name only. + The display name of the extension. + See <member>XPackage::getDisplayName</member> */ string ExtensionName; /** contains the text of the license. */ string Text; - /** indicates if the user can prevent to show the license - - Represents the attribute value - /description/registration/simple-license/@suppress-if-required + /** contains the value of the attribute + /description/registration/simple-license/@accept-by from the description.xml */ - boolean SuppressIfRequired; + string AcceptBy; }; }; }; }; }; diff --git a/offapi/com/sun/star/deployment/Prerequisites.idl b/offapi/com/sun/star/deployment/Prerequisites.idl new file mode 100644 index 000000000000..52987ad9bd77 --- /dev/null +++ b/offapi/com/sun/star/deployment/Prerequisites.idl @@ -0,0 +1,48 @@ +/************************************************************************* + * + * 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: KeyUsage.idl,v $ + * $Revision: 1.4 $ + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_deployment_prerequisites_idl_ +#define __com_sun_star_deployment_prerequisites_idl_ + +module com { module sun { module star { module deployment { + +constants Prerequisites +{ + const long PLATFORM = 0x1; + const long DEPENDENCIES = 0x2; + const long LICENSE = 0x04; +}; + + +} ; } ; } ; } ; + + +#endif + diff --git a/offapi/com/sun/star/deployment/VersionException.idl b/offapi/com/sun/star/deployment/VersionException.idl index 74683adab7a0..2d69c918c3a2 100644 --- a/offapi/com/sun/star/deployment/VersionException.idl +++ b/offapi/com/sun/star/deployment/VersionException.idl @@ -44,11 +44,13 @@ interface XPackage; */ exception VersionException: com::sun::star::uno::Exception { /** - represents the new version of the deployment unit. - - <p>Must not be <NULL/>.</p> + the version of the extension which is being installed. + */ + string NewVersion; + /** + the display name of the extension which is being installed. */ - XPackage New; + string NewDisplayName; /** represents the already installed version of the deployment unit. diff --git a/offapi/com/sun/star/deployment/XExtensionManager.idl b/offapi/com/sun/star/deployment/XExtensionManager.idl new file mode 100644 index 000000000000..b807df54af65 --- /dev/null +++ b/offapi/com/sun/star/deployment/XExtensionManager.idl @@ -0,0 +1,342 @@ +/************************************************************************* + * + * 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. + * + ************************************************************************/ + +#if ! defined INCLUDED_com_sun_star_deployment_XExtensionManager_idl +#define INCLUDED_com_sun_star_deployment_XExtensionManager_idl + +#include <com/sun/star/lang/XComponent.idl> +#include <com/sun/star/task/XAbortChannel.idl> +#include <com/sun/star/util/XModifyBroadcaster.idl> +#include <com/sun/star/deployment/XPackage.idl> +#include <com/sun/star/deployment/XPackageTypeInfo.idl> +#include <com/sun/star/ucb/XCommandEnvironment.idl> +#include <com/sun/star/deployment/DeploymentException.idl> +#include <com/sun/star/container/NoSuchElementException.idl> +#include <com/sun/star/lang/IllegalArgumentException.idl> +#include <com/sun/star/beans/NamedValue.idl> + +module com { module sun { module star { module deployment { + +/** The <type>XExtensionManager</type> interface is used to manage extensions + in the user, shared and bundled repository. + + @see ExtensionManager + @since OOo 3.3.0 +*/ +interface XExtensionManager +{ + /** interface to notify disposing + */ + interface com::sun::star::lang::XComponent; + + /** interface to notify changes of the set of deployed packages of + this manager + */ + interface com::sun::star::util::XModifyBroadcaster; + + + /** gets the supported <type>XPackageTypeInfo</type>s. + + @return + supported <type>XPackageTypeInfo</type>s. + */ + sequence<XPackageTypeInfo> getSupportedPackageTypes(); + + /** creates a command channel to be used to asynchronously abort a command. + + @return + abort channel + */ + com::sun::star::task::XAbortChannel createAbortChannel(); + + /** adds an extension. + + The properties argument is currently only used to suppress the license information + for shared extensions. + + @param url + package URL, must be UCB conform + @param properties + additional properties, for example, that the license is to be + suppressed (if supported by the extension) + @param repository + the name of the repository + @param xAbortChannel + abort channel to asynchronously abort the adding process, + or null + @param xCmdEnv + command environment for error and progress handling + @return + object representing the extension. + */ + XPackage addExtension( [in] string url, + [in] sequence<com::sun::star::beans::NamedValue> properties, + [in] string repository, + [in] com::sun::star::task::XAbortChannel xAbortChannel, + [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv ) + raises (DeploymentException, + com::sun::star::ucb::CommandFailedException, + com::sun::star::ucb::CommandAbortedException, + com::sun::star::lang::IllegalArgumentException); + + /** removes an extension. + + @param identifier + package identifier + @param fileName + package file name + @param repository + the name of the repository + @param xAbortChannel + abort channel to asynchronously abort the removing process, + or null + @param xCmdEnv + command environment for error and progress handling + */ + void removeExtension( + [in] string identifier, + [in] string fileName, + [in] string repository, + [in] com::sun::star::task::XAbortChannel xAbortChannel, + [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv ) + raises (DeploymentException, + com::sun::star::ucb::CommandFailedException, + com::sun::star::ucb::CommandAbortedException, + com::sun::star::lang::IllegalArgumentException); + + + /** enable an extension. + + If the extension is not from the user repository then an + IllegalArgumentException is thrown. + + @param extension + the extension which is to be enabled. + @param xAbortChannel + abort channel to asynchronously abort the removing process, + or null + @param xCmdEnv + command environment for error and progress handling + */ + void enableExtension( + [in] XPackage extension, + [in] com::sun::star::task::XAbortChannel xAbortChannel, + [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv ) + raises (DeploymentException, + com::sun::star::ucb::CommandFailedException, + com::sun::star::ucb::CommandAbortedException, + com::sun::star::lang::IllegalArgumentException); + + /** disable an extension. + + If the extension is not from the user repository then an + IllegalArgumentException is thrown. + + @param extension + the extension which is to be disabled + @param xAbortChannel + abort channel to asynchronously abort the removing process, + or null + @param xCmdEnv + command environment for error and progress handling + */ + void disableExtension( + [in] XPackage extension, + [in] com::sun::star::task::XAbortChannel xAbortChannel, + [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv ) + raises (DeploymentException, + com::sun::star::ucb::CommandFailedException, + com::sun::star::ucb::CommandAbortedException, + com::sun::star::lang::IllegalArgumentException); + + /** gets all currently installed extensions, including disabled + user extensions. + + @param repository + the repository from which the extensions are returned + @param xAbortChannel + abort channel to asynchronously abort the removing process, + or null + @param xCmdEnv + command environment for error and progress handling + @return + all currently installed packages + */ + sequence<XPackage> getDeployedExtensions( + [in] string repository, + [in] com::sun::star::task::XAbortChannel xAbortChannel, + [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv ) + raises (DeploymentException, + com::sun::star::ucb::CommandFailedException, + com::sun::star::ucb::CommandAbortedException, + com::sun::star::lang::IllegalArgumentException); + + + /** gets an installed extensions. + + @param repositroy + the name of the repository + @param identifier + extension identifier + @param fileName + extension file name + @param xCmdEnv + command environment for error and progress handling + @return + <type>XPackage</type> object + */ + XPackage getDeployedExtension( + [in] string repository, + [in] string identifier, + [in] string fileName, + [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv ) + raises (DeploymentException, + com::sun::star::ucb::CommandFailedException, + com::sun::star::lang::IllegalArgumentException); + + /** gets all extensions with the same identifer from all repositories. + + The extension at the first position in the returned sequence represents + the extension from the user repository. The next element is from the shared + and the last one is from the bundled repository. + If one repository does not contain this extension, then the respective + element is a null reference. + */ + sequence<XPackage> getExtensionsWithSameIdentifier( + [in] string identifier, + [in] string fileName, + [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv ) + raises (DeploymentException, + com::sun::star::ucb::CommandFailedException, + com::sun::star::lang::IllegalArgumentException); + + + /** returns a sequence containing all installed extensions. + + The members of the returned sequence correspond to an extension with a + particular extension identifer. The members are also sequences which + contain as many elements as there are repositories. Those are ordered + according to the priority of the repository. That is, the first member + is the extension from the user repository, the second is from the shared + repository and the last is from the bundled repository. + */ + sequence<sequence<XPackage> > getAllExtensions( + [in] com::sun::star::task::XAbortChannel xAbortChannel, + [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv ) + raises (DeploymentException, + com::sun::star::ucb::CommandFailedException, + com::sun::star::ucb::CommandAbortedException, + com::sun::star::lang::IllegalArgumentException); + + + /** Expert feature: erases the underlying registry cache and reinstalls + all previously added extensions. Please keep in mind that all + registration status get lost. + <p> + Please use this in case of suspected cache inconsistencies only. + </p> + @param repositroy + the name of the repository + @param xAbortChannel + abort channel to asynchronously abort the adding process + @param xCmdEnv + command environment for error and progress handling + */ + void reinstallDeployedExtensions( + [in] string repository, + [in] com::sun::star::task::XAbortChannel xAbortChannel, + [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv ) + raises (DeploymentException, + com::sun::star::ucb::CommandFailedException, + com::sun::star::ucb::CommandAbortedException, + com::sun::star::lang::IllegalArgumentException); + + + /** synchronizes the extension database with the contents of the extensions + folder of shared and bundled extensinos. + + Added extensions will be added to the database and removed extensions + will be removed from the database. + + @return + If true - then at least one extension was removed or added. Otherwise + nothing was chaned. + */ + boolean synchronize( + [in] com::sun::star::task::XAbortChannel xAbortChannel, + [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv ) + raises (DeploymentException, + com::sun::star::ucb::CommandFailedException, + com::sun::star::ucb::CommandAbortedException, + com::sun::star::lang::IllegalArgumentException); + + + /** returns all extensions which are currently not in use + because the user did not accept the license. + + The function will not return any object for the user repository, because + a user extension will not be kept in the user repository if its license + is declined. Only extensions which are registered at start-up of OOo, + that is, shared and bundled extensions, can be returned. + + Extensions which allow the license to be suppressed, that is, it does not + need to be displayed, and which are installed with the corresponding option, + are also not returned. + + Extensions returned by this functions are not returned by + <member>XExtensionManger::getDeployedExtension</member> + <member>XExtensionManger::getDeployedExtensions</member> + <member>XExtensionManger::getAllExtensions</member> + <member>XExtensionManger::getExtensionsWithSameIdentifier</member> + */ + sequence<XPackage> getExtensionsWithUnacceptedLicenses( + [in] string repository, + [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv ) + raises (DeploymentException, + com::sun::star::lang::IllegalArgumentException); + + /** check if all prerequisites for the extension are fulfilled + and activates it, if possible. + */ + long checkPrerequisitesAndEnable( + [in] XPackage extension, + [in] com::sun::star::task::XAbortChannel xAbortChannel, + [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv ) + raises (DeploymentException, + com::sun::star::ucb::CommandFailedException, + com::sun::star::ucb::CommandAbortedException, + com::sun::star::lang::IllegalArgumentException); + + /** determines if the current user has write access to the extensions folder + of the repository. + */ + boolean isReadOnlyRepository([in] string repository); +}; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/deployment/XPackage.idl b/offapi/com/sun/star/deployment/XPackage.idl index f54ec347e368..9709b579bc2e 100644 --- a/offapi/com/sun/star/deployment/XPackage.idl +++ b/offapi/com/sun/star/deployment/XPackage.idl @@ -33,6 +33,7 @@ #include <com/sun/star/beans/StringPair.idl> #include <com/sun/star/deployment/DeploymentException.idl> #include <com/sun/star/deployment/XPackageTypeInfo.idl> +#include <com/sun/star/deployment/ExtensionRemovedException.idl> #include <com/sun/star/graphic/XGraphic.idl> #include <com/sun/star/lang/XComponent.idl> #include <com/sun/star/lang/IllegalArgumentException.idl> @@ -72,30 +73,25 @@ interface XPackage Only if the return value is true the package is allowed to be installed. In case of false or in case of an exception, the package must be removed - in completely. + completely. After return of this function no code from the extension may be used anymore, so that the extension can be safely removed from the harddisk. @param xCmdEnv command environment for error handling and other interaction. - @installed - signalls if an extension with the same identifyer is already installed. - - @aContextName - the name of the context of XPackageManager implementation that is to be used - to install the extension. Currently we use the names "user" - and "shared". + @alreadyInstalled + indicates that an extension with the same identifyer is already installed. @return - true - the package can be installed - false - the package must not be installed. + null - all prerequisites are met. Otherwise, a value from + <member>Prerequisites</member> indicating what prerequisites are missing. */ - boolean checkPrerequisites( + long checkPrerequisites( [in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv, - [in] boolean installed, - [in] string aContextName) + [in] boolean alreadyInstalled) raises (DeploymentException, + ExtensionRemovedException, com::sun::star::ucb::CommandFailedException, com::sun::star::ucb::CommandAbortedException); @@ -116,6 +112,7 @@ interface XPackage boolean checkDependencies( [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv ) raises (DeploymentException, + ExtensionRemovedException, com::sun::star::ucb::CommandFailedException); @@ -140,8 +137,14 @@ interface XPackage com::sun::star::ucb::CommandFailedException, com::sun::star::ucb::CommandAbortedException); - /** registers this <type>XPackage</type>, thus activating the package. + /** registers this <type>XPackage</type>. + + NEVER call this directly. This is done by the extension manager if necessary. + @param startup + indicates that registration is adapted to the particular + startup scenario. That is, it is set to true, when called + from <member>XExtensionManager::synchronize</member> @param xAbortChannel abort channel to asynchronously abort the registration process, or null @@ -149,15 +152,19 @@ interface XPackage command environment for error and progress handling */ void registerPackage( + [in] boolean startup, [in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv ) raises (DeploymentException, + ExtensionRemovedException, com::sun::star::ucb::CommandFailedException, com::sun::star::ucb::CommandAbortedException, com::sun::star::lang::IllegalArgumentException); /** revokes this <type>XPackage</type>. + NEVER call this directly. This is done by the extension manager if necessary. + @param xAbortChannel abort channel to asynchronously abort the registration process, or null @@ -182,6 +189,9 @@ interface XPackage /** Gets packages of the bundle. + If <member>isRemoved</member> returns true then getBundle may return an + empty sequence in case the object is not registered. + @param xAbortChannel abort channel to asynchronously abort the registration process, or null @@ -225,7 +235,8 @@ interface XPackage @return the textual version representation */ - string getVersion(); + string getVersion() + raises (ExtensionRemovedException); /** returns the location of the package. @@ -240,14 +251,16 @@ interface XPackage @return display name of the package */ - string getDisplayName(); + string getDisplayName() + raises (ExtensionRemovedException); /** returns a description string to describe the package. @return description */ - string getDescription(); + string getDescription() + raises (ExtensionRemovedException); /** returns a sequence of update information URLs. @@ -258,8 +271,8 @@ interface XPackage @return update information URLs */ - sequence<string> getUpdateInformationURLs(); - + sequence<string> getUpdateInformationURLs() + raises (ExtensionRemovedException); /** returns the publisher info for a package, the strings might be empty, if there are no publisher @@ -269,8 +282,8 @@ interface XPackage represents the URL to the publisher. */ - ::com::sun::star::beans::StringPair getPublisherInfo(); - + ::com::sun::star::beans::StringPair getPublisherInfo() + raises (ExtensionRemovedException); /** returns the <type>XPackageTypeInfo</type>, e.g. media-type etc. @return @@ -293,8 +306,10 @@ interface XPackage [in] string newTitle, [in] long nameClashAction, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv ) - raises (com::sun::star::ucb::CommandFailedException, - com::sun::star::ucb::CommandAbortedException); + raises ( + ExtensionRemovedException, + com::sun::star::ucb::CommandFailedException, + com::sun::star::ucb::CommandAbortedException); /** returns an icon for a package. @@ -305,7 +320,37 @@ interface XPackage database application window, or <NULL/> if the default icon should be used. */ - com::sun::star::graphic::XGraphic getIcon( [in] boolean highContrast ); + com::sun::star::graphic::XGraphic getIcon( [in] boolean highContrast ) + raises (ExtensionRemovedException); + + /** returns the name of the repository where this object comes from. + */ + string getRepositoryName(); + + /** return a URL to a directory which contains the registration data. + + This data may be created when calling + <member>XPackage::registerPackage</member>. If this is the case is + indicated by <member + scope="com::sun::star::beans">Optional::IsPresent</member> of the return + value. + If registration data are created during registration, but the package is + currently not registered, for example after calling + <member>XPackage::revokePackage</member>, then <member + scope="com::sun::star::beans">Optional::IsPresent</member> is true and + the <member scope="com::sun::star::beans">Optional::Value</member> may + be an empty string. + */ + com::sun::star::beans::Optional<string> getRegistrationDataURL() + raises (ExtensionRemovedException); + + /** indicates if this object represents a removed extension or extension + item. This is the case when it was created by providing + <code>true</code> for the <code>removed</code> parameter in the function + <member>XPackageRegistry::bindPackage</member>. + */ + boolean isRemoved(); + }; }; }; }; }; diff --git a/offapi/com/sun/star/deployment/XPackageManager.idl b/offapi/com/sun/star/deployment/XPackageManager.idl index 544cd7758eb0..da329bb9367f 100644 --- a/offapi/com/sun/star/deployment/XPackageManager.idl +++ b/offapi/com/sun/star/deployment/XPackageManager.idl @@ -37,21 +37,26 @@ #include <com/sun/star/deployment/DeploymentException.idl> #include <com/sun/star/container/NoSuchElementException.idl> #include <com/sun/star/lang/IllegalArgumentException.idl> +#include <com/sun/star/beans/NamedValue.idl> module com { module sun { module star { module deployment { /** The <type>XPackageManager</type> interface is used to add or remove - packages to a specific deployment context. + packages to a specific repository. This interface represents a particular + repository. Packages are deployable files, e.g. scripts or UNO components. <p> Adding an UNO package means that a copy of the package is stored - with respect to the context of the manager and the package is registered, - thus activated. + in the repository. </p> <p> - Removing an UNO package means that the previously added package is revoked, - thus deactivated, first and then removed from the context. + Removing an UNO package means that the previously added package is + removed from the repository. + </p> + <p> + All interface methods do neither register nor revoke an extension. + This happens exclusively by <type>XExtensionManager</type>. </p> <p> Objects of this interface are created using the @@ -63,6 +68,8 @@ module com { module sun { module star { module deployment { @see thePackageManagerFactory @since OOo 2.0.0 + @deprecated + Use <type>XExtensionManager</type>. */ interface XPackageManager { @@ -75,7 +82,8 @@ interface XPackageManager */ interface com::sun::star::util::XModifyBroadcaster; - /** returns the underlying deployment context. + /** returns the underlying deployment context, that is, + the name of the repository.. @return underlying deployment context @@ -98,8 +106,15 @@ interface XPackageManager /** adds an UNO package. + The properties argument is currently only used to suppress the license information + for shared extensions. + + @param url package URL, must be UCB conform + @param properties + additional properties, for example, that the license is to be + suppressed (if supported by the extension) @param mediaType media-type of package, empty string if to be detected @param xAbortChannel @@ -111,6 +126,7 @@ interface XPackageManager <type>XPackage</type> handle */ XPackage addPackage( [in] string url, + [in] sequence<com::sun::star::beans::NamedValue> properties, [in] string mediaType, [in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv ) @@ -119,6 +135,30 @@ interface XPackageManager com::sun::star::ucb::CommandAbortedException, com::sun::star::lang::IllegalArgumentException); + /** adds an extension. + + This copies the extension. If it was from the same repository, + which is represented by this XPackageManager insterface, then + nothing happens. + + @param extension + + @param xAbortChannel + abort channel to asynchronously abort the adding process, + or null + @param xCmdEnv + command environment for error and progress handling + @return + <type>XPackage</type> handle + */ + XPackage importExtension( [in] XPackage extension, + [in] com::sun::star::task::XAbortChannel xAbortChannel, + [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv ) + raises (DeploymentException, + com::sun::star::ucb::CommandFailedException, + com::sun::star::ucb::CommandAbortedException, + com::sun::star::lang::IllegalArgumentException); + /** removes an UNO package. @param identifier @@ -212,6 +252,61 @@ interface XPackageManager */ boolean isReadOnly(); + /** synchronizes the extension database with the contents of the extensions + folder. + + Added extensions will be added to the database and removed extensions + will be removed from the database. + + @param xAddedExtension + new extensions which may need to be registered. + + @param + removed extensions which must be revoked + @return + If true - then at least one extension was removed or added. Otherwise + nothing was chaned. + */ + boolean synchronize([in] com::sun::star::task::XAbortChannel xAbortChannel, + [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv ) + raises (DeploymentException, + com::sun::star::ucb::CommandFailedException, + com::sun::star::ucb::CommandAbortedException); + + + /** returns all extensions which are currently not in use + because the user did not accept the license. + + The function will not return any object for the user repository, because + a user extension will not be kept in the user repository if its license + is declined. Only extensions which are registered at start-up of OOo, + that is, shared and bundled extensions, can be returned. + + Extensions which allow the license to be suppressed, that is, it does not + need to be displayed, and which are installed with the corresponding option, + are also not returned. + */ + sequence<XPackage> getExtensionsWithUnacceptedLicenses( + [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv ) + raises (DeploymentException); + + /** checks if the extension can be used. + + The extension must be managed by this package manager, that is, it must + be recorded in its database. The package manager calls + XPackage::checkPrerequisites and updates its data base with the + result. The result, which is from <type>Prerequisites</type> will be + returned. + */ + long checkPrerequisites( + [in] XPackage extension, + [in] com::sun::star::task::XAbortChannel xAbortChannel, + [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv ) + raises (DeploymentException, + com::sun::star::ucb::CommandFailedException, + com::sun::star::ucb::CommandAbortedException, + com::sun::star::lang::IllegalArgumentException); + }; }; }; }; }; diff --git a/offapi/com/sun/star/deployment/XPackageManagerFactory.idl b/offapi/com/sun/star/deployment/XPackageManagerFactory.idl index e3264bc0babf..4b5b7183ba47 100644 --- a/offapi/com/sun/star/deployment/XPackageManagerFactory.idl +++ b/offapi/com/sun/star/deployment/XPackageManagerFactory.idl @@ -45,6 +45,8 @@ module com { module sun { module star { module deployment { </p> @since OOo 2.0.0 + @deprecated + Use <type>XExtensionManager</type>. */ interface XPackageManagerFactory { diff --git a/offapi/com/sun/star/deployment/XPackageRegistry.idl b/offapi/com/sun/star/deployment/XPackageRegistry.idl index 3cfa6a75236c..c84f37625ec5 100644 --- a/offapi/com/sun/star/deployment/XPackageRegistry.idl +++ b/offapi/com/sun/star/deployment/XPackageRegistry.idl @@ -30,6 +30,7 @@ #include <com/sun/star/deployment/XPackage.idl> #include <com/sun/star/deployment/XPackageTypeInfo.idl> +#include <com/sun/star/deployment/InvalidRemovedParameterException.idl> #include <com/sun/star/beans/StringPair.idl> @@ -46,10 +47,52 @@ interface XPackageRegistry thus the process of binding must not be an expensive operation, because it is not abortable. + Calling the function several time with the same parameters must result + in returning the same object. + + The file or folder at the location where url points to may not exist or + it was replaced. This can happen, for example, when a bundled extension + was removed by the setup and a user later starts OOo. Then the user data + may still contain all registration data of that extension, but the + actual extension files do not exist anymore. The registration data must + then be cleaned of all the remains of that extension. To to that one + creates an <type>XPackage</type> object on behalf of that extension and + calls <member>XPackage::revokePakage</member>. The parameter + <code>removed</code> indicates this case. The returned object may not + rely on the file or folder to which refers <code>url</url>. Instead it + must use previously saved data to successfully carry out the revocation + of this object (<member>XPackage::revokePackage</member>). + + The implementation must ensure that there is only one instance of + <type>XPackage</type> for the same <code>url</code> at any + time. Therefore calling <member>bindPackage</member> again with the same + <code>url</code> but different <code>mediaType<code> (the exeption is, + if previsously an empty string was proveded to cause the determination + of the media type) or <code>removed</code> parameters will cause an + exception. An <type + scope="com::sun::star::lang">IllegalArgumentException</type> will be + thrown in case of a different <code>mediaType</code> parameter and a + <type>InvalidRemovedParameterException</type> is thrown if the + <code>removed</code> parameter is different. + + The <code>identifier</code> parameter must be provided when + <code>removed</code> = true. If not, then an <type + scope="com::sun::star::lang">IllegalArgumentException</type> will be + thrown. + @param url package URL, must be UCB conform @param mediaType media type of package, empty string if to be detected + @param removed + + @para unfulfilledPrerequisites + has a value other null if the extension could not be installed previously + because <member>XPackage::checkPrerequisites</member> failed. + + @param identifier + the identifier of the extension + @param xCmdEnv command environment for error and progress handling @return @@ -58,8 +101,11 @@ interface XPackageRegistry XPackage bindPackage( [in] string url, [in] string mediaType, + [in] boolean removed, + [in] string identifier, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv ) raises (DeploymentException, + InvalidRemovedParameterException, com::sun::star::ucb::CommandFailedException, com::sun::star::lang::IllegalArgumentException); diff --git a/offapi/com/sun/star/deployment/XPackageTypeInfo.idl b/offapi/com/sun/star/deployment/XPackageTypeInfo.idl index 2f53d003c315..7252f73d200b 100644 --- a/offapi/com/sun/star/deployment/XPackageTypeInfo.idl +++ b/offapi/com/sun/star/deployment/XPackageTypeInfo.idl @@ -29,7 +29,7 @@ #define INCLUDED_com_sun_star_deployment_XPackageTypeInfo_idl #include <com/sun/star/uno/XInterface.idl> - +#include <com/sun/star/deployment/ExtensionRemovedException.idl> module com { module sun { module star { module deployment { @@ -52,7 +52,8 @@ interface XPackageTypeInfo @return description */ - string getDescription(); + string getDescription() + raises (ExtensionRemovedException); /** returns a short description string to describe a package type (one line only). @@ -60,7 +61,8 @@ interface XPackageTypeInfo @return description */ - string getShortDescription(); + string getShortDescription() + raises (ExtensionRemovedException); /** returns a file filter string for the file picker user interface. Both, the short description string and file filter string diff --git a/offapi/com/sun/star/deployment/makefile.mk b/offapi/com/sun/star/deployment/makefile.mk index fef835e62f31..1e3a77b89573 100644 --- a/offapi/com/sun/star/deployment/makefile.mk +++ b/offapi/com/sun/star/deployment/makefile.mk @@ -35,25 +35,29 @@ PACKAGE = com$/sun$/star$/deployment .INCLUDE : $(PRJ)$/util$/makefile.pmk IDLFILES = \ - DeploymentException.idl \ - XPackageTypeInfo.idl \ - XPackage.idl \ - XPackageRegistry.idl \ - PackageRegistryBackend.idl \ - XPackageManager.idl \ - XPackageManagerFactory.idl \ - thePackageManagerFactory.idl \ - DependencyException.idl \ - LicenseException.idl \ - VersionException.idl \ - InstallException.idl \ - UpdateInformationEntry.idl \ - XUpdateInformationProvider.idl \ - UpdateInformationProvider.idl \ - XPackageInformationProvider.idl \ - PackageInformationProvider.idl \ - LicenseIndividualAgreementException.idl \ - PlatformException.idl + DeploymentException.idl \ + XPackageTypeInfo.idl \ + XPackage.idl \ + XPackageRegistry.idl \ + PackageRegistryBackend.idl \ + XPackageManager.idl \ + XPackageManagerFactory.idl \ + XExtensionManager.idl \ + ExtensionManager.idl \ + thePackageManagerFactory.idl \ + DependencyException.idl \ + LicenseException.idl \ + VersionException.idl \ + InstallException.idl \ + UpdateInformationEntry.idl \ + XUpdateInformationProvider.idl \ + UpdateInformationProvider.idl \ + XPackageInformationProvider.idl \ + PackageInformationProvider.idl \ + PlatformException.idl \ + InvalidRemovedParameterException.idl \ + ExtensionRemovedException.idl \ + Prerequisites.idl .INCLUDE : target.mk .INCLUDE : $(PRJ)$/util$/target.pmk diff --git a/offapi/com/sun/star/deployment/thePackageManagerFactory.idl b/offapi/com/sun/star/deployment/thePackageManagerFactory.idl index 612eae1e2513..85e95acea598 100644 --- a/offapi/com/sun/star/deployment/thePackageManagerFactory.idl +++ b/offapi/com/sun/star/deployment/thePackageManagerFactory.idl @@ -43,6 +43,8 @@ module com { module sun { module star { module deployment { </p> @since OOo 2.0.0 + @deprecated + Use <type>XExtensionManager</type>. */ singleton thePackageManagerFactory : XPackageManagerFactory; diff --git a/offapi/com/sun/star/deployment/ui/LicenseDialog.idl b/offapi/com/sun/star/deployment/ui/LicenseDialog.idl index 64295b60a476..308b5b5b9814 100644 --- a/offapi/com/sun/star/deployment/ui/LicenseDialog.idl +++ b/offapi/com/sun/star/deployment/ui/LicenseDialog.idl @@ -45,10 +45,14 @@ service LicenseDialog : com::sun::star::ui::dialogs::XExecutableDialog @param xParent parent window + + @param extensionName + the display name of the extension @param licenseText text to be displayed */ create( [in] com::sun::star::awt::XWindow xParent, + [in] string extensionName, [in] string licenseText ); }; diff --git a/offapi/com/sun/star/document/MediaDescriptor.idl b/offapi/com/sun/star/document/MediaDescriptor.idl index 89a3141a443d..36da721cc159 100644 --- a/offapi/com/sun/star/document/MediaDescriptor.idl +++ b/offapi/com/sun/star/document/MediaDescriptor.idl @@ -141,6 +141,11 @@ published service MediaDescriptor for a special component type. Format of that depends from real type of adressed component. </p> + + <p> + For extensibility, it is recommended to use values of type + sequence<com.sun.star.beans.PropertyValue> with this property. + </p> */ [optional,property] any ComponentData; diff --git a/offapi/com/sun/star/drawing/EnhancedCustomShapeHandle.idl b/offapi/com/sun/star/drawing/EnhancedCustomShapeHandle.idl index 7b3f9a223f39..d5e8420fc32f 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 f57369e87f49..3bf1c6fa15cc 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/embed/XVisualObject.idl b/offapi/com/sun/star/embed/XVisualObject.idl index bed94da4fa7d..158c49851a6f 100644 --- a/offapi/com/sun/star/embed/XVisualObject.idl +++ b/offapi/com/sun/star/embed/XVisualObject.idl @@ -71,13 +71,13 @@ published interface XVisualObject: ::com::sun::star::uno::XInterface </p> @param nAspect - the aspect specifying the form of object representation - can take values from <type>Aspects</type> constant set + the aspect specifying the form of object representation. + Can take values from <type>Aspects</type> constant set. @param aSize the new size of the visual area - @thrown ::com::sun::star::lang::IllegalArgumentException + @throws ::com::sun::star::lang::IllegalArgumentException one of arguments is illegal @throws ::com::sun::star::embed::WrongStateException @@ -101,13 +101,13 @@ published interface XVisualObject: ::com::sun::star::uno::XInterface </p> @param nAspect - the aspect specifying the form of object representation - can take values from <type>Aspects</type> constant set + the aspect specifying the form of object representation. + Can take values from <type>Aspects</type> constant set. @return the size of visual area - @thrown ::com::sun::star::lang::IllegalArgumentException + @throws ::com::sun::star::lang::IllegalArgumentException one of arguments is illegal @throws ::com::sun::star::embed::WrongStateException @@ -127,7 +127,8 @@ published interface XVisualObject: ::com::sun::star::uno::XInterface </p> @param nAspect - the aspect the representation is requested for + the aspect the representation is requested for. + Can take values from <type>Aspects</type> constant set. @return the visual representation of the object in the default format and @@ -153,7 +154,8 @@ published interface XVisualObject: ::com::sun::star::uno::XInterface /** retrieves map mode the object communicates in. @param nAspect - the aspect the map mode is requested for + the aspect the map mode is requested for. + Can take values from <type>Aspects</type> constant set. @return the map mode the object communicates in, it can take values from diff --git a/offapi/com/sun/star/script/XLibraryContainer3.idl b/offapi/com/sun/star/script/XLibraryContainer3.idl new file mode 100644 index 000000000000..cb3f2a5e0f6c --- /dev/null +++ b/offapi/com/sun/star/script/XLibraryContainer3.idl @@ -0,0 +1,69 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2008 by Sun Microsystems, Inc. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: XLibraryContainer2.idl,v $ + * $Revision: 1.5 $ + * + * 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_script_XLibraryContainer3_idl__ +#define __com_sun_star_script_XLibraryContainer3_idl__ + +#ifndef __com_sun_star_script_XLibraryContainer2_idl__ +#include <com/sun/star/script/XLibraryContainer2.idl> +#endif + + +//============================================================================= + + module com { module sun { module star { module script { + +//============================================================================= + +/** + Extension of <type>XLibraryContainer2</type>. + */ +published interface XLibraryContainer3: com::sun::star::script::XLibraryContainer2 +{ + + /** + returns the location of the library link target. + + The returned URL is literally the same as the one provided in + <member>XLibraryContainer::createLibraryLink</member>. Otherwise the behavior + is the same as <member>XLibraryContainer2::getLibraryLinkURL</member> + */ + string getOriginalLibraryLinkURL( [in] string Name ) + raises( com::sun::star::lang::IllegalArgumentException, + com::sun::star::container::NoSuchElementException ); + + +}; + +//============================================================================= + + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/script/makefile.mk b/offapi/com/sun/star/script/makefile.mk index b694a753f7d7..24d5fcc83af4 100644 --- a/offapi/com/sun/star/script/makefile.mk +++ b/offapi/com/sun/star/script/makefile.mk @@ -43,6 +43,7 @@ IDLFILES=\ LibraryNotLoadedException.idl\ XLibraryContainer.idl\ XLibraryContainer2.idl\ + XLibraryContainer3.idl\ XLibraryContainerPassword.idl\ XLibraryContainerExport.idl\ XPersistentLibraryContainer.idl\ diff --git a/offapi/com/sun/star/sheet/FunctionAccess.idl b/offapi/com/sun/star/sheet/FunctionAccess.idl index aae5aa2c1196..0bce84d3627d 100644 --- a/offapi/com/sun/star/sheet/FunctionAccess.idl +++ b/offapi/com/sun/star/sheet/FunctionAccess.idl @@ -59,6 +59,32 @@ published service FunctionAccess */ interface com::sun::star::sheet::XFunctionAccess; + //------------------------------------------------------------------------- + + /** specifies whether the function call is performed as array function + call. + + <p>If set to <TRUE/>, the result of the function call will be + calculated similar to array formulas in a spreadsheet document. The + return value of the function call will usually be a sequence of + sequences containing the values of the resulting array. Example: If the + function ABS is called for a 3x2 cell range, the result will be a 3x2 + array containing the absolute values of the numbers contained in the + specified cell range.</p> + + <p>If set to <FALSE/>, the result of the function call will be + calculated similar to simple cell formulas in a spreadsheet document. + The return value of the function call will usually be a single value. + Of course, some functions always return an array, for example the + MUNIT function.</p> + + <p>For compatibility with older versions, the default value of this + property is <TRUE/>.</p> + + @since OOo 3.3 + */ + [optional, property] boolean IsArrayFunction; + }; //============================================================================= diff --git a/offapi/com/sun/star/sheet/Spreadsheet.idl b/offapi/com/sun/star/sheet/Spreadsheet.idl index 40361659dd9f..0b21a050d099 100644 --- a/offapi/com/sun/star/sheet/Spreadsheet.idl +++ b/offapi/com/sun/star/sheet/Spreadsheet.idl @@ -96,6 +96,8 @@ #include <com/sun/star/sheet/XExternalSheetName.idl> #endif +#include <com/sun/star/util/Color.idl> + //============================================================================= module com { module sun { module star { module sheet { @@ -264,6 +266,9 @@ service Spreadsheet */ [optional, property] boolean AutomaticPrintArea; + /** specifies the color of the sheet tab, if any. + */ + [optional, property] com::sun::star::util::Color TabColor; }; //============================================================================= diff --git a/offapi/com/sun/star/style/NumberingType.idl b/offapi/com/sun/star/style/NumberingType.idl index 1386305cd3dc..25094b1ed677 100644 --- a/offapi/com/sun/star/style/NumberingType.idl +++ b/offapi/com/sun/star/style/NumberingType.idl @@ -121,6 +121,7 @@ published constants NumberingType //------------------------------------------------------------------------- /** Numbering for Chinese lower case number + as "一,二,三..." */ const short NUMBER_LOWER_ZH = 15; @@ -136,11 +137,13 @@ published constants NumberingType //------------------------------------------------------------------------- /** Bullet for Chinese Tian Gan + as "甲,乙,丙..." */ const short TIAN_GAN_ZH = 18; //------------------------------------------------------------------------- /** Bullet for Chinese Di Zi + as "子,丑,寅..." */ const short DI_ZI_ZH = 19; @@ -171,36 +174,43 @@ published constants NumberingType //------------------------------------------------------------------------- /** Numbering for Korean upper case number + as "壹,貳,參..." */ const short NUMBER_UPPER_KO = 25; //------------------------------------------------------------------------- /** Numbering for Korean hangul number + as "일,이,삼..." */ const short NUMBER_HANGUL_KO = 26; //------------------------------------------------------------------------- /** Bullet for Korean Hangul Jamo + as "ㄱ,ㄴ,ㄷ..." */ const short HANGUL_JAMO_KO = 27; //------------------------------------------------------------------------- /** Bullet for Korean Hangul Syllable + as "가,나,다..." */ const short HANGUL_SYLLABLE_KO = 28; //------------------------------------------------------------------------- /** Bullet for Korean Hangul Circled Jamo + as "㉠,㉡,㉢..." */ const short HANGUL_CIRCLED_JAMO_KO = 29; //------------------------------------------------------------------------- /** Bullet for Korean Hangul Circled Syllable + as "㉮,㉯,㉰..." */ const short HANGUL_CIRCLED_SYLLABLE_KO = 30; //------------------------------------------------------------------------- /** Numbering in Arabic alphabet letters + as "أ,ب,ت..." @since OOo 1.1.2 */ diff --git a/offapi/com/sun/star/task/DocumentMSPasswordRequest2.idl b/offapi/com/sun/star/task/DocumentMSPasswordRequest2.idl new file mode 100755 index 000000000000..94ce75683dea --- /dev/null +++ b/offapi/com/sun/star/task/DocumentMSPasswordRequest2.idl @@ -0,0 +1,68 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright IBM Corporation 2009. + * Copyright 2009 by Sun Microsystems, Inc. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: DocumentMSPasswordRequest.idl,v $ + * $Revision: 1.0 $ + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_task_DocumentMSPasswordRequest2_idl__ +#define __com_sun_star_task_DocumentMSPasswordRequest2_idl__ + +#include <com/sun/star/task/DocumentMSPasswordRequest.idl> + + +//============================================================================= + +module com { module sun { module star { module task { + +//============================================================================= +/** this request specifies if a password for opening or modifying of an encrypted Microsoft Office document is requested. + + <P> + It is supported by <type>InteractionHandler</type> service, and can + be used to interact for a document password. Continuations for using with + the mentioned service are Abort and Approve. + </P> + + @see com::sun::star::task::PasswordRequest + @see com::sun::star::task::DocumentMSPasswordRequest + + @since OOo 3.3 +*/ +exception DocumentMSPasswordRequest2 : DocumentMSPasswordRequest +{ + //------------------------------------------------------------------------- + /** specifies if the requested password is for opening a document or for mofiying it. + */ + boolean IsRequestPasswordToModify; + +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/task/DocumentPasswordRequest2.idl b/offapi/com/sun/star/task/DocumentPasswordRequest2.idl new file mode 100755 index 000000000000..0f49e29255f0 --- /dev/null +++ b/offapi/com/sun/star/task/DocumentPasswordRequest2.idl @@ -0,0 +1,67 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2008 by Sun Microsystems, Inc. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: DocumentPasswordRequest.idl,v $ + * $Revision: 1.8 $ + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_task_DocumentPasswordRequest2_idl__ +#define __com_sun_star_task_DocumentPasswordRequest2_idl__ + +#include <com/sun/star/task/DocumentPasswordRequest.idl> + + +//============================================================================= + +module com { module sun { module star { module task { + +//============================================================================= +/** this request specifies if a password for opening or modifying a document is requested. + + <P> + It is supported by <type>InteractionHandler</type> service, and can + be used to interact for a document password. Continuations for using with + the mentioned service are Abort and Approve. + </P> + + @see com::sun::star::task::PasswordRequest + @see com::sun::star::task::DocumentPasswordRequest + + @since OOo 3.3 +*/ +exception DocumentPasswordRequest2 : DocumentPasswordRequest +{ + //------------------------------------------------------------------------- + /** specifies if the requested password is for opening a document or for mofiying it. + */ + boolean IsRequestPasswordToModify; + +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/task/OfficeRestartManager.idl b/offapi/com/sun/star/task/OfficeRestartManager.idl new file mode 100644 index 000000000000..9205992d169f --- /dev/null +++ b/offapi/com/sun/star/task/OfficeRestartManager.idl @@ -0,0 +1,53 @@ +/************************************************************************* + * + * 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_task_OfficeRestartManager_idl__ +#define __com_sun_star_task_OfficeRestartManager_idl__ + +//============================================================================= + +module com { module sun { module star { module task { + +interface XRestartManager; + +//============================================================================= + +/** This singleton is intended to allow to restart the office asynchronously. + + @since OOo 3.3 + */ +singleton OfficeRestartManager : XRestartManager; + +//============================================================================= + +}; }; }; }; + +//============================================================================= + + +#endif + diff --git a/offapi/com/sun/star/task/XInteractionPassword2.idl b/offapi/com/sun/star/task/XInteractionPassword2.idl new file mode 100644 index 000000000000..925f96f30e5a --- /dev/null +++ b/offapi/com/sun/star/task/XInteractionPassword2.idl @@ -0,0 +1,80 @@ +/************************************************************************* + * + * 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: XInteractionPassword.idl,v $ + * $Revision: 1.8 $ + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_task_XInteractionPassword2_idl__ +#define __com_sun_star_task_XInteractionPassword2_idl__ + +#ifndef __com_sun_star_task_XInteractionPassword_idl__ +#include <com/sun/star/task/XInteractionPassword.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module task { + +//============================================================================= +/** A continuation to get a password from interaction helper, extends + <type>XInteractionPassword</type> with possibility to provide password + to modify. + + @since OOo 3.3 +*/ +published interface XInteractionPassword2 : ::com::sun::star::task::XInteractionPassword +{ + //------------------------------------------------------------------------- + /** stores "password to modify" to the continuation. + */ + void setPasswordToModify( [in] string aPasswd ); + + //------------------------------------------------------------------------- + /** gets "password to modify" from the continuation. + */ + string getPasswordToModify(); + + //------------------------------------------------------------------------- + /** stores "recommend readonly" to the continuation. It specifies whether + the document should be loaded readonly per default. + */ + void setRecommendReadOnly( [in] boolean bReadOnly ); + + //------------------------------------------------------------------------- + /** gets "recommend readonly" from the continuation. It specifies whether + the document should be loaded readonly per default. + */ + boolean getRecommendReadOnly(); + + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/task/XRestartManager.idl b/offapi/com/sun/star/task/XRestartManager.idl new file mode 100644 index 000000000000..102a1044d2e8 --- /dev/null +++ b/offapi/com/sun/star/task/XRestartManager.idl @@ -0,0 +1,99 @@ +/************************************************************************* + * + * 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_task_XRestartManager_idl__ +#define __com_sun_star_task_XRestartManager_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_task_XInteractionHandler_idl__ +#include <com/sun/star/task/XInteractionHandler.idl> +#endif + +#ifndef __com_sun_star_uno_Exception_idl__ +#include <com/sun/star/uno/Exception.idl> +#endif + +//============================================================================ + +module com { module sun { module star { module task { + +//============================================================================= +/** allows to try to restart the office. + + @since OOo3.3 +*/ +published interface XRestartManager : com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------ + /** let the office restart asynchronously + @param xInteractionHandler + the <type scope="com::sun::star::task">InteractionHandler</type> + service implementation, that is used in case a problem is detected + during requesting the restart. + + @throws com::sun::star::uno::Exception + to notify the caller about possible failures + */ + void requestRestart( + [in] com::sun::star::task::XInteractionHandler xInteractionHandler ) + raises( com::sun::star::uno::Exception ); + + //------------------------------------------------------------------------ + /** allows to get info whether the restart has been requested and provide + the initialization status. + + <p> + The office has to call this method just before the main loop has been + started, with the <TRUE/> as argument, so that the implementation + knows that the office is initialized. If the method returns <TRUE/>, + the office should restart without starting the main loop. + </p> + + @param bInitialized + specifies whether the office process is initialized already, + if the caller does not have this information, he should provide + <FALSE/>. + + @returns + <TRUE/> if the office restart has been requested, + <FALSE/> otherwise + + @throws com::sun::star::uno::Exception + to notify the caller about possible failures + */ + boolean isRestartRequested( + [in] boolean bInitialized ) + raises( com::sun::star::uno::Exception ); +}; + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/task/makefile.mk b/offapi/com/sun/star/task/makefile.mk index 3b622b469b63..16b0be56e36c 100644..100755 --- a/offapi/com/sun/star/task/makefile.mk +++ b/offapi/com/sun/star/task/makefile.mk @@ -42,7 +42,9 @@ IDLFILES=\ ClassifiedInteractionRequest.idl\ DocumentMacroConfirmationRequest.idl\ DocumentPasswordRequest.idl\ + DocumentPasswordRequest2.idl\ DocumentMSPasswordRequest.idl\ + DocumentMSPasswordRequest2.idl\ ErrorCodeRequest.idl\ ErrorCodeIOException.idl\ FutureDocumentVersionProductUpdateRequest.idl\ @@ -57,6 +59,7 @@ IDLFILES=\ PasswordContainerInteractionHandler.idl\ PasswordRequest.idl\ PasswordRequestMode.idl\ + OfficeRestartManager.idl\ UnsupportedOverwriteRequest.idl\ UrlRecord.idl\ UserRecord.idl\ @@ -65,12 +68,14 @@ IDLFILES=\ XInteractionAskLater.idl\ XInteractionDisapprove.idl\ XInteractionPassword.idl\ + XInteractionPassword2.idl\ XJob.idl\ XJobExecutor.idl\ XJobListener.idl\ XMasterPasswordHandling.idl\ XMasterPasswordHandling2.idl\ XPasswordContainer.idl\ + XRestartManager.idl\ XStatusIndicator.idl\ XStatusIndicatorFactory.idl\ XStatusIndicatorSupplier.idl\ diff --git a/offapi/com/sun/star/text/TextFrame.idl b/offapi/com/sun/star/text/TextFrame.idl index e1ab64c2e674..e43b3d79197c 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/dialogs/Wizard.idl b/offapi/com/sun/star/ui/dialogs/Wizard.idl new file mode 100644 index 000000000000..4e6b13f44ca2 --- /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 000000000000..34c0d8074889 --- /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 000000000000..271a006346b7 --- /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 000000000000..445f7bbf2a44 --- /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 000000000000..6a51a67360fe --- /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 000000000000..149f8c14709b --- /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 fa11ba35e173..07d762fb0ec6 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/util/InvalidStateException.idl b/offapi/com/sun/star/util/InvalidStateException.idl new file mode 100644 index 000000000000..7d59abbcbac6 --- /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 75b5dde890c0..aa0374296ddb 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\ |