diff options
Diffstat (limited to 'offapi/com/sun/star/script')
49 files changed, 3524 insertions, 0 deletions
diff --git a/offapi/com/sun/star/script/DocumentDialogLibraryContainer.idl b/offapi/com/sun/star/script/DocumentDialogLibraryContainer.idl new file mode 100644 index 000000000000..7dcb64bbdc0c --- /dev/null +++ b/offapi/com/sun/star/script/DocumentDialogLibraryContainer.idl @@ -0,0 +1,82 @@ +/************************************************************************* + * + * 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_script_DocumentDialogLibraryContainer_idl__ +#define __com_sun_star_script_DocumentDialogLibraryContainer_idl__ + +#ifndef __com_sun_star_script_XStorageBasedLibraryContainer_idl__ +#include <com/sun/star/script/XStorageBasedLibraryContainer.idl> +#endif +#ifndef __com_sun_star_embed_XStorageBasedDocument_idl__ +#include <com/sun/star/document/XStorageBasedDocument.idl> +#endif +#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ +#include <com/sun/star/lang/IllegalArgumentException.idl> +#endif + + +//============================================================================= + +module com { module sun { module star { module script { + +//============================================================================= + +/** defines a container of dialog libraries, which is to be made + persistent in a sub storage of a document storage. + + @since OOo 2.3 + */ +service DocumentDialogLibraryContainer : XStorageBasedLibraryContainer +{ + /** creates an instance of the <code>DocumentDialogLibraryContainer</code>, belonging to a document + + <p>The current storage of the document will be set as initial root storage + (see <member>XPersistentLibraryContainer::RootStorage</member>) of the container.</p> + + <p>Usually, you will only create a <code>DocumentDialogLibraryContainer</code> within + the implementation of the document to which the container should belong.</p> + + @param Document + The document to which the container should belong to. Must not be + <NULL/>. + + @throws ::com::sun::star::lang::IllegalArgumentException + if <code>Document</code> does not denote a valid + <type scope="com::sun::star::document">OfficeDocument</type>. + */ + create( [in] ::com::sun::star::document::XStorageBasedDocument Document ) + raises( ::com::sun::star::lang::IllegalArgumentException ); +}; + +//============================================================================= + +}; }; }; }; + +//============================================================================= + +#endif + diff --git a/offapi/com/sun/star/script/DocumentScriptLibraryContainer.idl b/offapi/com/sun/star/script/DocumentScriptLibraryContainer.idl new file mode 100644 index 000000000000..4bb6838af681 --- /dev/null +++ b/offapi/com/sun/star/script/DocumentScriptLibraryContainer.idl @@ -0,0 +1,83 @@ +/************************************************************************* + * + * 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_script_DocumentScriptLibraryContainer_idl__ +#define __com_sun_star_script_DocumentScriptLibraryContainer_idl__ + +#ifndef __com_sun_star_script_XStorageBasedLibraryContainer_idl__ +#include <com/sun/star/script/XStorageBasedLibraryContainer.idl> +#endif +#ifndef __com_sun_star_embed_XStorageBasedDocument_idl__ +#include <com/sun/star/document/XStorageBasedDocument.idl> +#endif +#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ +#include <com/sun/star/lang/IllegalArgumentException.idl> +#endif + + +//============================================================================= + +module com { module sun { module star { module script { + +//============================================================================= + +/** defines a container of StarBasic script libraries, which is to be made + persistent in a sub storage of a document storage. + + @since OOo 2.3 + */ +service DocumentScriptLibraryContainer : XStorageBasedLibraryContainer +{ + /** creates an instance of the <code>DocumentScriptLibraryContainer</code>, belonging to a document + + <p>The current storage of the document will be set as initial root storage + (see <member>XPersistentLibraryContainer::RootStorage</member>) of the container.</p> + + <p>Usually, you will only create a <code>DocumentScriptLibraryContainer</code> within + the implementation of the document to which the container should belong.</p> + + @param Document + The document to which the container should belong to. Must not be + <NULL/>. + + @throws ::com::sun::star::lang::IllegalArgumentException + if <code>Document</code> does not denote a valid + <type scope="com::sun::star::document">OfficeDocument</type>. + */ + create( [in] ::com::sun::star::document::XStorageBasedDocument Document ) + raises( ::com::sun::star::lang::IllegalArgumentException ); + +}; + +//============================================================================= + +}; }; }; }; + +//============================================================================= + +#endif + diff --git a/offapi/com/sun/star/script/LibraryNotLoadedException.idl b/offapi/com/sun/star/script/LibraryNotLoadedException.idl new file mode 100644 index 000000000000..8a825fe7ce09 --- /dev/null +++ b/offapi/com/sun/star/script/LibraryNotLoadedException.idl @@ -0,0 +1,55 @@ +/************************************************************************* + * 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_script_LibraryNotLoadedException_idl__ +#define __com_sun_star_script_LibraryNotLoadedException_idl__ + +#ifndef __com_sun_star_uno_Exception_idl__ +#include <com/sun/star/uno/Exception.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module script { + +//============================================================================= + +/** is thrown when an operation on a unloaded library is attempted which requires the library + being loaded. + + @since OOo 3.0 +*/ +exception LibraryNotLoadedException : com::sun::star::uno::Exception +{ +}; + +//============================================================================= + +}; }; }; }; + +//============================================================================= + +#endif diff --git a/offapi/com/sun/star/script/ModuleInfo.idl b/offapi/com/sun/star/script/ModuleInfo.idl new file mode 100644 index 000000000000..158ba387be6b --- /dev/null +++ b/offapi/com/sun/star/script/ModuleInfo.idl @@ -0,0 +1,55 @@ +/************************************************************************* + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: ModuleInfo.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: rt $ $Date: 2006/05/05 10:14:46 $ + * + * The Contents of this file are made available subject to + * the terms of GNU Lesser General Public License Version 2.1. + * + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2005 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library 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 for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + ************************************************************************/ + +#ifndef __com_sun_star_script_ModuleInfo_idl__ +#define __com_sun_star_script_ModuleInfo_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +//============================================================================= +module com { module sun { module star { module script { +struct ModuleInfo +{ + com::sun::star::uno::XInterface ModuleObject; + long ModuleType; +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/script/ModuleSizeExceededRequest.idl b/offapi/com/sun/star/script/ModuleSizeExceededRequest.idl new file mode 100644 index 000000000000..44c0702b74d5 --- /dev/null +++ b/offapi/com/sun/star/script/ModuleSizeExceededRequest.idl @@ -0,0 +1,55 @@ +/************************************************************************* + * + * 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_document_ModuleSizeExceededRequest_idl__ +#define __com_sun_star_document_ModuleSizeExceededRequest_idl__ + +#ifndef __com_sun_star_uno_Exception_idl__ +#include <com/sun/star/uno/Exception.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module script { + +//============================================================================= +/** Is used for interaction handle in case password protected modules exceed the size that can be stored in Openoffice 2.x, 1.x formats + +*/ +exception ModuleSizeExceededRequest : ::com::sun::star::uno::Exception +{ + /** The name of the modules that exceed size that can be stored + */ + sequence< string > Names; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/script/ModuleType.idl b/offapi/com/sun/star/script/ModuleType.idl new file mode 100644 index 000000000000..a9bde042fa5a --- /dev/null +++ b/offapi/com/sun/star/script/ModuleType.idl @@ -0,0 +1,72 @@ +/************************************************************************* + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: ModuleType.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: rt $ $Date: 2006/05/05 10:14:46 $ + * + * The Contents of this file are made available subject to + * the terms of GNU Lesser General Public License Version 2.1. + * + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2005 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library 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 for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + ************************************************************************/ + +#ifndef __com_sun_star_script_ModuleType_idl__ +#define __com_sun_star_script_ModuleType_idl__ + +//============================================================================= + +module com { module sun { module star { module script { + +published constants ModuleType +{ + // ------------------------------------------------------------------------ + + const long UNKNOWN = 0; + + // ------------------------------------------------------------------------ + + const long NORMAL = 1; + + // ------------------------------------------------------------------------ + + const long CLASS = 2; + + // ------------------------------------------------------------------------ + + const long FORM = 3; + + // ------------------------------------------------------------------------ + + const long DOCUMENT = 4; + + // ------------------------------------------------------------------------ +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/script/XLibraryContainer.idl b/offapi/com/sun/star/script/XLibraryContainer.idl new file mode 100644 index 000000000000..3974aaa436da --- /dev/null +++ b/offapi/com/sun/star/script/XLibraryContainer.idl @@ -0,0 +1,123 @@ +/************************************************************************* + * + * 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_script_XLibraryContainer_idl__ +#define __com_sun_star_script_XLibraryContainer_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_container_XNameContainer_idl__ +#include <com/sun/star/container/XNameContainer.idl> +#endif + +#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ +#include <com/sun/star/lang/IllegalArgumentException.idl> +#endif + +#ifndef __com_sun_star_container_NoSuchElementException_idl__ +#include <com/sun/star/container/NoSuchElementException.idl> +#endif + +#ifndef __com_sun_star_container_ElementExistException_idl__ +#include <com/sun/star/container/ElementExistException.idl> +#endif + +#ifndef __com_sun_star_lang_WrappedTargetException_idl__ +#include <com/sun/star/lang/WrappedTargetException.idl> +#endif + +#ifndef __com_sun_star_container_ElementExistException_idl__ +#include <com/sun/star/container/ElementExistException.idl> +#endif +#ifndef __com_sun_star_lang_WrappedTargetException_idl__ +#include <com/sun/star/lang/WrappedTargetException.idl> +#endif + + +//============================================================================= + +module com { module sun { module star { module script { + +//============================================================================= + +/** + Provides access to a library system. + */ +published interface XLibraryContainer: com::sun::star::container::XNameAccess +{ + /** + Creates a new library + */ + com::sun::star::container::XNameContainer createLibrary( [in] string Name ) + raises( com::sun::star::lang::IllegalArgumentException, + com::sun::star::container::ElementExistException ); + + /** + Creates a link to an "external" library that then can be + accessed using this library manager. The format of the + StorageURL is a matter of the implementation. If the read + only flag is set, the linked library cannot be modified. + In this case, the returned interface really is only an + XNameAccess. If ReadOnly is false (and the referenced + storage allows write access) the returned interface also + can be a <type scope="com::sun::star::container">XNameContainer</type>. + */ + com::sun::star::container::XNameAccess createLibraryLink( [in] string Name, [in] string StorageURL, [in] boolean ReadOnly ) + raises( com::sun::star::lang::IllegalArgumentException, + com::sun::star::container::ElementExistException ); + + /** removes the library item with the specified name. If the accessed + library item is a link only the link is removed, not the target library. + */ + void removeLibrary( [in] string Name ) + raises( com::sun::star::container::NoSuchElementException, + com::sun::star::lang::WrappedTargetException ); + + /** + returns true if the accessed library is already loaded from + the storage, otherwise false. + */ + boolean isLibraryLoaded( [in] string Name ) + raises( com::sun::star::container::NoSuchElementException ); + + /** + Causes the accessed library to be loaded from its storage + if it hasn't already been loaded. + */ + void loadLibrary( [in] string Name ) + raises( com::sun::star::container::NoSuchElementException, + com::sun::star::lang::WrappedTargetException ); + +}; + +//============================================================================= + + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/script/XLibraryContainer2.idl b/offapi/com/sun/star/script/XLibraryContainer2.idl new file mode 100644 index 000000000000..2d315ca3a88f --- /dev/null +++ b/offapi/com/sun/star/script/XLibraryContainer2.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_script_XLibraryContainer2_idl__ +#define __com_sun_star_script_XLibraryContainer2_idl__ + +#ifndef __com_sun_star_script_XLibraryContainer_idl__ +#include <com/sun/star/script/XLibraryContainer.idl> +#endif + + +//============================================================================= + + module com { module sun { module star { module script { + +//============================================================================= + +/** + Extension of <type>XLibraryContainer</type> to provide additional information + about the libraries contained in a library container + */ +published interface XLibraryContainer2: com::sun::star::script::XLibraryContainer +{ + /** + returns true if the accessed library item is a link, + e.g., created by createLibraryLink, otherwise false. + */ + boolean isLibraryLink( [in] string Name ) + raises( com::sun::star::container::NoSuchElementException ); + + /** + returns the location of the library link target. + Should return the same URL that was passed to + createLibraryLink in the StorageURL parameter. + + If the accessed library item exists but isn't a + link, a IllegalArgumentException is thrown + */ + string getLibraryLinkURL( [in] string Name ) + raises( com::sun::star::lang::IllegalArgumentException, + com::sun::star::container::NoSuchElementException ); + + /** + returns true if the accessed library item (library or library + link) is read only. A library can be read only because it was + set to read only using the methods provided by this interface + or because of other reasons depending on the implementation + (e.g., file system write protection) + */ + boolean isLibraryReadOnly( [in] string Name ) + raises( com::sun::star::container::NoSuchElementException ); + + /** + Sets the accessed library item (library or library link) to + read only according to the flag bReadOnly (true means read only) + */ + void setLibraryReadOnly( [in] string Name, [in] boolean bReadOnly ) + raises( com::sun::star::container::NoSuchElementException ); + + /** renames the library item with the specified name. If the accessed + library item is a link only the link is renamed, not the target library. + If a library with the new name exists already a + com::sun::star::container::ElementExistException is thrown. + */ + void renameLibrary( [in] string Name, [in] string NewName ) + raises( com::sun::star::container::NoSuchElementException, + com::sun::star::container::ElementExistException ); + +}; + +//============================================================================= + + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/script/XLibraryContainer3.idl b/offapi/com/sun/star/script/XLibraryContainer3.idl new file mode 100644 index 000000000000..1045fc7a295c --- /dev/null +++ b/offapi/com/sun/star/script/XLibraryContainer3.idl @@ -0,0 +1,66 @@ +/************************************************************************* + * + * 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_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/XLibraryContainerExport.idl b/offapi/com/sun/star/script/XLibraryContainerExport.idl new file mode 100644 index 000000000000..cdaa975f8d5e --- /dev/null +++ b/offapi/com/sun/star/script/XLibraryContainerExport.idl @@ -0,0 +1,80 @@ +/************************************************************************* + * + * 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_script_XLibraryContainerExport_idl__ +#define __com_sun_star_script_XLibraryContainerExport_idl__ + +#ifndef __com_sun_star_task_XInteractionHandler_idl__ +#include <com/sun/star/task/XInteractionHandler.idl> +#endif + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_container_NoSuchElementException_idl__ +#include <com/sun/star/container/NoSuchElementException.idl> +#endif + + +//============================================================================= + + module com { module sun { module star { module script { + +//============================================================================= + +/** + Extension of XLibraryContainer to provide functionality to + store a library to a location represented by a URL. + */ +interface XLibraryContainerExport : com::sun::star::uno::XInterface +{ + /** + Exports a library specified by Name to the location + specified by the passed URL string. + + An interaction handler can be passed to be used for internal + ucb operations. Exceptions not processed by this handler will + be passed as com::sun::star::uno::Exception. If this parameter + is null this applies to all exceptions thrown by ucb. + + @see com::sun::star::task::InteractionHandler + + If a library with the this name doesn't exist a + com::sun::star::container::NoSuchElementException is thrown. + */ + void exportLibrary( [in] string Name, [in] string URL, + [in] com::sun::star::task::XInteractionHandler Handler ) + raises( com::sun::star::uno::Exception, + com::sun::star::container::NoSuchElementException ); +}; + +//============================================================================= + + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/script/XLibraryContainerPassword.idl b/offapi/com/sun/star/script/XLibraryContainerPassword.idl new file mode 100644 index 000000000000..26cb1d211993 --- /dev/null +++ b/offapi/com/sun/star/script/XLibraryContainerPassword.idl @@ -0,0 +1,143 @@ +/************************************************************************* + * + * 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_script_XLibraryContainerPassword_idl__ +#define __com_sun_star_script_XLibraryContainerPassword_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ +#include <com/sun/star/lang/IllegalArgumentException.idl> +#endif + +#ifndef __com_sun_star_container_NoSuchElementException_idl__ +#include <com/sun/star/container/NoSuchElementException.idl> +#endif + + +//============================================================================= + + module com { module sun { module star { module script { + +//============================================================================= + +/** + Extension of XLibraryContainer to provide password functionality. + This interface should be implemented together with XLibraryContainer2 + </p> + */ +published interface XLibraryContainerPassword: com::sun::star::uno::XInterface +{ + /** + Returns true if the accessed library item is protected + by a password. + + If a library with the this name doesn't exist a + com::sun::star::container::NoSuchElementException is thrown. + */ + boolean isLibraryPasswordProtected( [in] string Name ) + raises( com::sun::star::container::NoSuchElementException ); + + /** + Returns true if the accessed library item is protected by a + password (see isLibraryPasswordProtected) and the password + was already verified with verifyLibraryPassword or if an + initial password was set with changeLibraryPassword. + + If a library with the this name doesn't exist a + com::sun::star::container::NoSuchElementException is thrown. + + If the library exists but isn't password protected a + com::sun::star::lang::IllegalArgumentException is thrown. + */ + boolean isLibraryPasswordVerified( [in] string Name ) + raises( com::sun::star::lang::IllegalArgumentException, + com::sun::star::container::NoSuchElementException ); + + /** + Verifies the library's password. If the correct password + was passed, the method returns true and further calls to + isLibraryPasswordVerified will also return true. + + If a library with the this name doesn't exist a + com::sun::star::container::NoSuchElementException is thrown. + + If the library exists but isn't password protected a + com::sun::star::lang::IllegalArgumentException is thrown. + + If the library password is already verified a + com::sun::star::lang::IllegalArgumentException is thrown. + */ + boolean verifyLibraryPassword( [in] string Name, [in] string Password ) + raises( com::sun::star::lang::IllegalArgumentException, + com::sun::star::container::NoSuchElementException ); + + /** + Changes the library's password. + + If the library wasn't password protected before: + The OldPassword parameter has to be an empty string. + Afterwards calls to isLibraryPasswordProtected and + isLibraryPasswordVerified for this library will + return true. + + If the library already was password protected: + The OldPassword parameter has to be set to the + previous defined password. If then the NewPassword + parameter is an empty string the library password + protection will be disabled afterwards (afterwards + calls to isLibraryPasswordProtected for this library + will return false). If the NewPassword parameter is + not an empty string it will accepted as the new + password for the library. + + If a library with the this name doesn't exist but isn't + com::sun::star::container::NoSuchElementException is thrown. + + If the library exists and is password protected and a + wrong OldPassword is passed to the method a + com::sun::star::lang::IllegalArgumentException is thrown. + + If the library exists and isn't password protected and + the OldPassword isn't an empty string or the library is + read only a + com::sun::star::lang::IllegalArgumentException is thrown. + */ + void changeLibraryPassword( [in] string Name, + [in] string OldPassword, [in] string NewPassword ) + raises( com::sun::star::lang::IllegalArgumentException, + com::sun::star::container::NoSuchElementException ); + +}; + +//============================================================================= + + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/script/XPersistentLibraryContainer.idl b/offapi/com/sun/star/script/XPersistentLibraryContainer.idl new file mode 100644 index 000000000000..200bd1d164ca --- /dev/null +++ b/offapi/com/sun/star/script/XPersistentLibraryContainer.idl @@ -0,0 +1,104 @@ +/************************************************************************* + * + * 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_script_XPersistentLibraryContainer_idl__ +#define __com_sun_star_script_XPersistentLibraryContainer_idl__ + +#ifndef __com_sun_star_util_XModifiable_idl__ +#include <com/sun/star/util/XModifiable.idl> +#endif +#ifndef __com_sun_star_script_XLibraryContainer2_idl__ +#include <com/sun/star/script/XLibraryContainer2.idl> +#endif +#ifndef __com_sun_star_lang_WrappedTargetException_idl__ +#include <com/sun/star/lang/WrappedTargetException.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module script { + +//============================================================================= + +/** describes a container of script libraries which is persistent. + + <p>The type of persistence of the container elements is not defined here, + but in derived interfaces or services using + <code>XPersistentLibraryContainer</code>.</p> + + <p>The actual libraries are stored in some object - a sub folder, or a sub storage, + for example - below the root location.</p> + + @since OOo 2.3 + */ +interface XPersistentLibraryContainer +{ + interface ::com::sun::star::util::XModifiable; + interface XLibraryContainer2; + + /** denotes the root location associated with the container. + + <p>The type of this location - it might be a folder in a file system, + a storage, or anything else - is not specified here, but in derived interfaces + or services implementing <code>XPersistentLibraryContainer</code>.</p> + + <p>All operations of the library container take place in a location below + the root location, the so-called container location, whose + name is exposed as <member>ContainerLocationName</member>.</p> + + @see ContainerLocationName + */ + [attribute, readonly] any RootLocation; + + /** denotes the name of the sub location where the container elements are + actually stored. + + @see RootLocation + */ + [attribute, readonly] string ContainerLocationName; + + /** stores the libraries to the current location. + + @throws ::com::sun::star::lang::WrappedTargetException + if an error occurs during storing. + + @see RootLocation + @see ContainerLocationName + */ + void storeLibraries() + raises ( ::com::sun::star::lang::WrappedTargetException ); + +}; + +//============================================================================= + +}; }; }; }; + +//============================================================================= + +#endif + diff --git a/offapi/com/sun/star/script/XStorageBasedLibraryContainer.idl b/offapi/com/sun/star/script/XStorageBasedLibraryContainer.idl new file mode 100644 index 000000000000..13c9ab990d44 --- /dev/null +++ b/offapi/com/sun/star/script/XStorageBasedLibraryContainer.idl @@ -0,0 +1,105 @@ +/************************************************************************* + * + * 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_script_XStorageBasedLibraryContainer_idl__ +#define __com_sun_star_script_XStorageBasedLibraryContainer_idl__ + +#ifndef __com_sun_star_embed_XStorage_idl__ +#include <com/sun/star/embed/XStorage.idl> +#endif +#ifndef __com_sun_star_script_XPersistentLibraryContainer_idl__ +#include <com/sun/star/script/XPersistentLibraryContainer.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module script { + +//============================================================================= + +/** is the interface for an <type>XLibraryContainer</type> which can be made + persistent in an <type scope="com::sun::star::embed">XStorage</type>. + + <p>A persistent library container is associated with a root storage. The + container is responsible for a particular sub storage of the root storage, + the container storage.</p> + + @since OOo 2.3 + */ +interface XStorageBasedLibraryContainer +{ + interface XPersistentLibraryContainer; + + /** denotes the root storage associated with the container. + + <p>Effectively, this attribute is a typed version of + <member>XPersistentLibraryContainer::RootLocation</member>, it's guaranteed + that at every time, <code>XPersistentLibraryContainer::RootLocation</code> and + <code>RootStorage</code> have the same value.</p> + + <p>You should only <em>set</em> this attribute to a new value if you previously + called storeLibrariesToStorage with the same storage. Setting this attribute + to a storage into which the container has not been stored previously might + result in unexpected behaviour.</p> + */ + [attribute] ::com::sun::star::embed::XStorage RootStorage + { + set raises ( ::com::sun::star::lang::IllegalArgumentException ); + }; + + /** stores the libraries to a storage other than the current container storage + + <p>Note that the library continer is not automatically associated with the + new root storage. Instead, you need to manually set the <type>RootStroage</type> + attribute afterwards. This separation allows for Save-To as well Save-As + operations.</p> + + @param RootStorage + denotes the root storage into which the libraries should be written, which + must not be <NULL/>.<br/> + Note that the actual libraries are written into a sub storage of this + root storage, as usual. + + @throws ::com::sun::star::lang::IllegalArgumentException + if the <code>RootStorage</code> parameter is <NULL/>, or equals + <member>RootStorage</member>. + + @throws ::com::sun::star::lang::WrappedTargetException + if an error occurs during storing. + */ + void storeLibrariesToStorage( [in] ::com::sun::star::embed::XStorage RootStorage ) + raises ( ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::WrappedTargetException ); +}; + +//============================================================================= + +}; }; }; }; + +//============================================================================= + +#endif diff --git a/offapi/com/sun/star/script/browse/BrowseNode.idl b/offapi/com/sun/star/script/browse/BrowseNode.idl new file mode 100755 index 000000000000..fa209b84efa1 --- /dev/null +++ b/offapi/com/sun/star/script/browse/BrowseNode.idl @@ -0,0 +1,62 @@ +/************************************************************************* + * + * 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_script_browse_BrowseNode_idl__ +#define __com_sun_star_script_browse_BrowseNode_idl__ + +#ifndef __com_sun_star_script_browse_XBrowseNode_idl__ +#include <com/sun/star/script/browse/XBrowseNode.idl> +#endif +#ifndef __com_sun_star_script_XInvocation_idl__ +#include <com/sun/star/script/XInvocation.idl> +#endif + +module com { + module sun { + module star { + module script { + module browse { + +/** + This service provides access to the Macros and Macro containers via the + XBrowseNode interface. XInvocation is an optional interface that is used + to execute macros, or to create/delete/rename macros or macro containers. + + @since OOo 2.0.0 +*/ +service BrowseNode +{ + interface ::com::sun::star::script::browse::XBrowseNode; + [ optional ] interface ::com::sun::star::script::XInvocation; +}; + + }; + }; + }; + }; +}; +#endif diff --git a/offapi/com/sun/star/script/browse/BrowseNodeFactory.idl b/offapi/com/sun/star/script/browse/BrowseNodeFactory.idl new file mode 100755 index 000000000000..b54d8e7e6137 --- /dev/null +++ b/offapi/com/sun/star/script/browse/BrowseNodeFactory.idl @@ -0,0 +1,64 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_script_browse_BrowseNodeFactory_idl__ +#define __com_sun_star_script_browse_BrowseNodeFactory_idl__ + +#ifndef __com_sun_star_script_browse_XBrowseNodeFactory_idl__ +#include <com/sun/star/script/browse/XBrowseNodeFactory.idl> +#endif + +module com { module sun { module star { module script { module browse { + +/** + This service is used to create Root XBrowseNodes. + + @since OOo 2.0.0 +*/ +service BrowseNodeFactory +{ + interface XBrowseNodeFactory; +}; + +/** + The one and only BrowseNodeFactory. + + To get the singleton call getValueByName on the component context + <pre> + /singletons/com.sun.star.script.theBrowseNodeFactory + </pre> + + @since OOo 2.0.0 +*/ +singleton theBrowseNodeFactory +{ + service BrowseNodeFactory; +}; + +}; }; }; }; }; + +#endif diff --git a/offapi/com/sun/star/script/browse/BrowseNodeFactoryViewTypes.idl b/offapi/com/sun/star/script/browse/BrowseNodeFactoryViewTypes.idl new file mode 100755 index 000000000000..84ef8e8e1733 --- /dev/null +++ b/offapi/com/sun/star/script/browse/BrowseNodeFactoryViewTypes.idl @@ -0,0 +1,51 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_script_browse_BrowseNodeFactoryViewTypes_idl__ +#define __com_sun_star_script_browse_BrowseNodeFactoryViewTypes_idl__ + + +module com { module sun { module star { module script { module browse { +//============================================================================== +/** + These constants define the three different types of views available from + BrowseNodeFactory. +*/ +constants BrowseNodeFactoryViewTypes +{ + /** + Indicates view is a script selector + */ + const short MACROSELECTOR = 0; + /** + Indicates view is script organizer + */ + const short MACROORGANIZER = 1; +}; + +}; }; }; }; }; +#endif diff --git a/offapi/com/sun/star/script/browse/BrowseNodeTypes.idl b/offapi/com/sun/star/script/browse/BrowseNodeTypes.idl new file mode 100755 index 000000000000..f790541cb8a7 --- /dev/null +++ b/offapi/com/sun/star/script/browse/BrowseNodeTypes.idl @@ -0,0 +1,56 @@ +/************************************************************************* + * + * 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_script_browse_BrowseNodeTypes_idl__ +#define __com_sun_star_script_browse_BrowseNodeTypes_idl__ + + +module com { module sun { module star { module script { module browse { +//============================================================================== +/** + These constants define the three different types of nodes in the BrowseNode + hierarchy. +*/ +constants BrowseNodeTypes +{ + /** + Indicates node is a script + */ + const short SCRIPT = 0; + /** + Indicates node is a container + */ + const short CONTAINER = 1; + /** + Indicates node is root of the tree. + */ + const short ROOT = 2; + +}; + +}; }; }; }; }; +#endif diff --git a/offapi/com/sun/star/script/browse/XBrowseNode.idl b/offapi/com/sun/star/script/browse/XBrowseNode.idl new file mode 100755 index 000000000000..da493f604abb --- /dev/null +++ b/offapi/com/sun/star/script/browse/XBrowseNode.idl @@ -0,0 +1,83 @@ +/************************************************************************* + * + * 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_script_browse_XBrowseNode_idl__ +#define __com_sun_star_script_browse_XBrowseNode_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +module com { module sun { module star { module script { module browse { +//============================================================================== +/** + This interface represents a node in the hierarchy used to browse + available scripts. + Objects implementing this interface are expected to also implement + com.sun.star.beans.XPropertySet and, optionally, + com.sun.star.script.XInvocation (see the Developers' Guide for + more details). +*/ +interface XBrowseNode : ::com::sun::star::uno::XInterface +{ + //----------------------------------------------------------------------- + /** + Get the name of the node + + @return + The <atom>string</atom> name of this node + */ + string getName(); + + //---------------------------------------------------------------------- + /** + Get the children of this node + + @returns + <type scope="::com::sun::star::script::browse">XBrowseNode</type> sequence of child nodes + */ + sequence < XBrowseNode > getChildNodes(); + + //---------------------------------------------------------------------- + /** + Indicates if this node contains any children + + @returns + <atom> boolean </atom> true if there are child nodes. + */ + boolean hasChildNodes(); + + //------------------------------------------------------------------- + /** the type of the node. + @returns A <atom>short</atom> reresenting the type of this node. + */ + short getType(); + +}; + +}; }; }; }; }; +#endif diff --git a/offapi/com/sun/star/script/browse/XBrowseNodeFactory.idl b/offapi/com/sun/star/script/browse/XBrowseNodeFactory.idl new file mode 100644 index 000000000000..41ef7e038bde --- /dev/null +++ b/offapi/com/sun/star/script/browse/XBrowseNodeFactory.idl @@ -0,0 +1,66 @@ +/************************************************************************* + * + * 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_script_provider_XBrowseNodeFactory_idl__ +#define __com_sun_star_script_provider_XBrowseNodeFactory_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif +#ifndef __com_sun_star_script_browse_XBrowseNode_idl__ +#include <com/sun/star/script/browse/XBrowseNode.idl> +#endif +#ifndef __com_sun_star_script_browse_BrowseNodeFactoryViewTypes_idl__ +#include <com/sun/star/script/browse/BrowseNodeFactoryViewTypes.idl> +#endif + +//=========================================================================== + +module com { module sun { module star { module script { module browse { + +//=========================================================================== +/** + This interface provides a factory for obtaining objects implmenting the + XBrowseNode interface. +*/ +interface XBrowseNodeFactory : ::com::sun::star::uno::XInterface { + + //---------------------------------------------------------------------- + /** a factory method for the creation of XBrowseNodes + ( view ) <type scope="::com::sun::star::script::browse">BrowseNodeFactoryViewTypes</type> specifies the type of view to be returned + + @returns + an object implementing <type scope="::com::sun::star::script::browse">XBrowseNode</type> + + */ + com::sun::star::script::browse::XBrowseNode createView( [in] short viewType ); +}; + +//=========================================================================== +}; }; }; }; }; // com::sun::star::script::provider + +#endif diff --git a/offapi/com/sun/star/script/browse/makefile.mk b/offapi/com/sun/star/script/browse/makefile.mk new file mode 100644 index 000000000000..4a2fdfddf185 --- /dev/null +++ b/offapi/com/sun/star/script/browse/makefile.mk @@ -0,0 +1,52 @@ +#************************************************************************* +# +# 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. +# +#************************************************************************* + +PRJ=..$/..$/..$/..$/.. + +PRJNAME=offapi + +TARGET=csssbrowse +PACKAGE=com$/sun$/star$/script$/browse + +# --- Settings ----------------------------------------------------- +.INCLUDE : $(PRJ)$/util$/makefile.pmk + +# ------------------------------------------------------------------------ + +IDLFILES=\ + XBrowseNode.idl\ + XBrowseNodeFactory.idl\ + BrowseNodeFactoryViewTypes.idl\ + BrowseNodeFactory.idl\ + BrowseNode.idl\ + BrowseNodeTypes.idl + + +# ------------------------------------------------------------------ + +.INCLUDE : target.mk +.INCLUDE : $(PRJ)$/util$/target.pmk diff --git a/offapi/com/sun/star/script/makefile.mk b/offapi/com/sun/star/script/makefile.mk new file mode 100644 index 000000000000..da8e9110d1fa --- /dev/null +++ b/offapi/com/sun/star/script/makefile.mk @@ -0,0 +1,58 @@ +#************************************************************************* +# +# 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. +# +#************************************************************************* + +PRJ=..$/..$/..$/.. + +PRJNAME=offapi + +TARGET=cssscript +PACKAGE=com$/sun$/star$/script + +# --- Settings ----------------------------------------------------- +.INCLUDE : $(PRJ)$/util$/makefile.pmk + +# ------------------------------------------------------------------------ + +IDLFILES=\ + DocumentDialogLibraryContainer.idl\ + DocumentScriptLibraryContainer.idl\ + LibraryNotLoadedException.idl\ + XLibraryContainer.idl\ + XLibraryContainer2.idl\ + XLibraryContainer3.idl\ + XLibraryContainerPassword.idl\ + XLibraryContainerExport.idl\ + XPersistentLibraryContainer.idl\ + XStorageBasedLibraryContainer.idl\ + ModuleSizeExceededRequest.idl\ + ModuleInfo.idl\ + ModuleType.idl + +# ------------------------------------------------------------------ + +.INCLUDE : target.mk +.INCLUDE : $(PRJ)$/util$/target.pmk diff --git a/offapi/com/sun/star/script/provider/LanguageScriptProvider.idl b/offapi/com/sun/star/script/provider/LanguageScriptProvider.idl new file mode 100755 index 000000000000..8072416c62f1 --- /dev/null +++ b/offapi/com/sun/star/script/provider/LanguageScriptProvider.idl @@ -0,0 +1,55 @@ +/************************************************************************* + * + * 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_script_provider_LanguageScriptProvider_idl__ +#define __com_sun_star_script_provider_LanguageScriptProvider_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_script_provider_ScriptProvider_idl__ +#include <com/sun/star/script/provider/ScriptProvider.idl> +#endif + +//=========================================================================== + +module com { module sun { module star { module script { module provider { + +//=========================================================================== +/** + This service provides a means of browsing and invoking scripts in + a single language. +*/ +service LanguageScriptProvider { + service ::com::sun::star::script::provider::ScriptProvider; +}; + +//=========================================================================== +}; }; }; }; }; // ::com::sun::star::script::provider + +#endif diff --git a/offapi/com/sun/star/script/provider/MasterScriptProvider.idl b/offapi/com/sun/star/script/provider/MasterScriptProvider.idl new file mode 100755 index 000000000000..7a2bb02a194c --- /dev/null +++ b/offapi/com/sun/star/script/provider/MasterScriptProvider.idl @@ -0,0 +1,55 @@ +/************************************************************************* + * + * 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_script_provider_MasterScriptProvider_idl__ +#define __com_sun_star_script_provider_MasterScriptProvider_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_script_provider_ScriptProvider_idl__ +#include <com/sun/star/script/provider/ScriptProvider.idl> +#endif + +//=========================================================================== + +module com { module sun { module star { module script { module provider { + +//=========================================================================== +/** + This service acts as a wrapper around the various language specific + ScriptProviders. +*/ +service MasterScriptProvider { + service ::com::sun::star::script::provider::ScriptProvider; +}; + +//=========================================================================== +}; }; }; }; }; // ::com::sun::star::script::provider + +#endif diff --git a/offapi/com/sun/star/script/provider/MasterScriptProviderFactory.idl b/offapi/com/sun/star/script/provider/MasterScriptProviderFactory.idl new file mode 100755 index 000000000000..bbc5f74ff011 --- /dev/null +++ b/offapi/com/sun/star/script/provider/MasterScriptProviderFactory.idl @@ -0,0 +1,64 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_script_provider_MasterScriptProviderFactory_idl__ +#define __com_sun_star_script_provider_MasterScriptProviderFactory_idl__ + + +#ifndef __com_sun_star_script_provider_XScriptProviderFactory_idl__ +#include <com/sun/star/script/provider/XScriptProviderFactory.idl> +#endif + +module com { module sun { module star { module script { module provider { + +/** + This service is used to create MasterScriptProviders. + Note: You shouldn't ever instantiate the MasterScriptProvider + service directly, you should always use this service. +*/ +service MasterScriptProviderFactory +{ + interface XScriptProviderFactory; +}; + +/** + The one and only MasterScriptProviderFactory + + To get the singleton call getValueByName on the component context + <pre> + /singletons/com.sun.star.script.provider.theMasterScriptProviderFactory + </pre> + +*/ +singleton theMasterScriptProviderFactory +{ + service MasterScriptProviderFactory; +}; + +}; }; }; }; }; + +#endif diff --git a/offapi/com/sun/star/script/provider/ScriptErrorRaisedException.idl b/offapi/com/sun/star/script/provider/ScriptErrorRaisedException.idl new file mode 100644 index 000000000000..72fac1b09749 --- /dev/null +++ b/offapi/com/sun/star/script/provider/ScriptErrorRaisedException.idl @@ -0,0 +1,59 @@ +/************************************************************************* + * + * 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_script_provider_ScriptErrorRaisedException_idl__ +#define __com_sun_star_script_provider_ScriptErrorRaisedException_idl__ + +#ifndef __com_sun_star_uno_Exception_idl__ +#include <com/sun/star/uno/Exception.idl> +#endif + +//=========================================================================== + +module com { module sun { module star { module script { module provider { + +//=========================================================================== +/** + is a checked exception that represents an error encountered + by a LanguageScriptProvider whilst executing a script +*/ +exception ScriptErrorRaisedException : com::sun::star::uno::Exception { + /** Name of script where error occured + */ + string scriptName; + /** Scripting language of script that generated exception + */ + string language; + /** line number where error occured. + */ + long lineNum; +}; + +//=========================================================================== +}; }; }; }; }; // ::com::sun::star::script::provider + +#endif diff --git a/offapi/com/sun/star/script/provider/ScriptExceptionRaisedException.idl b/offapi/com/sun/star/script/provider/ScriptExceptionRaisedException.idl new file mode 100644 index 000000000000..c7cc7b6f88f3 --- /dev/null +++ b/offapi/com/sun/star/script/provider/ScriptExceptionRaisedException.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_script_provider_ScriptExceptionRaisedException_idlR__ +#define __com_sun_star_script_provider_ScriptExceptionRaisedException_idl__ + +#ifndef __com_sun_star_script_provider_ScriptErrorRaisedException_idlR__ +#include <com/sun/star/script/provider/ScriptErrorRaisedException.idl> +#endif + +//=========================================================================== + +module com { module sun { module star { module script { module provider { + +//=========================================================================== +/** + is a checked exception that represents the detail of an exception + thrown by a LanguageScriptProvider whilst executing a script +*/ +exception ScriptExceptionRaisedException : ::com::sun::star::script::provider::ScriptErrorRaisedException { + /** Name of script where error occured + */ + string exceptionType; +}; + +//=========================================================================== +}; }; }; }; }; // ::com::sun::star::script::provider + +#endif diff --git a/offapi/com/sun/star/script/provider/ScriptFrameworkErrorException.idl b/offapi/com/sun/star/script/provider/ScriptFrameworkErrorException.idl new file mode 100644 index 000000000000..6444e1f92b62 --- /dev/null +++ b/offapi/com/sun/star/script/provider/ScriptFrameworkErrorException.idl @@ -0,0 +1,59 @@ +/************************************************************************* + * + * 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_script_provider_ScriptFrameworkErrorException_idl__ +#define __com_sun_star_script_provider_ScriptFrameworkErrorException_idl__ + +#ifndef __com_sun_star_uno_Exception_idl__ +#include <com/sun/star/uno/Exception.idl> +#endif + +//=========================================================================== + +module com { module sun { module star { module script { module provider { + +//=========================================================================== +/** + is a checked exception that represents an error encountered + by the Scripting Framework whilst executing a script +*/ +exception ScriptFrameworkErrorException : com::sun::star::uno::Exception { + /** Name of script where error occured + */ + string scriptName; + /** Scripting language of script that generated exception + */ + string language; + /** error type <type scope="::com::sun::star::script::provider">ScriptFrameworkErrorType</type> + */ + long errorType; +}; + +//=========================================================================== +}; }; }; }; }; // ::com::sun::star::script::provider + +#endif diff --git a/offapi/com/sun/star/script/provider/ScriptFrameworkErrorType.idl b/offapi/com/sun/star/script/provider/ScriptFrameworkErrorType.idl new file mode 100644 index 000000000000..a80f1f36c318 --- /dev/null +++ b/offapi/com/sun/star/script/provider/ScriptFrameworkErrorType.idl @@ -0,0 +1,62 @@ +/************************************************************************* + * + * 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_script_provider_ScriptFrameworkErrorType_idl__ +#define __com_sun_star_script_provider_ScriptFrameworkErrorType_idl__ + +//=========================================================================== + +module com { module sun { module star { module script { module provider { + +//=========================================================================== +/** + is a checked exception that represents an error encountered + by the Scripting Framework whilst executing a script +*/ +constants ScriptFrameworkErrorType +{ + /** Unknown + */ + const long UNKNOWN = 0; + + /** ProviderNotSupported + */ + const long NOTSUPPORTED = 1; + + /** the requested method, and/or with the requested signature, does not exist + */ + const long NO_SUCH_SCRIPT = 2; + + /** the requested method, with the requested signature, does not exist + */ + const long MALFORMED_URL = 3; +}; + +//=========================================================================== +}; }; }; }; }; // com::sun::star::script::provider + +#endif diff --git a/offapi/com/sun/star/script/provider/ScriptProvider.idl b/offapi/com/sun/star/script/provider/ScriptProvider.idl new file mode 100755 index 000000000000..a133301e392a --- /dev/null +++ b/offapi/com/sun/star/script/provider/ScriptProvider.idl @@ -0,0 +1,61 @@ +/************************************************************************* + * + * 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_script_provider_ScriptProvider_idl__ +#define __com_sun_star_script_provider_ScriptProvider_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_script_provider_XScriptProvider_idl__ +#include <com/sun/star/script/provider/XScriptProvider.idl> +#endif + +#ifndef __com_sun_star_script_browse_BrowseNode_idl__ +#include <com/sun/star/script/browse/BrowseNode.idl> +#endif + +//=========================================================================== + +module com { module sun { module star { module script { module provider { + +//=========================================================================== +/** + This service providers a means to browse and execute scripts. +*/ +service ScriptProvider { + service ::com::sun::star::script::browse::BrowseNode; + + interface ::com::sun::star::script::provider::XScriptProvider; + +}; + +//=========================================================================== +}; }; }; }; }; // ::com::sun::star::script::provider + +#endif diff --git a/offapi/com/sun/star/script/provider/ScriptProviderForBasic.idl b/offapi/com/sun/star/script/provider/ScriptProviderForBasic.idl new file mode 100644 index 000000000000..97541eb0e863 --- /dev/null +++ b/offapi/com/sun/star/script/provider/ScriptProviderForBasic.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_script_provider_ScriptProviderForBasic_idl__ +#define __com_sun_star_script_provider_ScriptProviderForBasic_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_script_provider_LanguageScriptProvider_idl__ +#include <com/sun/star/script/provider/LanguageScriptProvider.idl> +#endif + +//=========================================================================== + +module com { module sun { module star { module script { module provider { + +//=========================================================================== +/** + This service is a Basic-specific LanguageScriptProvider. +*/ +service ScriptProviderForBasic { + service ::com::sun::star::script::provider::LanguageScriptProvider; +}; + +//=========================================================================== +}; }; }; }; }; // ::com::sun::star::script::provider + +#endif diff --git a/offapi/com/sun/star/script/provider/ScriptProviderForBeanShell.idl b/offapi/com/sun/star/script/provider/ScriptProviderForBeanShell.idl new file mode 100755 index 000000000000..e9c2d7dd8241 --- /dev/null +++ b/offapi/com/sun/star/script/provider/ScriptProviderForBeanShell.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_script_provider_ScriptProviderForBeanShell_idl__ +#define __com_sun_star_script_provider_ScriptProviderForBeanShell_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_script_provider_LanguageScriptProvider_idl__ +#include <com/sun/star/script/provider/LanguageScriptProvider.idl> +#endif + +//=========================================================================== + +module com { module sun { module star { module script { module provider { + +//=========================================================================== +/** + This service is a BeanShell-specific LanguageScriptProvider. +*/ +service ScriptProviderForBeanShell { + service ::com::sun::star::script::provider::LanguageScriptProvider; +}; + +//=========================================================================== +}; }; }; }; }; // ::com::sun::star::script::provider + +#endif diff --git a/offapi/com/sun/star/script/provider/ScriptProviderForJava.idl b/offapi/com/sun/star/script/provider/ScriptProviderForJava.idl new file mode 100755 index 000000000000..6d171c305dac --- /dev/null +++ b/offapi/com/sun/star/script/provider/ScriptProviderForJava.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_script_provider_ScriptProviderForJava_idl__ +#define __com_sun_star_script_provider_ScriptProviderForJava_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_script_provider_LanguageScriptProvider_idl__ +#include <com/sun/star/script/provider/LanguageScriptProvider.idl> +#endif + +//=========================================================================== + +module com { module sun { module star { module script { module provider { + +//=========================================================================== +/** + This service is a Java-specific LanguageScriptProvider. +*/ +service ScriptProviderForJava { + service ::com::sun::star::script::provider::LanguageScriptProvider; +}; + +//=========================================================================== +}; }; }; }; }; // ::com::sun::star::script::provider + +#endif diff --git a/offapi/com/sun/star/script/provider/ScriptProviderForJavaScript.idl b/offapi/com/sun/star/script/provider/ScriptProviderForJavaScript.idl new file mode 100755 index 000000000000..e64067084beb --- /dev/null +++ b/offapi/com/sun/star/script/provider/ScriptProviderForJavaScript.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_script_provider_ScriptProviderForJavaScript_idl__ +#define __com_sun_star_script_provider_ScriptProviderForJavaScript_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_script_provider_LanguageScriptProvider_idl__ +#include <com/sun/star/script/provider/LanguageScriptProvider.idl> +#endif + +//=========================================================================== + +module com { module sun { module star { module script { module provider { + +//=========================================================================== +/** + This service is a Java-specific LanguageScriptProvider. +*/ +service ScriptProviderForJavaScript { + service ::com::sun::star::script::provider::LanguageScriptProvider; +}; + +//=========================================================================== +}; }; }; }; }; // ::com::sun::star::script::provider + +#endif diff --git a/offapi/com/sun/star/script/provider/ScriptURIHelper.idl b/offapi/com/sun/star/script/provider/ScriptURIHelper.idl new file mode 100755 index 000000000000..111a65cb4a26 --- /dev/null +++ b/offapi/com/sun/star/script/provider/ScriptURIHelper.idl @@ -0,0 +1,72 @@ +/************************************************************************* + * + * 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_script_provider_ScriptURIHelper_idl__ +#define __com_sun_star_script_provider_ScriptURIHelper_idl__ + +#ifndef __com_sun_star_script_provider_XScriptURIHelper_idl__ +#include <com/sun/star/script/provider/XScriptURIHelper.idl> +#endif +#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ +#include <com/sun/star/lang/IllegalArgumentException.idl> +#endif + +//=========================================================================== + +module com { module sun { module star { module script { module provider { + +//=========================================================================== +/** + This service is used to help transform Scripting Framework storage + locations to Scripting Framework script URIs and vice versa. +*/ +service ScriptURIHelper : XScriptURIHelper { + + /** + create a new ScriptURIHelper + + @param language + The name of the scripting language for which this ScriptURIHelper + is being created. It should be the same as the language name + used for the service that inherits from the LanguageScriptProvider + service + + @param location + This location which was passed to the LanguageScriptProvider + by the Scripting Framework on its creation + + @throws + <type scope="::com::sun::star::lang">IllegalArgumentException</type> + */ + create( [in] string language, [in] string location ) + raises ( ::com::sun::star::lang::IllegalArgumentException ); +}; + +//=========================================================================== +}; }; }; }; }; // ::com::sun::star::script::provider + +#endif diff --git a/offapi/com/sun/star/script/provider/XScript.idl b/offapi/com/sun/star/script/provider/XScript.idl new file mode 100644 index 000000000000..a96629fe9c68 --- /dev/null +++ b/offapi/com/sun/star/script/provider/XScript.idl @@ -0,0 +1,102 @@ +/************************************************************************* + * + * 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_script_provider_XScript_idl__ +#define __com_sun_star_script_provider_XScript_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ +#include <com/sun/star/lang/IllegalArgumentException.idl> +#endif + +#ifndef __com_sun_star_script_CannotConvertException_idl__ +#include <com/sun/star/script/CannotConvertException.idl> +#endif + +#ifndef __com_sun_star_reflection_InvocationTargetException_idl__ +#include <com/sun/star/reflection/InvocationTargetException.idl> +#endif + +#ifndef __com_sun_star_script_provider_ScriptFrameworkErrorException_idl__ +#include <com/sun/star/script/provider/ScriptFrameworkErrorException.idl> +#endif + +//=========================================================================== + +module com { module sun { module star { module script { module provider { + +//=========================================================================== +/** + This interface represents an invokable script or UNO function. +*/ +interface XScript : ::com::sun::star::uno::XInterface { + + //---------------------------------------------------------------------- + /** + invoke the script or function represented by the implementing + object + + @param aParams + all parameters; pure, out params are undefined in sequence, + i.e., the value has to be ignored by the callee + @param aOutParamIndex + out indices, indicating the position of the out or inout + parameters in the list of arguments to the script + @param aOutParam + out parameters<p> + For example, if the script had the signature<br> + <code>long foo( [inout] string a, [in] string b, [out] string c )</code> + <br> the call would look like<br> + <code>bar.invoke( {"foo", "foo2", "this-is-ignored" }, aOutParamIndex, aOutParam);</code> + <br> and after the call the out sequences would contain<br> + <listing> + aOutParamIndex={0,2}; + aOutParam={"string from a", "string from c"}; + </listing> + + @returns + the value returned from the function being invoked + + @throws ::com::sun::star::reflection::InvocationTargetException + if and error occurs while attempting to invoke a script the information is captured. If the error or exception is generated by the script itself it is wrapped as either ScriptErrorRaisedException or ScriptExceptionRaisedException or ScriptingFrameworkErrorException are wrapped as ScriptFrameworkErrorExceptions. + */ + any invoke( + [in] sequence<any> aParams, + [out] sequence<short> aOutParamIndex, + [out] sequence<any> aOutParam ) raises( + ::com::sun::star::script::provider::ScriptFrameworkErrorException , + ::com::sun::star::reflection::InvocationTargetException); + +}; + +//=========================================================================== +}; }; }; }; }; // ::com::sun::star::script::provider + +#endif diff --git a/offapi/com/sun/star/script/provider/XScriptContext.idl b/offapi/com/sun/star/script/provider/XScriptContext.idl new file mode 100644 index 000000000000..f673b18716d7 --- /dev/null +++ b/offapi/com/sun/star/script/provider/XScriptContext.idl @@ -0,0 +1,114 @@ +/************************************************************************* + * + * 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_script_provider_XScriptContext_idl__ +#define __com_sun_star_script_provider_XScriptContext_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_frame_XDesktop_idl__ +#include <com/sun/star/frame/XDesktop.idl> +#endif + +#ifndef __com_sun_star_frame_XModel_idl__ +#include <com/sun/star/frame/XModel.idl> +#endif + +#ifndef __com_sun_star_uno_XComponentContext_idl__ +#include <com/sun/star/uno/XComponentContext.idl> +#endif + + +module com { module sun { module star { module document { + interface XScriptInvocationContext; +}; }; }; }; + +//=========================================================================== + +module com { module sun { module star { module script { module provider { + +//=========================================================================== +/** + This interface is provided to scripts, and provides a means of access to + the various interfaces which they might need to perform some action on + a document. It is required to be passed as the first argument for any + Java scripts. +*/ +interface XScriptContext : ::com::sun::star::uno::XInterface { + + //---------------------------------------------------------------------- + /** + Obtain the document reference on which the script can operate + + @returns + <type scope="com::sun::star::frame">XModel</type> interface + */ + ::com::sun::star::frame::XModel getDocument(); + + /** provides access to the context where the script was invoked + + <p>In some cases, it is possible that scripts, embedded in a document, + are executed from within a context which is <em>not</em> the document + itself. In this case, the <code>getInvocationContext</code> member allows + to access this context.</p> + + <p>Note that the returned context is allowed to be <NULL/>, in this case, + the document as returned by <code>getDocument</code> is the invocation context.</p> + + <p>If the returned context is not <NULL/>, its <code>ScriptContainer</code> attribute + equals the document as returned by <code>XScriptContext::getDocument</code>.</p> + + @since OOo 3.0 + */ + ::com::sun::star::document::XScriptInvocationContext getInvocationContext(); + + /** + Obtain the desktop reference on which the script can operate + + @returns + <type scope="com::sun::star::frame">XDesktop</type> interface + */ + ::com::sun::star::frame::XDesktop getDesktop(); + + /** + Obtain the component context which the script can use to create + other uno components + + @returns + <type scope="com::sun::star::uno">XComponentContext</type> interface + */ + ::com::sun::star::uno::XComponentContext getComponentContext(); + + +}; + +//=========================================================================== +}; }; }; }; }; // ::com::sun::star::script::provider + +#endif diff --git a/offapi/com/sun/star/script/provider/XScriptProvider.idl b/offapi/com/sun/star/script/provider/XScriptProvider.idl new file mode 100644 index 000000000000..944a37532251 --- /dev/null +++ b/offapi/com/sun/star/script/provider/XScriptProvider.idl @@ -0,0 +1,74 @@ +/************************************************************************* + * + * 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_script_provider_XScriptProvider_idl__ +#define __com_sun_star_script_provider_XScriptProvider_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif +#ifndef __com_sun_star_script_provider_XScript_idl__ +#include <com/sun/star/script/provider/XScript.idl> +#endif +#ifndef __com_sun_star_script_provider_ScriptFrameworkErrorException_idl__ +#include <com/sun/star/script/provider/ScriptFrameworkErrorException.idl> +#endif +#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ +#include <com/sun/star/lang/IllegalArgumentException.idl> +#endif + +//=========================================================================== + +module com { module sun { module star { module script { module provider { + +//=========================================================================== +/** + This interface provides a factory for obtaining objects implmenting the + XScript interface. +*/ +interface XScriptProvider : ::com::sun::star::uno::XInterface { + + //---------------------------------------------------------------------- + /** a factory method for the creation of XScript + implementations. + + @param sScriptURI + is the logical or language-dependent script URI + + @returns + an object implementing <type scope="::com::sun::star::script::provider">XScript</type> representing the script + + @throws ::com::sun::star::provider::ScriptFrameworkErrorException + Framework error getting script for URI. + */ + XScript getScript( [in] string sScriptURI ) raises ( ::com::sun::star::script::provider::ScriptFrameworkErrorException ); +}; + +//=========================================================================== +}; }; }; }; }; // ::com::sun::star::script::provider + +#endif diff --git a/offapi/com/sun/star/script/provider/XScriptProviderFactory.idl b/offapi/com/sun/star/script/provider/XScriptProviderFactory.idl new file mode 100644 index 000000000000..3663d6188420 --- /dev/null +++ b/offapi/com/sun/star/script/provider/XScriptProviderFactory.idl @@ -0,0 +1,72 @@ +/************************************************************************* + * + * 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_script_provider_XScriptProviderFactory_idl__ +#define __com_sun_star_script_provider_XScriptProviderFactory_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif +#ifndef __com_sun_star_script_provider_XScriptProvider_idl__ +#include <com/sun/star/script/provider/XScriptProvider.idl> +#endif +#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ +#include <com/sun/star/lang/IllegalArgumentException.idl> +#endif + +//=========================================================================== + +module com { module sun { module star { module script { module provider { + +//=========================================================================== +/** + This interface provides a factory for obtaining objects implmenting the + XScriptProvider interface. +*/ +interface XScriptProviderFactory : ::com::sun::star::uno::XInterface { + + //---------------------------------------------------------------------- + /** a factory method for the creation of XScriptProviders + implementations. + + @param sContext + is context for which the ScriptProvider is to be created for + + @returns + an object implementing <type scope="::com::sun::star::script::provider">XScriptProvider</type> + + @throws ::com::sun::star::lang::IllegalArgumentException + if illegal or unknown context is passed + */ + XScriptProvider createScriptProvider( [in] any context ) raises ( + ::com::sun::star::lang::IllegalArgumentException ); +}; + +//=========================================================================== +}; }; }; }; }; // ::com::sun::star::script::provider + +#endif diff --git a/offapi/com/sun/star/script/provider/XScriptProviderSupplier.idl b/offapi/com/sun/star/script/provider/XScriptProviderSupplier.idl new file mode 100644 index 000000000000..6fa088c85a32 --- /dev/null +++ b/offapi/com/sun/star/script/provider/XScriptProviderSupplier.idl @@ -0,0 +1,64 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_script_provider_XScriptProviderSupplier_idl__ +#define __com_sun_star_script_provider_XScriptProviderSupplier_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif +#ifndef __com_sun_star_script_provider_XScriptProvider_idl__ +#include <com/sun/star/script/provider/XScriptProvider.idl> +#endif +#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ +#include <com/sun/star/lang/IllegalArgumentException.idl> +#endif + +//=========================================================================== + +module com { module sun { module star { module script { module provider { + +//=========================================================================== +/** + This interface allows to get the scripting provider related to the object. +*/ +interface XScriptProviderSupplier : ::com::sun::star::uno::XInterface { + + //---------------------------------------------------------------------- + /** returns scripting provider related to the object. + + @returns + an object implementing <type scope="::com::sun::star::script::provider">XScriptProvider</type> representing the script provider + */ + XScriptProvider getScriptProvider(); +}; + +//=========================================================================== +}; }; }; }; }; // ::com::sun::star::script::provider + +#endif + diff --git a/offapi/com/sun/star/script/provider/XScriptURIHelper.idl b/offapi/com/sun/star/script/provider/XScriptURIHelper.idl new file mode 100644 index 000000000000..1790df0a4a08 --- /dev/null +++ b/offapi/com/sun/star/script/provider/XScriptURIHelper.idl @@ -0,0 +1,88 @@ +/************************************************************************* + * + * 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_script_provider_XScriptURIHelper_idl__ +#define __com_sun_star_script_provider_XScriptURIHelper_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ +#include <com/sun/star/lang/IllegalArgumentException.idl> +#endif + + +//=========================================================================== + +module com { module sun { module star { module script { module provider { + +//=========================================================================== +/** + This interface is used to help transform Scripting Framework storage + locations to Scripting Framework script URIs and vice versa. +*/ +interface XScriptURIHelper : ::com::sun::star::uno::XInterface { + + //---------------------------------------------------------------------- + /** + Obtain the root storage URI for this ScriptURIHelper. The + resulting string can be used to access the storage for this + using the Universal Content Broker + + @returns a URI to the storage as a <atom>string</atom> + */ + string getRootStorageURI(); + + /** + Obtain the storage URI for a specific Scripting Framework + script URI. + + @returns a URI to the storage as a <atom>string</atom> + + @throws <type scope="::com::sun::star::lang">IllegalArgumentException</type> + if the storageURI is not a valid + */ + string getStorageURI( [in] string scriptURI ) raises + ( ::com::sun::star::lang::IllegalArgumentException ); + + /** + Obtain the Scripting Framework script URI for a specific UCB URI + + @returns the URI as a <atom>string</atom> + + @throws <type scope="::com::sun::star::lang">IllegalArgumentException</type> + if the storageURI is not a valid + */ + string getScriptURI( [in] string storageURI ) raises + ( ::com::sun::star::lang::IllegalArgumentException ); +}; + +//=========================================================================== +}; }; }; }; }; // ::com::sun::star::script::provider + +#endif diff --git a/offapi/com/sun/star/script/provider/makefile.mk b/offapi/com/sun/star/script/provider/makefile.mk new file mode 100755 index 000000000000..488944ff7e62 --- /dev/null +++ b/offapi/com/sun/star/script/provider/makefile.mk @@ -0,0 +1,68 @@ +#************************************************************************* +# +# 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. +# +#************************************************************************* + +PRJ=..$/..$/..$/..$/.. + +PRJNAME=offapi + +TARGET=csssprovider +PACKAGE=com$/sun$/star$/script$/provider + +# --- Settings ----------------------------------------------------- +.INCLUDE : $(PRJ)$/util$/makefile.pmk + +# ------------------------------------------------------------------------ + +IDLFILES=\ + XScript.idl\ + XScriptContext.idl\ + XScriptProvider.idl\ + XScriptProviderSupplier.idl\ + ScriptProvider.idl\ + MasterScriptProvider.idl\ + XScriptProviderFactory.idl\ + LanguageScriptProvider.idl\ + ScriptProviderForJava.idl\ + ScriptProviderForJavaScript.idl\ + ScriptProviderForBeanShell.idl\ + MasterScriptProviderFactory.idl\ + ScriptErrorRaisedException.idl\ + ScriptExceptionRaisedException.idl\ + ScriptFrameworkErrorException.idl\ + ScriptFrameworkErrorType.idl\ + ScriptURIHelper.idl\ + XScriptURIHelper.idl\ + ScriptProviderForBasic.idl + +# ------------------------------------------------------------------ + +# ------------------------------------------------------------------ + +# ------------------------------------------------------------------ + +.INCLUDE : target.mk +.INCLUDE : $(PRJ)$/util$/target.pmk diff --git a/offapi/com/sun/star/script/vba/VBAEventId.idl b/offapi/com/sun/star/script/vba/VBAEventId.idl new file mode 100755 index 000000000000..fda83a18d495 --- /dev/null +++ b/offapi/com/sun/star/script/vba/VBAEventId.idl @@ -0,0 +1,140 @@ +/************************************************************************* + * + * 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_script_vba_VBAEventId_idl__ +#define __com_sun_star_script_vba_VBAEventId_idl__ + +//============================================================================= + +module com { module sun { module star { module script { module vba { + +//============================================================================= + +/** Constants used to identify VBA document events. + + <p>If one of these events is fired, a specific VBA macro in a specific + document code module will be executed.</p> + + <p>Each event expects some specific arguments to be passed to + <member>XVBAEventProcessor::processVbaEvent</member>.</p> + + @see XVBAEventProcessor + */ +constants VBAEventId +{ + //========================================================================= + + /** An identifier not corresponding to any VBA document event. */ + const long NO_EVENT = -1; + + //========================================================================= + // Global events (identifiers from 1 to 999) + + /** New document opened from template. No arguments. */ + const long AUTO_NEW = 1; + /** Document opened (loaded). No arguments. */ + const long AUTO_OPEN = 2; + /** Document about to be closed. No arguments. */ + const long AUTO_CLOSE = 3; + /** Application start. No arguments. */ + const long AUTO_EXEC = 4; + /** Application exit. No arguments. */ + const long AUTO_EXIT = 5; + + //========================================================================= + // MS Word (identifiers from 1001 to 1999) + + /** New text document opened from template. No arguments. */ + const long DOCUMENT_NEW = 1001; + /** Text document opened (loaded). No arguments. */ + const long DOCUMENT_OPEN = 1002; + /** Document about to be closed. No arguments. */ + const long DOCUMENT_CLOSE = 1003; + + //========================================================================= + // MS Excel (identifiers from 2001 to 2999) + + //------------------------------------------------------------------------- + // document events (2001-2099) + + /** Document activated. No arguments. */ + const long WORKBOOK_ACTIVATE = 2001; + /** Document deactivated. No arguments. */ + const long WORKBOOK_DEACTIVATE = 2002; + /** Document opened (loaded). No arguments. */ + const long WORKBOOK_OPEN = 2003; + /** Document about to be closed. Arguments: [out] boolean bCancel. */ + const long WORKBOOK_BEFORECLOSE = 2004; + /** Document about to be printed. Arguments: [out] boolean bCancel. */ + const long WORKBOOK_BEFOREPRINT = 2005; + /** Document about to be saved. Arguments: boolean bSaveAs, [out] boolean bCancel. */ + const long WORKBOOK_BEFORESAVE = 2006; + /** Document has been saved. Arguments: boolean bSuccess. */ + const long WORKBOOK_AFTERSAVE = 2007; + /** New sheet inserted. Arguments: short nSheet. */ + const long WORKBOOK_NEWSHEET = 2008; + /** Document window has been activated. No arguments. */ + const long WORKBOOK_WINDOWACTIVATE = 2009; + /** Document window has been deactivated. No arguments. */ + const long WORKBOOK_WINDOWDEACTIVATE = 2010; + /** Document window has been resized. No arguments. */ + const long WORKBOOK_WINDOWRESIZE = 2011; + + //------------------------------------------------------------------------- + // sheet events (2101-2199) + + /** Worksheet has been activated (made visible). Arguments: short nSheet. */ + const long WORKSHEET_ACTIVATE = 2101; + /** Worksheet has been activated (made visible). Arguments: short nSheet. */ + const long WORKSHEET_DEACTIVATE = 2102; + /** Double click in the sheet. Arguments: XRange/XSheetCellRangeContainer aRange, [out] boolean bCancel. */ + const long WORKSHEET_BEFOREDOUBLECLICK = 2103; + /** Right click in the sheet. Arguments: XRange/XSheetCellRangeContainer aRange, [out] boolean bCancel. */ + const long WORKSHEET_BEFORERIGHTCLICK = 2104; + /** Cells in sheet have been recalculated. Arguments: short nSheet. */ + const long WORKSHEET_CALCULATE = 2105; + /** Cells in sheet have been changed. Arguments: XRange/XSheetCellRangeContainer aRange. */ + const long WORKSHEET_CHANGE = 2106; + /** Selection in sheet has been changed. Arguments: XRange/XSheetCellRangeContainer aRange. */ + const long WORKSHEET_SELECTIONCHANGE = 2107; + /** Hyperlink has been clicked. Arguments: XCell aCell. */ + const long WORKSHEET_FOLLOWHYPERLINK = 2108; + + //========================================================================= + + /** Implementations are allowed to use identifiers above this value for any + internal purpose. */ + const long USERDEFINED_START = 1000000; +}; + +//============================================================================= + +}; }; }; }; }; + +//============================================================================= + +#endif diff --git a/offapi/com/sun/star/script/vba/VBAEventProcessor.idl b/offapi/com/sun/star/script/vba/VBAEventProcessor.idl new file mode 100755 index 000000000000..d993b37ae250 --- /dev/null +++ b/offapi/com/sun/star/script/vba/VBAEventProcessor.idl @@ -0,0 +1,49 @@ +/************************************************************************* + * + * 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_script_vba_VBAEventProcessor_idl__ +#define __com_sun_star_script_vba_VBAEventProcessor_idl__ + +#include <com/sun/star/script/vba/XVBAEventProcessor.idl> + +//============================================================================= + +module com { module sun { module star { module script { module vba { + +//============================================================================= + +service VBAEventProcessor : XVBAEventProcessor +{ +}; + +//============================================================================= + +}; }; }; }; }; + +//============================================================================= + +#endif diff --git a/offapi/com/sun/star/script/vba/VBASpreadsheetEventProcessor.idl b/offapi/com/sun/star/script/vba/VBASpreadsheetEventProcessor.idl new file mode 100755 index 000000000000..ce202da4f54c --- /dev/null +++ b/offapi/com/sun/star/script/vba/VBASpreadsheetEventProcessor.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_script_vba_VBASpreadsheetEventProcessor_idl__ +#define __com_sun_star_script_vba_VBASpreadsheetEventProcessor_idl__ + +#include <com/sun/star/script/vba/VBAEventProcessor.idl> + +//============================================================================= + +module com { module sun { module star { module script { module vba { + +//============================================================================= + +service VBASpreadsheetEventProcessor +{ + service VBAEventProcessor; +}; + +//============================================================================= + +}; }; }; }; }; + +//============================================================================= + +#endif diff --git a/offapi/com/sun/star/script/vba/VBATextEventProcessor.idl b/offapi/com/sun/star/script/vba/VBATextEventProcessor.idl new file mode 100755 index 000000000000..fd3c7f895d8d --- /dev/null +++ b/offapi/com/sun/star/script/vba/VBATextEventProcessor.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_script_vba_VBATextEventProcessor_idl__ +#define __com_sun_star_script_vba_VBATextEventProcessor_idl__ + +#include <com/sun/star/script/vba/VBAEventProcessor.idl> + +//============================================================================= + +module com { module sun { module star { module script { module vba { + +//============================================================================= + +service VBATextEventProcessor +{ + service VBAEventProcessor; +}; + +//============================================================================= + +}; }; }; }; }; + +//============================================================================= + +#endif diff --git a/offapi/com/sun/star/script/vba/XVBACompatibility.idl b/offapi/com/sun/star/script/vba/XVBACompatibility.idl new file mode 100644 index 000000000000..bfa9d01655fa --- /dev/null +++ b/offapi/com/sun/star/script/vba/XVBACompatibility.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_script_vba_XVBACompatibility_idl__ +#define __com_sun_star_script_vba_XVBACompatibility_idl__ + +#include <com/sun/star/uno/XInterface.idl> + +//============================================================================= + +module com { module sun { module star { module script { module vba { + +interface XVBACompatibility +{ + //------------------------------------------------------------------------- + + [attribute] boolean VBACompatibilityMode; + + //------------------------------------------------------------------------- +}; + +}; }; }; }; }; + +//============================================================================= + +#endif diff --git a/offapi/com/sun/star/script/vba/XVBAEventProcessor.idl b/offapi/com/sun/star/script/vba/XVBAEventProcessor.idl new file mode 100755 index 000000000000..4a3534de8412 --- /dev/null +++ b/offapi/com/sun/star/script/vba/XVBAEventProcessor.idl @@ -0,0 +1,106 @@ +/************************************************************************* + * + * 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_script_vba_XVBAEventProcessor_idl__ +#define __com_sun_star_script_vba_XVBAEventProcessor_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/lang/IllegalArgumentException.idl> +#include <com/sun/star/script/provider/ScriptFrameworkErrorException.idl> +#include <com/sun/star/util/VetoException.idl> + +//============================================================================= + +module com { module sun { module star { module script { module vba { + +//============================================================================= + +/** Executes VBA event handlers. + */ +interface XVBAEventProcessor +{ + //------------------------------------------------------------------------- + + /** Returns whether a VBA event handler exists. + + @param nEventId + The identifier of the event. Must be a constant from <type>VBAEventId</type>. + + @param aArgs + Additional arguments needed to identify some event handlers, e.g. a + sheet index for spreadsheet events. + + @return + <TRUE/>, if the VBA event handler exists. + + @throws <type scope="::com::sun::star::lang">IllegalArgumentException</type> + if the passed event identifier is not supported, or if the passed + specifier is required but invalid. + **/ + boolean hasVbaEventHandler( [in] long nEventId, [in] sequence< any > aArgs ) + raises (::com::sun::star::lang::IllegalArgumentException); + + //------------------------------------------------------------------------- + + /** Executes a VBA event handler. + + @param nEventId + The identifier of the event. Must be a constant from <type>VBAEventId</type>. + + @param aArgs + The input arguments needed to create the argument list of the VBA + event handler. + + @throws <type scope="::com::sun::star::lang">IllegalArgumentException</type> + if the passed event identifier is not supported, or if the passed + arguments do not conform to the arguments expected by the specified + event. + + @throws <type scope="::com::sun::star::script::provider">ScriptFrameworkErrorException</type> + if the VBA event handler could not be invoked. Reasons may be, that + handling of VBA events is not enabled, that the VBA event handler + macro has not been found, or that the execution of the macro has + been aborted with an error. + + @throws <type scope="::com::sun::star::util">VetoException</type> + if the VBA event handler has indicated to veto the event. + **/ + void processVbaEvent( [in] long nEventId, [in] sequence< any > aArgs ) + raises (::com::sun::star::lang::IllegalArgumentException, + ::com::sun::star::script::provider::ScriptFrameworkErrorException, + ::com::sun::star::util::VetoException); + + //------------------------------------------------------------------------- +}; + +//============================================================================= + +}; }; }; }; }; + +//============================================================================= + +#endif diff --git a/offapi/com/sun/star/script/vba/XVBAModuleInfo.idl b/offapi/com/sun/star/script/vba/XVBAModuleInfo.idl new file mode 100644 index 000000000000..9954281a5a71 --- /dev/null +++ b/offapi/com/sun/star/script/vba/XVBAModuleInfo.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_script_vba_XVBAModuleInfo_idl__ +#define __com_sun_star_script_vba_XVBAModuleInfo_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/script/ModuleInfo.idl> +#include <com/sun/star/lang/IllegalArgumentException.idl> +#include <com/sun/star/container/ElementExistException.idl> +#include <com/sun/star/lang/WrappedTargetException.idl> +#include <com/sun/star/container/NoSuchElementException.idl> + +//============================================================================= + +module com { module sun { module star { module script { module vba { + +interface XVBAModuleInfo +{ + //------------------------------------------------------------------------- + + com::sun::star::script::ModuleInfo getModuleInfo( [in] string ModuleName ) + raises( com::sun::star::container::NoSuchElementException, + com::sun::star::lang::WrappedTargetException ); + + //------------------------------------------------------------------------- + + boolean hasModuleInfo( [in] string ModuleName ); + + //------------------------------------------------------------------------- + + void insertModuleInfo( [in] string ModuleName, + [in] com::sun::star::script::ModuleInfo ModuleInfo ) + raises( com::sun::star::lang::IllegalArgumentException, + com::sun::star::container::ElementExistException, + com::sun::star::lang::WrappedTargetException ); + + //------------------------------------------------------------------------- + + void removeModuleInfo( [in] string ModuleName ) + raises( com::sun::star::container::NoSuchElementException, + com::sun::star::lang::WrappedTargetException ); + + //------------------------------------------------------------------------- +}; + +}; }; }; }; }; + +//============================================================================= + +#endif diff --git a/offapi/com/sun/star/script/vba/makefile.mk b/offapi/com/sun/star/script/vba/makefile.mk new file mode 100755 index 000000000000..4657b587d7d8 --- /dev/null +++ b/offapi/com/sun/star/script/vba/makefile.mk @@ -0,0 +1,52 @@ +#************************************************************************* +# +# 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. +# +#************************************************************************* + +PRJ=..$/..$/..$/..$/.. + +PRJNAME=offapi + +TARGET=cssscriptvba +PACKAGE=com$/sun$/star$/script$/vba + +# --- Settings ----------------------------------------------------- +.INCLUDE : $(PRJ)$/util$/makefile.pmk + +# ------------------------------------------------------------------------ + +IDLFILES=\ + VBAEventId.idl \ + VBAEventProcessor.idl \ + VBASpreadsheetEventProcessor.idl \ + VBATextEventProcessor.idl \ + XVBACompatibility.idl \ + XVBAEventProcessor.idl \ + XVBAModuleInfo.idl + +# ------------------------------------------------------------------ + +.INCLUDE : target.mk +.INCLUDE : $(PRJ)$/util$/target.pmk |