diff options
author | Michael Hönnig <mi@openoffice.org> | 2000-11-06 08:23:00 +0000 |
---|---|---|
committer | Michael Hönnig <mi@openoffice.org> | 2000-11-06 08:23:00 +0000 |
commit | 88c437c597b604524d50f450506285a594bd03a5 (patch) | |
tree | 3c12c7a1422fc0fc7d6e9b6433b55b91aa3a80a8 /offapi/com/sun/star/plugin | |
parent | CONTROLLEN macro for macosx (diff) | |
download | core-88c437c597b604524d50f450506285a594bd03a5.tar.gz core-88c437c597b604524d50f450506285a594bd03a5.zip |
moved from api
Diffstat (limited to 'offapi/com/sun/star/plugin')
-rw-r--r-- | offapi/com/sun/star/plugin/PluginDescription.idl | 133 | ||||
-rw-r--r-- | offapi/com/sun/star/plugin/PluginException.idl | 109 | ||||
-rw-r--r-- | offapi/com/sun/star/plugin/PluginManager.idl | 103 | ||||
-rw-r--r-- | offapi/com/sun/star/plugin/PluginMode.idl | 109 | ||||
-rw-r--r-- | offapi/com/sun/star/plugin/PluginVariable.idl | 121 | ||||
-rw-r--r-- | offapi/com/sun/star/plugin/XPlugin.idl | 122 | ||||
-rw-r--r-- | offapi/com/sun/star/plugin/XPluginContext.idl | 221 | ||||
-rw-r--r-- | offapi/com/sun/star/plugin/XPluginManager.idl | 184 | ||||
-rw-r--r-- | offapi/com/sun/star/plugin/makefile.mk | 88 |
9 files changed, 1190 insertions, 0 deletions
diff --git a/offapi/com/sun/star/plugin/PluginDescription.idl b/offapi/com/sun/star/plugin/PluginDescription.idl new file mode 100644 index 000000000000..c5e4cafe5579 --- /dev/null +++ b/offapi/com/sun/star/plugin/PluginDescription.idl @@ -0,0 +1,133 @@ +/************************************************************************* + * + * $RCSfile: PluginDescription.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:52 $ + * + * 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_plugin_PluginDescription_idl__ +#define __com_sun_star_plugin_PluginDescription_idl__ + + +//============================================================================= + + module com { module sun { module star { module plugin { + +//============================================================================= + +// DocMerge from xml: struct com::sun::star::plugin::PluginDescription +/** is a handle for one specific plugin shared object. + + + + <p>If there are multiple mimetypes and/or extensions, multiple + <type>PluginDescription</type> objects will be created.</p> + */ +struct PluginDescription +{ + // DocMerge from xml: field com::sun::star::plugin::PluginDescription::PluginName + /** contains the plugin name (usually the shared object file name). + */ + string PluginName; + + //------------------------------------------------------------------------- + + // DocMerge from xml: field com::sun::star::plugin::PluginDescription::Mimetype + /** contains one mimetype for which this plugin should be registered. + */ + string Mimetype; + + //------------------------------------------------------------------------- + + // DocMerge from xml: field com::sun::star::plugin::PluginDescription::Extension + /** contains the file extension for files of this type. + */ + string Extension; + + //------------------------------------------------------------------------- + + // DocMerge from xml: field com::sun::star::plugin::PluginDescription::Description + /** contains a free text description of the plugin. + */ + string Description; + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:28 hjs + initial import + + Revision 1.5 2000/09/11 11:52:34 mi + documentation merged from XML + + Revision 1.3 2000/02/21 16:18:02 mi + string documentation from stardiv...*.idl-files + + Revision 1.2 2000/02/07 11:24:41 mi + zu #70728# missing documentation marked + + Revision 1.1.1.1 1999/11/11 09:48:44 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/plugin/PluginException.idl b/offapi/com/sun/star/plugin/PluginException.idl new file mode 100644 index 000000000000..108b0a323311 --- /dev/null +++ b/offapi/com/sun/star/plugin/PluginException.idl @@ -0,0 +1,109 @@ +/************************************************************************* + * + * $RCSfile: PluginException.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:52 $ + * + * 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_plugin_PluginException_idl__ +#define __com_sun_star_plugin_PluginException_idl__ + +#ifndef __com_sun_star_uno_Exception_idl__ +#include <com/sun/star/uno/Exception.idl> +#endif + + +//============================================================================= + + module com { module sun { module star { module plugin { + +//============================================================================= + +// DocMerge from xml: exception com::sun::star::plugin::PluginException +/** indicates that an error occured in an NPN or NPP function call.@see XPlugin + @see XPluginContext + @see XPluginManager + */ +exception PluginException: com::sun::star::uno::Exception +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: field com::sun::star::plugin::PluginException::ErrorCode + /** contains the original Netscape error code. + */ + short ErrorCode; + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:29 hjs + initial import + + Revision 1.3 2000/09/11 11:52:34 mi + documentation merged from XML + + Revision 1.1.1.1 1999/11/11 09:48:44 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/plugin/PluginManager.idl b/offapi/com/sun/star/plugin/PluginManager.idl new file mode 100644 index 000000000000..5c8f3a54d2b3 --- /dev/null +++ b/offapi/com/sun/star/plugin/PluginManager.idl @@ -0,0 +1,103 @@ +/************************************************************************* + * + * $RCSfile: PluginManager.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:52 $ + * + * 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_plugin_PluginManager_idl__ +#define __com_sun_star_plugin_PluginManager_idl__ + +#ifndef __com_sun_star_plugin_XPluginManager_idl__ +#include <com/sun/star/plugin/XPluginManager.idl> +#endif + + +//============================================================================= + + module com { module sun { module star { module plugin { + +//============================================================================= + +// DocMerge from xml: service com::sun::star::plugin::PluginManager +/** makes it possible to create plugins. + */ +service PluginManager +{ + // DocMerge: empty anyway + interface com::sun::star::plugin::XPluginManager; + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:29 hjs + initial import + + Revision 1.3 2000/09/11 11:52:34 mi + documentation merged from XML + + Revision 1.1.1.1 1999/11/11 09:48:44 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/plugin/PluginMode.idl b/offapi/com/sun/star/plugin/PluginMode.idl new file mode 100644 index 000000000000..e8a508add6bb --- /dev/null +++ b/offapi/com/sun/star/plugin/PluginMode.idl @@ -0,0 +1,109 @@ +/************************************************************************* + * + * $RCSfile: PluginMode.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:52 $ + * + * 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_plugin_PluginMode_idl__ +#define __com_sun_star_plugin_PluginMode_idl__ + + +//============================================================================= + + module com { module sun { module star { module plugin { + +//============================================================================= + +// DocMerge: empty anyway +constants PluginMode +{ + //------------------------------------------------------------------------- + // DOCUMENTATION MISSING FOR constants::1 + + // DocMerge: empty anyway + const short EMBED = 1; + + //------------------------------------------------------------------------- + // DOCUMENTATION MISSING FOR constants::2 + + // DocMerge: empty anyway + const short FULL = 2; + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:29 hjs + initial import + + Revision 1.4 2000/09/11 11:52:34 mi + documentation merged from XML + + Revision 1.2 2000/02/07 11:24:42 mi + zu #70728# missing documentation marked + + Revision 1.1.1.1 1999/11/11 09:48:44 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/plugin/PluginVariable.idl b/offapi/com/sun/star/plugin/PluginVariable.idl new file mode 100644 index 000000000000..77cf58f1d670 --- /dev/null +++ b/offapi/com/sun/star/plugin/PluginVariable.idl @@ -0,0 +1,121 @@ +/************************************************************************* + * + * $RCSfile: PluginVariable.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:52 $ + * + * 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_plugin_PluginVariable_idl__ +#define __com_sun_star_plugin_PluginVariable_idl__ + + +//============================================================================= + + module com { module sun { module star { module plugin { + +//============================================================================= + +// DocMerge from xml: enum com::sun::star::plugin::PluginVariable +/** PluginVariable describes the possible parameters to XPluginContext::getValue + it describes what kind of object is requested + */ +enum PluginVariable +{ + //------------------------------------------------------------------------- + // DOCUMENTATION CHANGED FOR PluginVariable:: VxDisplay, + + // DocMerge from xml: value com::sun::star::plugin::PluginVariable::VxDisplay + /** XPluginContext::getValue will return the Xwindow Display pointer of + a display connection (UNIX only) + */ + VxDisplay, + + //------------------------------------------------------------------------- + // DOCUMENTATION CHANGED FOR PluginVariable:: VxtAppContext + + // DocMerge from xml: value com::sun::star::plugin::PluginVariable::VxtAppContext + /** XPluginContext::getValue will return the global Xt application context + (UNIX only) + */ + VxtAppContext + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:29 hjs + initial import + + Revision 1.5 2000/09/11 11:52:35 mi + documentation merged from XML + + Revision 1.3 2000/03/17 13:15:29 pl + #74035# documentation + + Revision 1.2 2000/02/07 11:24:42 mi + zu #70728# missing documentation marked + + Revision 1.1.1.1 1999/11/11 09:48:44 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/plugin/XPlugin.idl b/offapi/com/sun/star/plugin/XPlugin.idl new file mode 100644 index 000000000000..883bb1d3bb7e --- /dev/null +++ b/offapi/com/sun/star/plugin/XPlugin.idl @@ -0,0 +1,122 @@ +/************************************************************************* + * + * $RCSfile: XPlugin.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:52 $ + * + * 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_plugin_XPlugin_idl__ +#define __com_sun_star_plugin_XPlugin_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_io_XActiveDataSource_idl__ +#include <com/sun/star/io/XActiveDataSource.idl> +#endif + +#ifndef __com_sun_star_plugin_PluginException_idl__ +#include <com/sun/star/plugin/PluginException.idl> +#endif + + +//============================================================================= + + module com { module sun { module star { module plugin { + +//============================================================================= + +// DocMerge from xml: interface com::sun::star::plugin::XPlugin +/** allowes the container to control the plugin. + */ +[ uik(131ADEC1-BC48-11D2-AB2B0060-97759B97), ident( "XPlugin", 1.0 ) ] +interface XPlugin: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::plugin::XPlugin::provideNewStream + /** tells the plugin instance that a new stream is requested. + */ + boolean provideNewStream( [in] string mimetype, + [in] com::sun::star::io::XActiveDataSource aSource, + [in] string url, + [in] long length, + [in] long lastmodified, + [in] boolean isfile ) + raises( com::sun::star::plugin::PluginException ); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:29 hjs + initial import + + Revision 1.3 2000/09/11 11:52:35 mi + documentation merged from XML + + Revision 1.1.1.1 1999/11/11 09:48:44 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/plugin/XPluginContext.idl b/offapi/com/sun/star/plugin/XPluginContext.idl new file mode 100644 index 000000000000..5f986fa7aaeb --- /dev/null +++ b/offapi/com/sun/star/plugin/XPluginContext.idl @@ -0,0 +1,221 @@ +/************************************************************************* + * + * $RCSfile: XPluginContext.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:52 $ + * + * 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_plugin_XPluginContext_idl__ +#define __com_sun_star_plugin_XPluginContext_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_plugin_XPlugin_idl__ +#include <com/sun/star/plugin/XPlugin.idl> +#endif + +#ifndef __com_sun_star_plugin_PluginVariable_idl__ +#include <com/sun/star/plugin/PluginVariable.idl> +#endif + +#ifndef __com_sun_star_plugin_PluginException_idl__ +#include <com/sun/star/plugin/PluginException.idl> +#endif + +#ifndef __com_sun_star_lang_XEventListener_idl__ +#include <com/sun/star/lang/XEventListener.idl> +#endif + +#ifndef __com_sun_star_io_XActiveDataSource_idl__ +#include <com/sun/star/io/XActiveDataSource.idl> +#endif + + +//============================================================================= + + module com { module sun { module star { module plugin { + +//============================================================================= + +// DocMerge from xml: interface com::sun::star::plugin::XPluginContext +/** implements the calls a plugin library can make on its browser. + + + + <p>A default context can be created by a <type>XPluginManager</type>. + + </p>@see XPluginManager + */ +[ uik(131ADEC0-BC48-11D2-AB2B0060-97759B97), ident( "XPluginContext", 1.0 ) ] +interface XPluginContext: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + // DOCUMENTATION CHANGED FOR XPluginContext::getValue + + // DocMerge from xml: method com::sun::star::plugin::XPluginContext::getValue + /** requests global application parameters like display connection on UNIX systems + */ + string getValue( [in] com::sun::star::plugin::XPlugin xPlugin, + [in] com::sun::star::plugin::PluginVariable aVariable ) + raises( com::sun::star::plugin::PluginException ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::plugin::XPluginContext::getURLNotify + /** requests a notification of completion of the operation on an URL. + */ + void getURLNotify( [in] com::sun::star::plugin::XPlugin plugin, + [in] string url, + [in] string target, + [in] com::sun::star::lang::XEventListener listener ) + raises( com::sun::star::plugin::PluginException ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::plugin::XPluginContext::getURL + /** requests an URL to be loaded into the frame target. + */ + void getURL( [in] com::sun::star::plugin::XPlugin plugin, + [in] string url, + [in] string target ) + raises( com::sun::star::plugin::PluginException ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::plugin::XPluginContext::postURLNotify + /** posts data from a buffer or file to an URL and receives a + notification upon completion. + */ + void postURLNotify( [in] com::sun::star::plugin::XPlugin plugin, + [in] string url, + [in] string target, + [in] sequence<byte> buf, + [in] boolean file, + [in] com::sun::star::lang::XEventListener listener ) + raises( com::sun::star::plugin::PluginException ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::plugin::XPluginContext::postURL + /** posts data from a buffer or file to an URL. + */ + void postURL( [in] com::sun::star::plugin::XPlugin plugin, + [in] string url, + [in] string target, + [in] sequence<byte> buf, + [in] boolean file ) + raises( com::sun::star::plugin::PluginException ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::plugin::XPluginContext::newStream + /** requests a new stream that is created by the plugin and cosumed + by the browser. + */ + void newStream( [in] com::sun::star::plugin::XPlugin plugin, + [in] string mimetype, + [in] string target, + [in] com::sun::star::io::XActiveDataSource aSource ) + raises( com::sun::star::plugin::PluginException ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::plugin::XPluginContext::displayStatusText + /** displays a message in the browser status line. + */ + void displayStatusText( [in] com::sun::star::plugin::XPlugin plugin, + [in] string message ) + raises( com::sun::star::plugin::PluginException ); + + //------------------------------------------------------------------------- + // DOCUMENTATION CHANGED FOR XPluginContext::getUserAgent + + // DocMerge from xml: method com::sun::star::plugin::XPluginContext::getUserAgent + /** returns an application dependant identification string. This is + the same string that is transmitted by a browser to an http server. + */ + string getUserAgent( [in] com::sun::star::plugin::XPlugin plugin ) + raises( com::sun::star::plugin::PluginException ); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:29 hjs + initial import + + Revision 1.5 2000/09/11 11:52:35 mi + documentation merged from XML + + Revision 1.3 2000/03/17 13:15:29 pl + #74035# documentation + + Revision 1.2 2000/02/07 11:24:42 mi + zu #70728# missing documentation marked + + Revision 1.1.1.1 1999/11/11 09:48:44 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/plugin/XPluginManager.idl b/offapi/com/sun/star/plugin/XPluginManager.idl new file mode 100644 index 000000000000..d0b66dfcfd23 --- /dev/null +++ b/offapi/com/sun/star/plugin/XPluginManager.idl @@ -0,0 +1,184 @@ +/************************************************************************* + * + * $RCSfile: XPluginManager.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:52 $ + * + * 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_plugin_XPluginManager_idl__ +#define __com_sun_star_plugin_XPluginManager_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_plugin_XPluginContext_idl__ +#include <com/sun/star/plugin/XPluginContext.idl> +#endif + +#ifndef __com_sun_star_plugin_PluginDescription_idl__ +#include <com/sun/star/plugin/PluginDescription.idl> +#endif + +#ifndef __com_sun_star_plugin_XPlugin_idl__ +#include <com/sun/star/plugin/XPlugin.idl> +#endif + +#ifndef __com_sun_star_plugin_PluginException_idl__ +#include <com/sun/star/plugin/PluginException.idl> +#endif + +#ifndef __com_sun_star_awt_XToolkit_idl__ +#include <com/sun/star/awt/XToolkit.idl> +#endif + +#ifndef __com_sun_star_awt_XWindowPeer_idl__ +#include <com/sun/star/awt/XWindowPeer.idl> +#endif + + +//============================================================================= + + module com { module sun { module star { module plugin { + +//============================================================================= + +// DocMerge from xml: interface com::sun::star::plugin::XPluginManager +/** manages all plugin instances. + + + + <p>Plugins can be created only from an <type>XPluginManager</type>. + It also creates <type>XPluginContext</type> objects, + which can be overloaded by aggregation.</p> + */ +[ uik(131ADEC2-BC48-11D2-AB2B0060-97759B97), ident( "XPluginManager", 1.0 ) ] +interface XPluginManager: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::plugin::XPluginManager::createPluginContext + /** creates a default context. + + + + <p>This context depends on the service + <type scope="com::sun::star::frame">Desktop</type>.</p> + */ + com::sun::star::plugin::XPluginContext createPluginContext(); + + //------------------------------------------------------------------------- + + // DOCUMENTATION CHANGED FOR XPluginManager::getPluginDescriptions + + + // DocMerge from idl: method com::sun::star::plugin::XPluginManager::getPluginDescriptions + /** returns the descriptions for all available plugins. + */ + sequence<com::sun::star::plugin::PluginDescription> getPluginDescriptions(); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::plugin::XPluginManager::createPlugin + /** creates a new plugin instance. + */ + com::sun::star::plugin::XPlugin createPlugin( [in] com::sun::star::plugin::XPluginContext acontext, + [in] short mode, + [in] sequence<string> argn, + [in] sequence<string> argv, + [in] com::sun::star::plugin::PluginDescription plugintype ) + raises( com::sun::star::plugin::PluginException ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::plugin::XPluginManager::createPluginFromURL + /** creates a new plugin instance. + */ + com::sun::star::plugin::XPlugin createPluginFromURL( [in] com::sun::star::plugin::XPluginContext acontext, + [in] short mode, + [in] sequence<string> argn, + [in] sequence<string> argv, + [in] com::sun::star::awt::XToolkit toolkit, + [in] com::sun::star::awt::XWindowPeer parent, + [in] string url ); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:29 hjs + initial import + + Revision 1.5 2000/09/11 11:52:35 mi + documentation merged from XML + + Revision 1.3 2000/03/17 13:15:29 pl + #74035# documentation + + Revision 1.2 2000/02/07 11:24:42 mi + zu #70728# missing documentation marked + + Revision 1.1.1.1 1999/11/11 09:48:44 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/plugin/makefile.mk b/offapi/com/sun/star/plugin/makefile.mk new file mode 100644 index 000000000000..e497ce07ed3a --- /dev/null +++ b/offapi/com/sun/star/plugin/makefile.mk @@ -0,0 +1,88 @@ +#************************************************************************* +# +# $RCSfile: makefile.mk,v $ +# +# $Revision: 1.1 $ +# +# last change: $Author: mi $ $Date: 2000-11-06 09:21:52 $ +# +# 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): _______________________________________ +# +# +# +#************************************************************************* + +PRJ=..$/..$/..$/.. + +PRJNAME=api + +TARGET=cssplugin +PACKAGE=com$/sun$/star$/plugin + +# --- Settings ----------------------------------------------------- +.INCLUDE : $(PRJ)$/util$/makefile.pmk + +# ------------------------------------------------------------------------ + +IDLFILES=\ + PluginDescription.idl\ + PluginException.idl\ + PluginManager.idl\ + PluginMode.idl\ + PluginVariable.idl\ + XPlugin.idl\ + XPluginContext.idl\ + XPluginManager.idl\ + +# ------------------------------------------------------------------ + +.INCLUDE : target.mk +.INCLUDE : $(PRJ)$/util$/target.pmk |