summaryrefslogtreecommitdiff
path: root/udkapi
diff options
context:
space:
mode:
authorAndreas Bregas <ab@openoffice.org>2000-11-13 11:07:27 +0000
committerAndreas Bregas <ab@openoffice.org>2000-11-13 11:07:27 +0000
commit280f980bf7d3b1fba3aa80fa705e4f807ff74694 (patch)
tree68fbf066c51e26745fbcf1850198a3f27b2e4728 /udkapi
parent1ef124ad8682980a92b1ab9ca77b43c4a61b6299 (diff)
new
Diffstat (limited to 'udkapi')
-rw-r--r--udkapi/com/sun/star/script/XStarBasicAccess.idl132
-rw-r--r--udkapi/com/sun/star/script/XStarBasicDialogInfo.idl99
-rw-r--r--udkapi/com/sun/star/script/XStarBasicLibraryInfo.idl141
-rw-r--r--udkapi/com/sun/star/script/XStarBasicModuleInfo.idl107
4 files changed, 479 insertions, 0 deletions
diff --git a/udkapi/com/sun/star/script/XStarBasicAccess.idl b/udkapi/com/sun/star/script/XStarBasicAccess.idl
new file mode 100644
index 000000000000..3dbcb15cc3a1
--- /dev/null
+++ b/udkapi/com/sun/star/script/XStarBasicAccess.idl
@@ -0,0 +1,132 @@
+/*************************************************************************
+ *
+ * $RCSfile: XStarBasicAccess.idl,v $
+ *
+ * $Revision: 1.1 $
+ *
+ * last change: $Author: ab $ $Date: 2000-11-13 12:07:27 $
+ *
+ * The Contents of this file are made available subject to the terms of
+ * either of the following licenses
+ *
+ * - GNU Lesser General Public License Version 2.1
+ * - Sun Industry Standards Source License Version 1.1
+ *
+ * Sun Microsystems Inc., October, 2000
+ *
+ * GNU Lesser General Public License Version 2.1
+ * =============================================
+ * Copyright 2000 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
+ *
+ *
+ * Sun Industry Standards Source License Version 1.1
+ * =================================================
+ * The contents of this file are subject to the Sun Industry Standards
+ * Source License Version 1.1 (the "License"); You may not use this file
+ * except in compliance with the License. You may obtain a copy of the
+ * License at http://www.openoffice.org/license.html.
+ *
+ * Software provided under this License is provided on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ * See the License for the specific provisions governing your rights and
+ * obligations concerning the Software.
+ *
+ * The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ * Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ * All Rights Reserved.
+ *
+ * Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+#ifndef __com_sun_star_script_XStarBasicAccess_idl__
+#define __com_sun_star_script_XStarBasicAccess_idl__
+
+#ifndef __com_sun_star_container_XNameContainer_idl__
+#include <com/sun/star/container/XNameContainer.idl>
+#endif
+
+
+//=============================================================================
+
+ module com { module sun { module star { module script {
+
+//=============================================================================
+
+/** Interface representing a library and provides access to its modules
+ */
+[ uik(1B5D36B0-B944-11d4-9FF80050-04D8BBC7), ident( "XStarBasicAccess", 1.0 ) ]
+interface XStarBasicAccess: com::sun::star::uno::XInterface
+{
+ //-------------------------------------------------------------------------
+ /** @returns
+ The library container giving access to the libraries stored in a document
+ or basic library file.
+ */
+ com::sun::star::container::XNameContainer getLibraryContainer();
+
+ //-------------------------------------------------------------------------
+ /**
+ Creates an empty library. This method can be called alternatively to
+ accessing directly the NameContainer returned by getLibraryContainer.
+ By using this method together with addModule and addStarBasicDialog
+ the caller does not have to implement XStarBasicLibraryInfo, XModuleInfo
+ and XStarBasicDialogInfo
+ */
+ void createLibrary( [in] string LibName, [in] string Password,
+ [in] string ExternalSourceURL, [in] string LinkTargetURL )
+ raises( com::sun::star::container::ElementExistException );
+
+ //-------------------------------------------------------------------------
+ /**
+ Adds a module to an existing (e.g. created by createLibrary) library.
+ By using this method together with createLibrary the caller does not have
+ to implement XStarBasicLibraryInfo and XModuleInfo
+
+ @throws NoSuchElementException
+ if the library doesn't exist.
+ */
+ void addModule( [in] string LibraryName, [in] string ModuleName,
+ [in] string Language, [in] string Source )
+ raises( com::sun::star::container::NoSuchElementException );
+
+ //-------------------------------------------------------------------------
+ /**
+ Adds an old style basic dialog (SI controls) to an existing (e.g. created
+ by createLibrary) library.
+ By using this method together with createLibrary the caller does not have
+ to implement XStarBasicLibraryInfo and XStarBasicDialogInfo
+
+ @throws NoSuchElementException
+ if the library doesn't exist.
+ */
+ void addDialog( [in] string LibraryName, [in] string DialogName,
+ [in] sequence< byte > Data )
+ raises( com::sun::star::container::NoSuchElementException );
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif
diff --git a/udkapi/com/sun/star/script/XStarBasicDialogInfo.idl b/udkapi/com/sun/star/script/XStarBasicDialogInfo.idl
new file mode 100644
index 000000000000..36c19f4220a8
--- /dev/null
+++ b/udkapi/com/sun/star/script/XStarBasicDialogInfo.idl
@@ -0,0 +1,99 @@
+/*************************************************************************
+ *
+ * $RCSfile: XStarBasicDialogInfo.idl,v $
+ *
+ * $Revision: 1.1 $
+ *
+ * last change: $Author: ab $ $Date: 2000-11-13 12:07:27 $
+ *
+ * The Contents of this file are made available subject to the terms of
+ * either of the following licenses
+ *
+ * - GNU Lesser General Public License Version 2.1
+ * - Sun Industry Standards Source License Version 1.1
+ *
+ * Sun Microsystems Inc., October, 2000
+ *
+ * GNU Lesser General Public License Version 2.1
+ * =============================================
+ * Copyright 2000 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
+ *
+ *
+ * Sun Industry Standards Source License Version 1.1
+ * =================================================
+ * The contents of this file are subject to the Sun Industry Standards
+ * Source License Version 1.1 (the "License"); You may not use this file
+ * except in compliance with the License. You may obtain a copy of the
+ * License at http://www.openoffice.org/license.html.
+ *
+ * Software provided under this License is provided on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ * See the License for the specific provisions governing your rights and
+ * obligations concerning the Software.
+ *
+ * The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ * Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ * All Rights Reserved.
+ *
+ * Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+
+#ifndef __com_sun_star_script_XStarBasicDialogInfo_idl__
+#define __com_sun_star_script_XStarBasicDialogInfo_idl__
+
+#ifndef __com_sun_star_uno_XInterface_idl__
+#include <com/sun/star/uno/XInterface.idl>
+#endif
+
+
+//=============================================================================
+
+ module com { module sun { module star { module script {
+
+//=============================================================================
+
+/** Interface describing old style basic dialog (SI controls) in binary data
+ */
+[ uik(F0787340-B727-11d4-9FF70050-04D8BBC7), ident( "XStarBasicDialogInfo", 1.0 ) ]
+interface XStarBasicDialogInfo: com::sun::star::uno::XInterface
+{
+ //-------------------------------------------------------------------------
+ /** @returns
+ Name of the dialog
+ */
+ string getName();
+
+ //-------------------------------------------------------------------------
+ /** @returns
+ binary data decribing the SIDialog in SBX stream format
+ */
+ sequence< byte > getData();
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif
diff --git a/udkapi/com/sun/star/script/XStarBasicLibraryInfo.idl b/udkapi/com/sun/star/script/XStarBasicLibraryInfo.idl
new file mode 100644
index 000000000000..db461dd97775
--- /dev/null
+++ b/udkapi/com/sun/star/script/XStarBasicLibraryInfo.idl
@@ -0,0 +1,141 @@
+/*************************************************************************
+ *
+ * $RCSfile: XStarBasicLibraryInfo.idl,v $
+ *
+ * $Revision: 1.1 $
+ *
+ * last change: $Author: ab $ $Date: 2000-11-13 12:07:27 $
+ *
+ * The Contents of this file are made available subject to the terms of
+ * either of the following licenses
+ *
+ * - GNU Lesser General Public License Version 2.1
+ * - Sun Industry Standards Source License Version 1.1
+ *
+ * Sun Microsystems Inc., October, 2000
+ *
+ * GNU Lesser General Public License Version 2.1
+ * =============================================
+ * Copyright 2000 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
+ *
+ *
+ * Sun Industry Standards Source License Version 1.1
+ * =================================================
+ * The contents of this file are subject to the Sun Industry Standards
+ * Source License Version 1.1 (the "License"); You may not use this file
+ * except in compliance with the License. You may obtain a copy of the
+ * License at http://www.openoffice.org/license.html.
+ *
+ * Software provided under this License is provided on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ * See the License for the specific provisions governing your rights and
+ * obligations concerning the Software.
+ *
+ * The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ * Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ * All Rights Reserved.
+ *
+ * Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+#ifndef __com_sun_star_script_XStarBasicLibraryInfo_idl__
+#define __com_sun_star_script_XStarBasicLibraryInfo_idl__
+
+#ifndef __com_sun_star_container_XNameContainer_idl__
+#include <com/sun/star/container/XNameContainer.idl>
+#endif
+
+
+//=============================================================================
+
+ module com { module sun { module star { module script {
+
+//=============================================================================
+
+/** Interface representing a library and provides access to its modules
+ */
+[ uik(72454270-B646-11d4-9FF30050-04D8BBC7), ident( "XStarBasicLibraryInfo", 1.0 ) ]
+interface XStarBasicLibraryInfo: com::sun::star::uno::XInterface
+{
+ //-------------------------------------------------------------------------
+ /** @returns
+ The library's name
+ */
+ string getName();
+
+ //-------------------------------------------------------------------------
+ /** @returns
+ The module container giving access to the modules stored in the library.
+ The container has to be returned in any case, no matter if the library is
+ stored embedded, external or linked.
+
+ @see getExternalSourceURL
+ @see getLinkTargetURL
+ */
+ com::sun::star::container::XNameContainer getModuleContainer();
+
+ //-------------------------------------------------------------------------
+ /** @returns
+ The dialog container giving access to the dialogs stored in the library.
+ The container has to be returned in any case, no matter if the library is
+ stored embedded, external or linked.
+
+ @see getExternalSourceURL
+ @see getLinkTargetURL
+ */
+ com::sun::star::container::XNameContainer getDialogContainer();
+
+ //-------------------------------------------------------------------------
+ /** @returns
+ The password, if the library is protected with one,
+ an empty string otherwise.
+ */
+ string getPassword();
+
+ //-------------------------------------------------------------------------
+ /** @returns
+ URL describing the location where the library is stored if the library
+ is stored seperately (for example not in the main XML file but in a
+ special library format file), an empty string otherwise.
+ This information can be useful to optimize the access to the library,
+ e.g. for loading on demand.
+ */
+ string getExternalSourceURL();
+
+ //-------------------------------------------------------------------------
+ /** @returns
+ URL describing the location of the library linked to.
+
+ HINT: This method can be removed when there is a generic interface
+ for linking. Then the implementation will simply support this
+ "XLinked" interface and it can be checked by queryInterface().
+ */
+ string getLinkTargetURL();
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif
diff --git a/udkapi/com/sun/star/script/XStarBasicModuleInfo.idl b/udkapi/com/sun/star/script/XStarBasicModuleInfo.idl
new file mode 100644
index 000000000000..0cba028b844a
--- /dev/null
+++ b/udkapi/com/sun/star/script/XStarBasicModuleInfo.idl
@@ -0,0 +1,107 @@
+/*************************************************************************
+ *
+ * $RCSfile: XStarBasicModuleInfo.idl,v $
+ *
+ * $Revision: 1.1 $
+ *
+ * last change: $Author: ab $ $Date: 2000-11-13 12:07:27 $
+ *
+ * The Contents of this file are made available subject to the terms of
+ * either of the following licenses
+ *
+ * - GNU Lesser General Public License Version 2.1
+ * - Sun Industry Standards Source License Version 1.1
+ *
+ * Sun Microsystems Inc., October, 2000
+ *
+ * GNU Lesser General Public License Version 2.1
+ * =============================================
+ * Copyright 2000 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
+ *
+ *
+ * Sun Industry Standards Source License Version 1.1
+ * =================================================
+ * The contents of this file are subject to the Sun Industry Standards
+ * Source License Version 1.1 (the "License"); You may not use this file
+ * except in compliance with the License. You may obtain a copy of the
+ * License at http://www.openoffice.org/license.html.
+ *
+ * Software provided under this License is provided on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ * See the License for the specific provisions governing your rights and
+ * obligations concerning the Software.
+ *
+ * The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ * Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ * All Rights Reserved.
+ *
+ * Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+#ifndef __com_sun_star_script_XStarBasicModuleInfo_idl__
+#define __com_sun_star_script_XStarBasicModuleInfo_idl__
+
+#ifndef __com_sun_star_uno_XInterface_idl__
+#include <com/sun/star/uno/XInterface.idl>
+#endif
+
+
+//=============================================================================
+
+ module com { module sun { module star { module script {
+
+//=============================================================================
+
+/** Script Module containing some scripting code in a certain scripting language
+ */
+[ uik(25AE6C50-B65A-11d4-9FF30050-04D8BBC7), ident( "XStarBasicModuleInfo", 1.0 ) ]
+interface XStarBasicModuleInfo: com::sun::star::uno::XInterface
+{
+ //-------------------------------------------------------------------------
+ /** @returns
+ Name of the module
+ */
+ string getName();
+
+ //-------------------------------------------------------------------------
+ /** @returns
+ type of the script language as string; for example, "StarBasic" or "JavaScript".
+ */
+ string getLanguage();
+
+ //-------------------------------------------------------------------------
+ /** @returns
+ script source code as string.
+
+ <p>The code has to correspond with the language
+ defined by Language.</p>
+ */
+ string getSource();
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif