From 88c437c597b604524d50f450506285a594bd03a5 Mon Sep 17 00:00:00 2001 From: Michael Hönnig Date: Mon, 6 Nov 2000 08:23:00 +0000 Subject: moved from api --- offapi/com/sun/star/frame/Components.idl | 112 +++++++ offapi/com/sun/star/frame/Controller.idl | 123 +++++++ offapi/com/sun/star/frame/Desktop.idl | 221 +++++++++++++ offapi/com/sun/star/frame/DesktopTask.idl | 194 +++++++++++ offapi/com/sun/star/frame/DesktopTasks.idl | 111 +++++++ offapi/com/sun/star/frame/DispatchDescriptor.idl | 126 ++++++++ offapi/com/sun/star/frame/FeatureStateEvent.idl | 154 +++++++++ offapi/com/sun/star/frame/Frame.idl | 138 ++++++++ offapi/com/sun/star/frame/FrameAction.idl | 201 ++++++++++++ offapi/com/sun/star/frame/FrameActionEvent.idl | 129 ++++++++ offapi/com/sun/star/frame/FrameControl.idl | 144 +++++++++ offapi/com/sun/star/frame/FrameLoader.idl | 108 +++++++ offapi/com/sun/star/frame/FrameSearchFlag.idl | 165 ++++++++++ offapi/com/sun/star/frame/FramesContainer.idl | 116 +++++++ .../sun/star/frame/MediaTypeDetectionHelper.idl | 110 +++++++ offapi/com/sun/star/frame/Settings.idl | 103 ++++++ .../sun/star/frame/TerminationVetoException.idl | 101 ++++++ offapi/com/sun/star/frame/WindowArrange.idl | 144 +++++++++ .../com/sun/star/frame/XBrowseHistoryRegistry.idl | 123 +++++++ offapi/com/sun/star/frame/XComponentLoader.idl | 136 ++++++++ offapi/com/sun/star/frame/XComponentRegistry.idl | 125 +++++++ offapi/com/sun/star/frame/XConfigManager.idl | 133 ++++++++ offapi/com/sun/star/frame/XController.idl | 170 ++++++++++ offapi/com/sun/star/frame/XDesktop.idl | 209 ++++++++++++ offapi/com/sun/star/frame/XDesktopTask.idl | 125 +++++++ offapi/com/sun/star/frame/XDispatch.idl | 191 +++++++++++ offapi/com/sun/star/frame/XDispatchProvider.idl | 144 +++++++++ .../star/frame/XDispatchProviderInterception.idl | 132 ++++++++ .../star/frame/XDispatchProviderInterceptor.idl | 149 +++++++++ .../sun/star/frame/XExtendedFilterDetection.idl | 112 +++++++ offapi/com/sun/star/frame/XFilterDetect.idl | 129 ++++++++ offapi/com/sun/star/frame/XFrame.idl | 358 +++++++++++++++++++++ offapi/com/sun/star/frame/XFrameActionListener.idl | 119 +++++++ offapi/com/sun/star/frame/XFrameLoader.idl | 133 ++++++++ offapi/com/sun/star/frame/XFrameLoaderQuery.idl | 147 +++++++++ offapi/com/sun/star/frame/XFrameSetModel.idl | 131 ++++++++ offapi/com/sun/star/frame/XFrames.idl | 159 +++++++++ offapi/com/sun/star/frame/XFramesSupplier.idl | 165 ++++++++++ offapi/com/sun/star/frame/XInterceptorInfo.idl | 103 ++++++ offapi/com/sun/star/frame/XLoadEventListener.idl | 116 +++++++ offapi/com/sun/star/frame/XModel.idl | 294 +++++++++++++++++ offapi/com/sun/star/frame/XStatusListener.idl | 118 +++++++ offapi/com/sun/star/frame/XStorable.idl | 237 ++++++++++++++ offapi/com/sun/star/frame/XTask.idl | 144 +++++++++ offapi/com/sun/star/frame/XTasksSupplier.idl | 138 ++++++++ offapi/com/sun/star/frame/XTerminateListener.idl | 126 ++++++++ offapi/com/sun/star/frame/XUrlList.idl | 88 +++++ offapi/com/sun/star/frame/XWindowArranger.idl | 118 +++++++ offapi/com/sun/star/frame/makefile.mk | 128 ++++++++ 49 files changed, 7200 insertions(+) create mode 100644 offapi/com/sun/star/frame/Components.idl create mode 100644 offapi/com/sun/star/frame/Controller.idl create mode 100644 offapi/com/sun/star/frame/Desktop.idl create mode 100644 offapi/com/sun/star/frame/DesktopTask.idl create mode 100644 offapi/com/sun/star/frame/DesktopTasks.idl create mode 100644 offapi/com/sun/star/frame/DispatchDescriptor.idl create mode 100644 offapi/com/sun/star/frame/FeatureStateEvent.idl create mode 100644 offapi/com/sun/star/frame/Frame.idl create mode 100644 offapi/com/sun/star/frame/FrameAction.idl create mode 100644 offapi/com/sun/star/frame/FrameActionEvent.idl create mode 100644 offapi/com/sun/star/frame/FrameControl.idl create mode 100644 offapi/com/sun/star/frame/FrameLoader.idl create mode 100644 offapi/com/sun/star/frame/FrameSearchFlag.idl create mode 100644 offapi/com/sun/star/frame/FramesContainer.idl create mode 100644 offapi/com/sun/star/frame/MediaTypeDetectionHelper.idl create mode 100644 offapi/com/sun/star/frame/Settings.idl create mode 100644 offapi/com/sun/star/frame/TerminationVetoException.idl create mode 100644 offapi/com/sun/star/frame/WindowArrange.idl create mode 100644 offapi/com/sun/star/frame/XBrowseHistoryRegistry.idl create mode 100644 offapi/com/sun/star/frame/XComponentLoader.idl create mode 100644 offapi/com/sun/star/frame/XComponentRegistry.idl create mode 100644 offapi/com/sun/star/frame/XConfigManager.idl create mode 100644 offapi/com/sun/star/frame/XController.idl create mode 100644 offapi/com/sun/star/frame/XDesktop.idl create mode 100644 offapi/com/sun/star/frame/XDesktopTask.idl create mode 100644 offapi/com/sun/star/frame/XDispatch.idl create mode 100644 offapi/com/sun/star/frame/XDispatchProvider.idl create mode 100644 offapi/com/sun/star/frame/XDispatchProviderInterception.idl create mode 100644 offapi/com/sun/star/frame/XDispatchProviderInterceptor.idl create mode 100644 offapi/com/sun/star/frame/XExtendedFilterDetection.idl create mode 100644 offapi/com/sun/star/frame/XFilterDetect.idl create mode 100644 offapi/com/sun/star/frame/XFrame.idl create mode 100644 offapi/com/sun/star/frame/XFrameActionListener.idl create mode 100644 offapi/com/sun/star/frame/XFrameLoader.idl create mode 100644 offapi/com/sun/star/frame/XFrameLoaderQuery.idl create mode 100644 offapi/com/sun/star/frame/XFrameSetModel.idl create mode 100644 offapi/com/sun/star/frame/XFrames.idl create mode 100644 offapi/com/sun/star/frame/XFramesSupplier.idl create mode 100644 offapi/com/sun/star/frame/XInterceptorInfo.idl create mode 100644 offapi/com/sun/star/frame/XLoadEventListener.idl create mode 100644 offapi/com/sun/star/frame/XModel.idl create mode 100644 offapi/com/sun/star/frame/XStatusListener.idl create mode 100644 offapi/com/sun/star/frame/XStorable.idl create mode 100644 offapi/com/sun/star/frame/XTask.idl create mode 100644 offapi/com/sun/star/frame/XTasksSupplier.idl create mode 100644 offapi/com/sun/star/frame/XTerminateListener.idl create mode 100644 offapi/com/sun/star/frame/XUrlList.idl create mode 100644 offapi/com/sun/star/frame/XWindowArranger.idl create mode 100644 offapi/com/sun/star/frame/makefile.mk (limited to 'offapi/com/sun/star/frame') diff --git a/offapi/com/sun/star/frame/Components.idl b/offapi/com/sun/star/frame/Components.idl new file mode 100644 index 000000000000..be11281f2d5c --- /dev/null +++ b/offapi/com/sun/star/frame/Components.idl @@ -0,0 +1,112 @@ +/************************************************************************* + * + * $RCSfile: Components.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:43 $ + * + * 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_frame_Components_idl__ +#define __com_sun_star_frame_Components_idl__ + +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include +#endif + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from xml: service com::sun::star::frame::Components +/** specifies a collection of components. + + + +

One important instance of this service is available from the + Desktop object via the XDesktop interface.

@see interface com::sun::star::lang::XComponent + @see interface XDesktop + */ +service Components +{ + // DocMerge: empty anyway + interface com::sun::star::container::XEnumerationAccess; + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.2 2000/10/09 14:24:56 mi + #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) + + Revision 1.1.1.1 2000/09/18 23:35:20 hjs + initial import + + Revision 1.5 2000/09/11 11:52:27 mi + documentation merged from XML + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/Controller.idl b/offapi/com/sun/star/frame/Controller.idl new file mode 100644 index 000000000000..888b6317bf29 --- /dev/null +++ b/offapi/com/sun/star/frame/Controller.idl @@ -0,0 +1,123 @@ +/************************************************************************* + * + * $RCSfile: Controller.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:43 $ + * + * 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_frame_Controller_idl__ +#define __com_sun_star_frame_Controller_idl__ + +#ifndef __com_sun_star_frame_XController_idl__ +#include +#endif + +#ifndef __com_sun_star_frame_XDispatchProvider_idl__ +#include +#endif + +#ifndef __com_sun_star_awt_XWindow_idl__ +#include +#endif + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from xml: service com::sun::star::frame::Controller +/** is an abstract service for a component which offers a deeper integration of + desktop components than a UnoControl + can offer. + */ +service Controller +{ + // DocMerge: empty anyway + interface com::sun::star::frame::XController; + + // DocMerge: empty anyway + interface com::sun::star::frame::XDispatchProvider; + + + // DocMerge from xml: service com::sun::star::frame::Controller: interface com::sun::star::awt::XWindow + /** Possibly the controller and the main window of the component + is the same object. + */ + interface com::sun::star::awt::XWindow; + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:20 hjs + initial import + + Revision 1.5 2000/09/11 11:52:27 mi + documentation merged from XML + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/Desktop.idl b/offapi/com/sun/star/frame/Desktop.idl new file mode 100644 index 000000000000..4084daf9c52c --- /dev/null +++ b/offapi/com/sun/star/frame/Desktop.idl @@ -0,0 +1,221 @@ +/************************************************************************* + * + * $RCSfile: Desktop.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:43 $ + * + * 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_frame_Desktop_idl__ +#define __com_sun_star_frame_Desktop_idl__ + +#ifndef __com_sun_star_frame_Frame_idl__ +#include +#endif + +#ifndef __com_sun_star_lang_Locale_idl__ +#include +#endif + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include +#endif + +//============================================================================= + + module com { module sun { module star { module frame { + +interface XDesktop; +interface XComponentLoader; +interface XTasksSupplier; + +//============================================================================= + +// DocMerge from xml: service com::sun::star::frame::Desktop +/** is the environment for components which can instanciate within frames. + + + +

A desktop environment contains tasks with one or more frames + in which components can be loaded.

+ */ +service Desktop +{ + // DocMerge: empty anyway + service Frame; + + // DocMerge: empty anyway + interface XDesktop; + + // DocMerge: empty anyway + interface XComponentLoader; + + // DocMerge: empty anyway + interface XTasksSupplier; + + // DocMerge: empty anyway + interface com::sun::star::beans::XPropertySet; + + //------------------------------------------------------------------------- + + // DocMerge from xml: property com::sun::star::frame::Desktop::HasBeamer + /** determines if the beamer window is on or off. + */ + [property] boolean HasBeamer; + + //------------------------------------------------------------------------- + + // DocMerge from xml: property com::sun::star::frame::Desktop::HasCommonTaskBar + /** determines if the common task bar toolbar is on or off. + */ + [property] boolean HasCommonTaskBar; + + //------------------------------------------------------------------------- + + // DocMerge from xml: property com::sun::star::frame::Desktop::HasStylist + /** determines if the stylist window is on or off. + */ + [property] boolean HasStylist; + + //------------------------------------------------------------------------- + + // DocMerge from xml: property com::sun::star::frame::Desktop::HasExplorer + /** determines if the explorer window is on or off. + */ + [property] boolean HasExplorer; + + //------------------------------------------------------------------------- + + // DocMerge from xml: property com::sun::star::frame::Desktop::HasFunctionBar + /** determines if the function toolbar is on or off. + */ + [property] boolean HasFunctionBar; + + //------------------------------------------------------------------------- + + // DocMerge from xml: property com::sun::star::frame::Desktop::HasMacroBar + /** determines if the macro toolbar is on or off. + */ + [property] boolean HasMacroBar; + + //------------------------------------------------------------------------- + + // DocMerge from xml: property com::sun::star::frame::Desktop::HasNavigator + /** determines if the navigator window is on or off. + */ + [property] boolean HasNavigator; + + //------------------------------------------------------------------------- + + // DocMerge from xml: property com::sun::star::frame::Desktop::HasObjectBar + /** determines if the object toolbar is on or off. + */ + [property] boolean HasObjectBar; + + //------------------------------------------------------------------------- + + // DocMerge from xml: property com::sun::star::frame::Desktop::HasOptionBar + /** determines if the option toolbar is on or off. + */ + [property] boolean HasOptionBar; + + //------------------------------------------------------------------------- + + // DocMerge from xml: property com::sun::star::frame::Desktop::HasStatusBar + /** determines if the statusbar is on or off. + */ + [property] boolean HasStatusBar; + + //------------------------------------------------------------------------- + + // DocMerge from xml: property com::sun::star::frame::Desktop::HasToolBar + /** determines if the tools toolbar is on or off. + */ + [property] boolean HasToolBar; + + //------------------------------------------------------------------------- + + // DocMerge from xml: property com::sun::star::frame::Desktop::ISOLocale + /** read-only property to get ISO-Language and ISO-Country. + */ + [property] com::sun::star::lang::Locale ISOLocale; + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:20 hjs + initial import + + Revision 1.7 2000/09/11 11:52:27 mi + documentation merged from XML + + Revision 1.3 2000/02/09 15:45:28 mi + #72875# HasDesigner is now HasStylist + + Revision 1.2 2000/02/09 10:39:35 as + #72208# new property ISOLocale + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/DesktopTask.idl b/offapi/com/sun/star/frame/DesktopTask.idl new file mode 100644 index 000000000000..f5c885e4efc7 --- /dev/null +++ b/offapi/com/sun/star/frame/DesktopTask.idl @@ -0,0 +1,194 @@ +/************************************************************************* + * + * $RCSfile: DesktopTask.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:43 $ + * + * 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_frame_DesktopTask_idl__ +#define __com_sun_star_frame_DesktopTask_idl__ + +#ifndef __com_sun_star_frame_XDesktopTask_idl__ +#include +#endif + +#ifndef __com_sun_star_frame_XFrame_idl__ +#include +#endif + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include +#endif + +#ifndef __com_sun_star_frame_XWindowArranger_idl__ +#include +#endif + +#ifndef __com_sun_star_frame_XFramesSupplier_idl__ +#include +#endif + +#ifndef __com_sun_star_awt_Point_idl__ +#include +#endif + +#ifndef __com_sun_star_awt_Size_idl__ +#include +#endif + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from xml: service com::sun::star::frame::DesktopTask +/** specifies a separate task within a desktop environment.@see service DesktopTasks + */ +service DesktopTask +{ + // DocMerge: empty anyway + interface com::sun::star::frame::XDesktopTask; + + // DocMerge: empty anyway + interface com::sun::star::frame::XFrame; + + // DocMerge: empty anyway + interface com::sun::star::beans::XPropertySet; + + // DocMerge: empty anyway + interface com::sun::star::frame::XWindowArranger; + + // DocMerge: empty anyway + interface com::sun::star::frame::XFramesSupplier; + + //------------------------------------------------------------------------- + + // DocMerge from xml: property com::sun::star::frame::DesktopTask::Title + /** contains the title of the component which is active within the task. + */ + [readonly, property] string Title; + + //------------------------------------------------------------------------- + + // DocMerge from xml: property com::sun::star::frame::DesktopTask::IsDesktop + /** determines if the task is the desktop task. + */ + [readonly, property] boolean IsDesktop; + + //------------------------------------------------------------------------- + + // DocMerge from xml: property com::sun::star::frame::DesktopTask::IsVisible + /** determines if the task is visible or not. + */ + [property] boolean IsVisible; + + //------------------------------------------------------------------------- + + // DocMerge from xml: property com::sun::star::frame::DesktopTask::IsFloating + /** determines if the task is floating or not. + */ + [property] boolean IsFloating; + + //------------------------------------------------------------------------- + + // DocMerge from xml: property com::sun::star::frame::DesktopTask::IsAlwaysVisible + /** determines if the task is always visible or only when active. + */ + [property] boolean IsAlwaysVisible; + + //------------------------------------------------------------------------- + + // DocMerge from xml: property com::sun::star::frame::DesktopTask::Position + /** contains the position in pixel relative to the desktop window. + */ + [property] com::sun::star::awt::Point Position; + + //------------------------------------------------------------------------- + + // DocMerge from xml: property com::sun::star::frame::DesktopTask::Size + /** contains the size in pixel. + */ + [property] com::sun::star::awt::Size Size; + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:20 hjs + initial import + + Revision 1.7 2000/09/11 11:52:27 mi + documentation merged from XML + + Revision 1.3 2000/02/21 16:18:01 mi + string documentation from stardiv...*.idl-files + + Revision 1.2 2000/01/31 09:44:58 mi + XML syntax for documentation + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/DesktopTasks.idl b/offapi/com/sun/star/frame/DesktopTasks.idl new file mode 100644 index 000000000000..a27a67a5a365 --- /dev/null +++ b/offapi/com/sun/star/frame/DesktopTasks.idl @@ -0,0 +1,111 @@ +/************************************************************************* + * + * $RCSfile: DesktopTasks.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:43 $ + * + * 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_frame_DesktopTasks_idl__ +#define __com_sun_star_frame_DesktopTasks_idl__ + +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include +#endif + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from xml: service com::sun::star::frame::DesktopTasks +/** specifies a collection of tasks. + + + +

One important instance of this service is available from the + Desktop object via the XDesktop interface. + +

@see service DesktopTask + @see interface XDesktop + */ +service DesktopTasks +{ + // DocMerge: empty anyway + interface com::sun::star::container::XEnumerationAccess; + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:20 hjs + initial import + + Revision 1.5 2000/09/11 11:52:27 mi + documentation merged from XML + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/DispatchDescriptor.idl b/offapi/com/sun/star/frame/DispatchDescriptor.idl new file mode 100644 index 000000000000..d26dd51c9b9d --- /dev/null +++ b/offapi/com/sun/star/frame/DispatchDescriptor.idl @@ -0,0 +1,126 @@ +/************************************************************************* + * + * $RCSfile: DispatchDescriptor.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:43 $ + * + * 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_frame_DispatchDescriptor_idl__ +#define __com_sun_star_frame_DispatchDescriptor_idl__ + +#ifndef __com_sun_star_util_URL_idl__ +#include +#endif + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from xml: struct com::sun::star::frame::DispatchDescriptor +/** describes a feature to be retrieved by an URL that + has to be loaded into a specified frame. + */ +struct DispatchDescriptor +{ + // DocMerge from xml: field com::sun::star::frame::DispatchDescriptor::FeatureURL + /** Specifies the URL of the resource/function. + */ + com::sun::star::util::URL FeatureURL; + + //------------------------------------------------------------------------- + + // DocMerge from xml: field com::sun::star::frame::DispatchDescriptor::FrameName + /** Name of the target frame. + */ + string FrameName; + + //------------------------------------------------------------------------- + + // DocMerge from xml: field com::sun::star::frame::DispatchDescriptor::SearchFlags + /** How the target frame is to be searched. + */ + long SearchFlags; + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:20 hjs + initial import + + Revision 1.7 2000/09/11 11:52:27 mi + documentation merged from XML + + Revision 1.3 2000/02/21 16:18:01 mi + string documentation from stardiv...*.idl-files + + Revision 1.2 2000/01/31 09:44:58 mi + XML syntax for documentation + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/FeatureStateEvent.idl b/offapi/com/sun/star/frame/FeatureStateEvent.idl new file mode 100644 index 000000000000..bfb8ade1bf3a --- /dev/null +++ b/offapi/com/sun/star/frame/FeatureStateEvent.idl @@ -0,0 +1,154 @@ +/************************************************************************* + * + * $RCSfile: FeatureStateEvent.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:43 $ + * + * 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_frame_FeatureStateEvent_idl__ +#define __com_sun_star_frame_FeatureStateEvent_idl__ + +#ifndef __com_sun_star_lang_EventObject_idl__ +#include +#endif + +#ifndef __com_sun_star_util_URL_idl__ +#include +#endif + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from xml: struct com::sun::star::frame::FeatureStateEvent +/** This event is broadcasted by a Controller whenever the state of + the feature changes.@see interface XController + @see interface XStatusListener + */ +struct FeatureStateEvent: com::sun::star::lang::EventObject +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: field com::sun::star::frame::FeatureStateEvent::FeatureURL + /** contains the URL of the feature. + */ + com::sun::star::util::URL FeatureURL; + + //------------------------------------------------------------------------- + + // DocMerge from xml: field com::sun::star::frame::FeatureStateEvent::FeatureDescriptor + /** contains a descriptor of the feature for the user interface. + */ + string FeatureDescriptor; + + //------------------------------------------------------------------------- + + // DocMerge from xml: field com::sun::star::frame::FeatureStateEvent::IsEnabled + /** specifies whether the feature is currently enabled or disabled. + */ + boolean IsEnabled; + + //------------------------------------------------------------------------- + + // DocMerge from xml: field com::sun::star::frame::FeatureStateEvent::Requery + /** specifies whether the XDispatch has to be requeried. + */ + boolean Requery; + + //------------------------------------------------------------------------- + + // DocMerge from xml: field com::sun::star::frame::FeatureStateEvent::State + /** contains the state of the feature in this dispatch. + + + +

This can be, for example, simply for a boolean feature like + underline on/off. Some simple types like string or + boolean are useful here for generic UI elements, like + a checkmark in a menu.

+ */ + any State; + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:20 hjs + initial import + + Revision 1.7 2000/09/11 11:52:27 mi + documentation merged from XML + + Revision 1.3 2000/02/23 14:49:55 mi + missing documentations + + Revision 1.2 2000/01/31 09:44:58 mi + XML syntax for documentation + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/Frame.idl b/offapi/com/sun/star/frame/Frame.idl new file mode 100644 index 000000000000..60fa20d08ba2 --- /dev/null +++ b/offapi/com/sun/star/frame/Frame.idl @@ -0,0 +1,138 @@ +/************************************************************************* + * + * $RCSfile: Frame.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:43 $ + * + * 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_frame_Frame_idl__ +#define __com_sun_star_frame_Frame_idl__ + +#ifndef __com_sun_star_frame_XFrame_idl__ +#include +#endif + +#ifndef __com_sun_star_frame_XDispatchProvider_idl__ +#include +#endif + +#ifndef __com_sun_star_frame_XFramesSupplier_idl__ +#include +#endif + +#ifndef __com_sun_star_task_XStatusIndicatorFactory_idl__ +#include +#endif + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from xml: service com::sun::star::frame::Frame +/** represents the environment for a desktop component. + */ +service Frame +{ + + + // DocMerge from xml: service com::sun::star::frame::Frame: interface com::sun::star::frame::XFrame + /** allows the component to be load and accessed + within the frame; it is the main connection to the + environment of the component. + */ + interface com::sun::star::frame::XFrame; + + // DocMerge: empty anyway + interface com::sun::star::frame::XDispatchProvider; + + + // DocMerge from xml: service com::sun::star::frame::Frame: interface com::sun::star::frame::XFramesSupplier + /** This optional interface is used to access sub-frames within this + Frame. + */ + interface com::sun::star::frame::XFramesSupplier; + + + // DocMerge from xml: service com::sun::star::frame::Frame: interface com::sun::star::task::XStatusIndicatorFactory + /** This optional interface supplies access to XStatusIndicators + for the component within the frame. + */ + interface com::sun::star::task::XStatusIndicatorFactory; + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:20 hjs + initial import + + Revision 1.5 2000/09/11 11:52:27 mi + documentation merged from XML + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/FrameAction.idl b/offapi/com/sun/star/frame/FrameAction.idl new file mode 100644 index 000000000000..2d60a6121f62 --- /dev/null +++ b/offapi/com/sun/star/frame/FrameAction.idl @@ -0,0 +1,201 @@ +/************************************************************************* + * + * $RCSfile: FrameAction.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:43 $ + * + * 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_frame_FrameAction_idl__ +#define __com_sun_star_frame_FrameAction_idl__ + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from xml: enum com::sun::star::frame::FrameAction +/** These are the events which can happen to the components in frames + of the desktop. + */ +enum FrameAction +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: value com::sun::star::frame::FrameAction::COMPONENT_ATTACHED + /** An event of this kind is broadcast whenever a component is + attached to a frame. + + + +

This is almost the same as the instanciation of the component + within that frame. The component is attached to the frame + immediately before this event is broadcast.

@see XFrame::activated + */ + COMPONENT_ATTACHED, + + //------------------------------------------------------------------------- + + // DocMerge from xml: value com::sun::star::frame::FrameAction::COMPONENT_DETACHING + /** An event of this kind is broadcast whenever a component is + detaching from a frame. + + + +

This is quite the same as the destruction of the component + which was in that frame. At the moment when the event is broadcast + the component is still attached to the frame but in the next + moment it won't. + +

+ */ + COMPONENT_DETACHING, + + //------------------------------------------------------------------------- + + // DocMerge from xml: value com::sun::star::frame::FrameAction::COMPONENT_REATTACHED + /** An event of this kind is broadcast whenever a component is + attached to a new model. + + + +

In this case the component remains the same but operates + on a new model component.

+ */ + COMPONENT_REATTACHED, + + //------------------------------------------------------------------------- + + // DocMerge from xml: value com::sun::star::frame::FrameAction::FRAME_ACTIVATED + /** An event of this kind is broadcast whenever a component gets + activated. + + + +

Activations are broacast from the top component which was + not active before, down to the inner most component.

@see XFrame::activated + */ + FRAME_ACTIVATED, + + //------------------------------------------------------------------------- + + // DocMerge from xml: value com::sun::star::frame::FrameAction::FRAME_DEACTIVATING + /** An event of this kind is broadcasted immediately before the + component is deactivated. + + + +

Deactivations are broadcast from the innermost component which + does not stay active up to the outer most component which does not + stay active. + +

@see XFrame::contextChanged + */ + FRAME_DEACTIVATING, + + //------------------------------------------------------------------------- + + // DocMerge from xml: value com::sun::star::frame::FrameAction::CONTEXT_CHANGED + /** An event of this kind is broadcast whenever a component changed + its internal context (i.e. the selection). + + + +

If the activation status within a frame changes, this counts as + a context change too. + +

+ */ + CONTEXT_CHANGED, + + //------------------------------------------------------------------------- + + // DocMerge from xml: value com::sun::star::frame::FrameAction::FRAME_UI_ACTIVATED + /** An event of this kind is broadcast by an active frame when it + is getting UI control (tool control). + */ + FRAME_UI_ACTIVATED, + + //------------------------------------------------------------------------- + + // DocMerge from xml: value com::sun::star::frame::FrameAction::FRAME_UI_DEACTIVATING + /** An event of this kind is broadcast by an active frame when it + is losing UI control (tool control). + */ + FRAME_UI_DEACTIVATING + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:20 hjs + initial import + + Revision 1.5 2000/09/11 11:52:27 mi + documentation merged from XML + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/FrameActionEvent.idl b/offapi/com/sun/star/frame/FrameActionEvent.idl new file mode 100644 index 000000000000..78b0d24d53be --- /dev/null +++ b/offapi/com/sun/star/frame/FrameActionEvent.idl @@ -0,0 +1,129 @@ +/************************************************************************* + * + * $RCSfile: FrameActionEvent.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:43 $ + * + * 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_frame_FrameActionEvent_idl__ +#define __com_sun_star_frame_FrameActionEvent_idl__ + +#ifndef __com_sun_star_lang_EventObject_idl__ +#include +#endif + +#ifndef __com_sun_star_frame_XFrame_idl__ +#include +#endif + +#ifndef __com_sun_star_frame_FrameAction_idl__ +#include +#endif + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from xml: struct com::sun::star::frame::FrameActionEvent +/** This event struct is broadcast for actions which can happen to + components within frames.@see interface XFrameActionListener + */ +struct FrameActionEvent: com::sun::star::lang::EventObject +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: field com::sun::star::frame::FrameActionEvent::Frame + /** contains the frame in which the event occured. + */ + com::sun::star::frame::XFrame Frame; + + //------------------------------------------------------------------------- + + // DocMerge from xml: field com::sun::star::frame::FrameActionEvent::Action + /** specifies the concrete event. + */ + com::sun::star::frame::FrameAction Action; + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:20 hjs + initial import + + Revision 1.7 2000/09/11 11:52:28 mi + documentation merged from XML + + Revision 1.3 2000/02/23 14:49:55 mi + missing documentations + + Revision 1.2 2000/01/31 09:44:58 mi + XML syntax for documentation + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/FrameControl.idl b/offapi/com/sun/star/frame/FrameControl.idl new file mode 100644 index 000000000000..0a374d820a2c --- /dev/null +++ b/offapi/com/sun/star/frame/FrameControl.idl @@ -0,0 +1,144 @@ +/************************************************************************* + * + * $RCSfile: FrameControl.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:43 $ + * + * 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_frame_FrameControl_idl__ +#define __com_sun_star_frame_FrameControl_idl__ + +#ifndef __com_sun_star_awt_UnoControl_idl__ +#include +#endif + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include +#endif + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from xml: service com::sun::star::frame::FrameControl +/** contains a frame with a desktop component. + + + +

If the control is visible and has a valid (loadable) component URL, + then the FrameControl::Frame property is set.

+ */ +service FrameControl +{ + + + // DocMerge from xml: service com::sun::star::frame::FrameControl: service com::sun::star::awt::UnoControl + /** The base service of all controls. + */ + service com::sun::star::awt::UnoControl; + + + // DocMerge from xml: service com::sun::star::frame::FrameControl: interface com::sun::star::beans::XPropertySet + /** provides access to the properties of this service. + */ + interface com::sun::star::beans::XPropertySet; + + //------------------------------------------------------------------------- + + // DocMerge from xml: property com::sun::star::frame::FrameControl::ComponentUrl + /** contains the type of the component which is loaded into the frame + or the document which implicitly specifies the type. + */ + [property] string ComponentUrl; + + //------------------------------------------------------------------------- + + // DocMerge from xml: property com::sun::star::frame::FrameControl::Frame + /** The frame held by this control. The Frame is created if the control + is shown and the component's URL is set. + */ + [readonly, property] string Frame; + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:20 hjs + initial import + + Revision 1.7 2000/09/11 11:52:28 mi + documentation merged from XML + + Revision 1.3 2000/02/21 16:18:01 mi + string documentation from stardiv...*.idl-files + + Revision 1.2 2000/01/31 09:44:58 mi + XML syntax for documentation + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/FrameLoader.idl b/offapi/com/sun/star/frame/FrameLoader.idl new file mode 100644 index 000000000000..0d57fca4b387 --- /dev/null +++ b/offapi/com/sun/star/frame/FrameLoader.idl @@ -0,0 +1,108 @@ +/************************************************************************* + * + * $RCSfile: FrameLoader.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:43 $ + * + * 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_frame_Frame_idl__ +#define __com_sun_star_frame_Frame_idl__ + +#ifndef __com_sun_star_frame_XFrameLoader_idl__ +#include +#endif + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from xml: service com::sun::star::frame::FrameLoader +/** Derivations of this abstract service are used to load components + into Frames of the environment. + + + +

Concrete implementations of this service register for example + for file name extensions or MIME types to load appropriate + components. The components loaded are at least Controller.

+ */ +service FrameLoader +{ + // DocMerge: empty anyway + interface com::sun::star::frame::XFrameLoader; +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:20 hjs + initial import + + Revision 1.5 2000/09/11 11:52:28 mi + documentation merged from XML + + Revision 1.1 2000/05/25 10:26:18 mi + Doku + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/FrameSearchFlag.idl b/offapi/com/sun/star/frame/FrameSearchFlag.idl new file mode 100644 index 000000000000..162706b9ab24 --- /dev/null +++ b/offapi/com/sun/star/frame/FrameSearchFlag.idl @@ -0,0 +1,165 @@ +/************************************************************************* + * + * $RCSfile: FrameSearchFlag.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:43 $ + * + * 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_frame_FrameSearchFlag_idl__ +#define __com_sun_star_frame_FrameSearchFlag_idl__ + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from idl: constants com::sun::star::frame::FrameSearchFlag +/** These types describe the algorithm to be used to search a frame. + */ +constants FrameSearchFlag +{ + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::frame::FrameSearchFlag::AUTO + /** SELF+CHILDREN + */ + const long AUTO = 0; + + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::frame::FrameSearchFlag::PARENT + /** includes the parent frame + */ + const long PARENT = 1; + + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::frame::FrameSearchFlag::SELF + /** includes the start frame + */ + const long SELF = 2; + + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::frame::FrameSearchFlag::CHILDREN + /** includes the child frames of the start frame + */ + const long CHILDREN = 4; + + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::frame::FrameSearchFlag::CREATE + /** frame will be created if not found + */ + const long CREATE = 8; + + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::frame::FrameSearchFlag::SIBLINGS + /** includes the other child frames of the parent of the start frame + */ + const long SIBLINGS = 16; + + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::frame::FrameSearchFlag::TASKS + /** includes all frames in all tasks in the current frames hierarchy + */ + const long TASKS = 32; + + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::frame::FrameSearchFlag::ALL + /** includes all frames except frames in other tasks + */ + const long ALL = 23; + + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::frame::FrameSearchFlag::GLOBAL + /** searches in the whole hierarchy of frames. + */ + const long GLOBAL = 55; + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:20 hjs + initial import + + Revision 1.7 2000/09/11 11:52:28 mi + documentation merged from XML + + Revision 1.3 2000/02/23 14:49:55 mi + missing documentations + + Revision 1.2 2000/01/31 09:44:58 mi + XML syntax for documentation + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/FramesContainer.idl b/offapi/com/sun/star/frame/FramesContainer.idl new file mode 100644 index 000000000000..5eaf3b6fd1e2 --- /dev/null +++ b/offapi/com/sun/star/frame/FramesContainer.idl @@ -0,0 +1,116 @@ +/************************************************************************* + * + * $RCSfile: FramesContainer.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:43 $ + * + * 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_frame_FramesContainer_idl__ +#define __com_sun_star_frame_FramesContainer_idl__ + +#ifndef __com_sun_star_frame_XFrames_idl__ +#include +#endif + +#ifndef __com_sun_star_container_XNameAccess_idl__ +#include +#endif + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from xml: service com::sun::star::frame::FramesContainer +/** This is a special container which can contain frames. + + + +

All elements in this container support the service frame. + +

@see service Frame + */ +service FramesContainer +{ + // DocMerge: empty anyway + interface com::sun::star::frame::XFrames; + + // DocMerge: empty anyway + interface com::sun::star::container::XNameAccess; + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:20 hjs + initial import + + Revision 1.5 2000/09/11 11:52:28 mi + documentation merged from XML + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/MediaTypeDetectionHelper.idl b/offapi/com/sun/star/frame/MediaTypeDetectionHelper.idl new file mode 100644 index 000000000000..6033f142f6d3 --- /dev/null +++ b/offapi/com/sun/star/frame/MediaTypeDetectionHelper.idl @@ -0,0 +1,110 @@ +/************************************************************************* + * + * $RCSfile: MediaTypeDetectionHelper.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:43 $ + * + * 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_frame_MediaTypeDetectionHelper_idl__ +#define __com_sun_star_frame_MediaTypeDetectionHelper_idl__ + +#ifndef __com_sun_star_util_XStringMapping_idl__ +#include +#endif + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + + +// DocMerge from xml: service com::sun::star::frame::MediaTypeDetectionHelper +/** provides a mapping for a given sequence of ContentIdentifierStrings to + a sequence of belonging MediaType's + */ +service MediaTypeDetectionHelper +{ + + // DocMerge from xml: service com::sun::star::frame::MediaTypeDetectionHelper: interface com::sun::star::util::XStringMapping + /** provides a mapping from string to string. + + This interface is required. + */ + interface com::sun::star::util::XStringMapping; +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:20 hjs + initial import + + Revision 1.5 2000/09/11 11:52:28 mi + documentation merged from XML + + Revision 1.1 2000/07/28 19:21:41 iha + new + + +=============================================================================*/ + +#endif + diff --git a/offapi/com/sun/star/frame/Settings.idl b/offapi/com/sun/star/frame/Settings.idl new file mode 100644 index 000000000000..8db91fbaa1d9 --- /dev/null +++ b/offapi/com/sun/star/frame/Settings.idl @@ -0,0 +1,103 @@ +/************************************************************************* + * + * $RCSfile: Settings.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:43 $ + * + * 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_frame_Settings_idl__ +#define __com_sun_star_frame_Settings_idl__ + +#ifndef __com_sun_star_container_XNameAccess_idl__ +#include +#endif + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from xml: service com::sun::star::frame::Settings +/** @deprecated + */ +service Settings +{ + // DocMerge: empty anyway + interface com::sun::star::container::XNameAccess; + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:20 hjs + initial import + + Revision 1.5 2000/09/11 11:52:28 mi + documentation merged from XML + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/TerminationVetoException.idl b/offapi/com/sun/star/frame/TerminationVetoException.idl new file mode 100644 index 000000000000..8b1ba8ede130 --- /dev/null +++ b/offapi/com/sun/star/frame/TerminationVetoException.idl @@ -0,0 +1,101 @@ +/************************************************************************* + * + * $RCSfile: TerminationVetoException.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:43 $ + * + * 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_frame_TerminationVetoException_idl__ +#define __com_sun_star_frame_TerminationVetoException_idl__ + +#ifndef __com_sun_star_uno_Exception_idl__ +#include +#endif + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from xml: exception com::sun::star::frame::TerminationVetoException +/** This exception can be thrown to prevent the environment (e.g. desktop) + from terminating. + */ +exception TerminationVetoException: com::sun::star::uno::Exception +{ +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:21 hjs + initial import + + Revision 1.5 2000/09/11 11:52:28 mi + documentation merged from XML + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/WindowArrange.idl b/offapi/com/sun/star/frame/WindowArrange.idl new file mode 100644 index 000000000000..34565351d4ae --- /dev/null +++ b/offapi/com/sun/star/frame/WindowArrange.idl @@ -0,0 +1,144 @@ +/************************************************************************* + * + * $RCSfile: WindowArrange.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:43 $ + * + * 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_frame_WindowArrange_idl__ +#define __com_sun_star_frame_WindowArrange_idl__ + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from idl: constants com::sun::star::frame::WindowArrange +/** These constants are used to specify a style of window arrangement. + */ +constants WindowArrange +{ + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::frame::WindowArrange::TILE + /** arranges the windows in tiles. + */ + const short TILE = 1; + + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::frame::WindowArrange::VERTICAL + /** arranges the windows vertically. + */ + const short VERTICAL = 2; + + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::frame::WindowArrange::HORIZONTAL + /** arranges the windows horizontally. + */ + const short HORIZONTAL = 3; + + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::frame::WindowArrange::CASCADE + /** cascades the windows. + */ + const short CASCADE = 4; + + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::frame::WindowArrange::MAXIMIZE + /** maximizes all windows. + */ + const short MAXIMIZE = 5; + + //------------------------------------------------------------------------- + + // DocMerge from idl: value com::sun::star::frame::WindowArrange::MINIMIZE + /** minimizes all windows. + */ + const short MINIMIZE = 6; + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:21 hjs + initial import + + Revision 1.7 2000/09/11 11:52:28 mi + documentation merged from XML + + Revision 1.3 2000/02/23 14:49:55 mi + missing documentations + + Revision 1.2 2000/01/31 09:44:58 mi + XML syntax for documentation + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/XBrowseHistoryRegistry.idl b/offapi/com/sun/star/frame/XBrowseHistoryRegistry.idl new file mode 100644 index 000000000000..6e5908531acd --- /dev/null +++ b/offapi/com/sun/star/frame/XBrowseHistoryRegistry.idl @@ -0,0 +1,123 @@ +/************************************************************************* + * + * $RCSfile: XBrowseHistoryRegistry.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:43 $ + * + * 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_frame_XBrowseHistoryRegistry_idl__ +#define __com_sun_star_frame_XBrowseHistoryRegistry_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include +#endif + +#ifndef __com_sun_star_beans_PropertyValue_idl__ +#include +#endif + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from xml: interface com::sun::star::frame::XBrowseHistoryRegistry +/** @deprecated + */ +[ uik(E2280120-33D6-11D1-AABE00A0-249D5590), ident( "XBrowseHistoryRegistry", 1.0 ) ] +interface XBrowseHistoryRegistry: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + + // DocMerge: empty anyway + [oneway] void updateViewData( [in] any Value ); + + //------------------------------------------------------------------------- + + // DocMerge: empty anyway + [oneway] void createNewEntry( [in] string aURL, + [in] sequence aArgs, + [in] string aTitle ); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:21 hjs + initial import + + Revision 1.7 2000/09/11 11:52:28 mi + documentation merged from XML + + Revision 1.3 2000/02/23 14:49:56 mi + missing documentations + + Revision 1.2 2000/01/31 09:44:58 mi + XML syntax for documentation + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/XComponentLoader.idl b/offapi/com/sun/star/frame/XComponentLoader.idl new file mode 100644 index 000000000000..e3f3a190df22 --- /dev/null +++ b/offapi/com/sun/star/frame/XComponentLoader.idl @@ -0,0 +1,136 @@ +/************************************************************************* + * + * $RCSfile: XComponentLoader.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:43 $ + * + * 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_frame_XComponentLoader_idl__ +#define __com_sun_star_frame_XComponentLoader_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include +#endif + +#ifndef __com_sun_star_lang_XComponent_idl__ +#include +#endif + +#ifndef __com_sun_star_beans_PropertyValue_idl__ +#include +#endif + +#ifndef __com_sun_star_io_IOException_idl__ +#include +#endif + +#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ +#include +#endif + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from xml: interface com::sun::star::frame::XComponentLoader +/** This is a simple interface to load components by an URL into a + frame environment.@see service Desktop + @see service Frame + @see interface XFrame + */ +[ uik(E2280106-33D6-11D1-AABE00A0-249D5590), ident( "XComponentLoader", 1.0 ) ] +interface XComponentLoader: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XComponentLoader::loadComponentFromURL + /** loads a component specified by an URL into the specified + new or existing frame. + */ + com::sun::star::lang::XComponent loadComponentFromURL( [in] string aURL, + [in] string aTargetFrameName, + [in] long nSearchFlags, + [in] sequence aArgs ) + raises( com::sun::star::io::IOException, + com::sun::star::lang::IllegalArgumentException ); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:21 hjs + initial import + + Revision 1.6 2000/09/11 11:52:28 mi + documentation merged from XML + + Revision 1.2 1999/11/18 11:49:56 mi + XComponent now in module lang + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/XComponentRegistry.idl b/offapi/com/sun/star/frame/XComponentRegistry.idl new file mode 100644 index 000000000000..af8139a9bc21 --- /dev/null +++ b/offapi/com/sun/star/frame/XComponentRegistry.idl @@ -0,0 +1,125 @@ +/************************************************************************* + * + * $RCSfile: XComponentRegistry.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:43 $ + * + * 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_frame_XComponentRegistry_idl__ +#define __com_sun_star_frame_XComponentRegistry_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include +#endif + +#ifndef __com_sun_star_uno_Uik_idl__ +#include +#endif + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from xml: interface com::sun::star::frame::XComponentRegistry +/** makes it possible to instanciate desktop components. + + + + + + + + @deprecated@see XFrame + */ +[ uik(E2280101-33D6-11D1-AABE00A0-249D5590), ident( "XComponentRegistry", 1.0 ) ] +interface XComponentRegistry: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + + // DocMerge: empty anyway + com::sun::star::uno::XInterface createObject( [in] string aURL, + [in] com::sun::star::uno::Uik ik ); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:21 hjs + initial import + + Revision 1.7 2000/09/11 11:52:28 mi + documentation merged from XML + + Revision 1.3 2000/02/23 14:49:56 mi + missing documentations + + Revision 1.2 2000/01/31 09:44:58 mi + XML syntax for documentation + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/XConfigManager.idl b/offapi/com/sun/star/frame/XConfigManager.idl new file mode 100644 index 000000000000..1043a12470f4 --- /dev/null +++ b/offapi/com/sun/star/frame/XConfigManager.idl @@ -0,0 +1,133 @@ +/************************************************************************* + * + * $RCSfile: XConfigManager.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:43 $ + * + * 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_frame_XConfigManager_idl__ +#define __com_sun_star_frame_XConfigManager_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include +#endif + +#ifndef __com_sun_star_beans_XPropertyChangeListener_idl__ +#include +#endif + +//============================================================================ + + module com { + module sun { + module star { + module frame { + +//============================================================================ + +// DocMerge from xml: interface com::sun::star::frame::XConfigManager +/** @deprecated + */ +[ uik(D71AE998-9378-11D3-9ECA0050-04526B21), ident("XConfigManager", 1.0) ] +interface XConfigManager: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + + + // DocMerge from xml: method com::sun::star::frame::XConfigManager::addPropertyChangeListener + /** add a listener to notify changes on "sKeyName" + + +

+ If "sKeyName" a group of keys, the listener become one notify for every subkey!

+ */ + [oneway] void addPropertyChangeListener( [in] string sKeyName, [in] com::sun::star::beans::XPropertyChangeListener xListener ) ; + + //------------------------------------------------------------------------- + + + // DocMerge from xml: method com::sun::star::frame::XConfigManager::removePropertyChangeListener + /** remove a listener + */ + [oneway] void removePropertyChangeListener( [in] string sKeyName, [in] com::sun::star::beans::XPropertyChangeListener xListener ) ; + + //------------------------------------------------------------------------- + + + // DocMerge from xml: method com::sun::star::frame::XConfigManager::substituteVariables + /** substitute variables in "sText" + + +

+ The value of "sText" is NOT changed.

+ */ + string substituteVariables( [in] string sText ) ; + + //------------------------------------------------------------------------- + + + // DocMerge from xml: method com::sun::star::frame::XConfigManager::flush + /** write data of INI-file to disk + */ + [oneway] void flush() ; + +}; //XConfigManager +}; //frame +}; //star +}; //sun +}; //com + +#endif diff --git a/offapi/com/sun/star/frame/XController.idl b/offapi/com/sun/star/frame/XController.idl new file mode 100644 index 000000000000..bffd4dd485e5 --- /dev/null +++ b/offapi/com/sun/star/frame/XController.idl @@ -0,0 +1,170 @@ +/************************************************************************* + * + * $RCSfile: XController.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:43 $ + * + * 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_frame_XController_idl__ +#define __com_sun_star_frame_XController_idl__ + +#ifndef __com_sun_star_lang_XComponent_idl__ +#include +#endif + +//============================================================================= + + module com { module sun { module star { module frame { + +interface XFrame; +interface XModel; + +//============================================================================= + +// DocMerge from xml: interface com::sun::star::frame::XController +/** With this interface, components viewed in a Frame can serve + events (by supplying dispatches).@see interface XModel + @see interface XFrame + @see interface com::sun::star::awt::XWindow + */ +[ uik(E2280115-33D6-11D1-AABE00A0-249D5590), ident( "XController", 1.0 ) ] +interface XController: com::sun::star::lang::XComponent +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XController::attachFrame + /** is called to attach the controller with its managing frame. + */ + void attachFrame( [in] XFrame xFrame ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XController::attachModel + /** is called to attach the controller to a new model. + */ + boolean attachModel( [in] XModel xModel ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XController::suspend + /** is called to prepare the controller for closing the view + */ + boolean suspend( [in] boolean bSuspend ); + + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::frame::XController::getViewData + /** @returns + data that can be used to restore the current view status. + */ + any getViewData(); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XController::restoreViewData + /** restores the view status using the data gotten from a previous call to + + + + + + . + */ + void restoreViewData( [in] any Data ); + + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::frame::XController::getModel + /** @returns + the currently attached model. + */ + XModel getModel(); + + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::frame::XController::getFrame + /** @returns + the frame containing this controller. + */ + XFrame getFrame(); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.2 2000/10/09 14:24:56 mi + #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) + + Revision 1.1.1.1 2000/09/18 23:35:21 hjs + initial import + + Revision 1.6 2000/09/11 11:52:28 mi + documentation merged from XML + + Revision 1.2 1999/11/18 11:49:56 mi + XComponent now in module lang + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/XDesktop.idl b/offapi/com/sun/star/frame/XDesktop.idl new file mode 100644 index 000000000000..ec6d266520bd --- /dev/null +++ b/offapi/com/sun/star/frame/XDesktop.idl @@ -0,0 +1,209 @@ +/************************************************************************* + * + * $RCSfile: XDesktop.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:43 $ + * + * 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_frame_XDesktop_idl__ +#define __com_sun_star_frame_XDesktop_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include +#endif + +#ifndef __com_sun_star_frame_XTerminateListener_idl__ +#include +#endif + +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include +#endif + +#ifndef __com_sun_star_lang_XComponent_idl__ +#include +#endif + +#ifndef __com_sun_star_frame_XFrame_idl__ +#include +#endif + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from xml: interface com::sun::star::frame::XDesktop +/** This is the main interface of a desktop service. + + + +

A desktop is an environment for components which can be viewed in + frames. Frames are like frames in HTML framesets. This does not imply + that a desktop can handle framesets; the frames may be top frames + only. + +

@see service Desktop + */ +[ uik(E2280119-33D6-11D1-AABE00A0-249D5590), ident( "XDesktop", 1.0 ) ] +interface XDesktop: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XDesktop::terminate + /** tries to terminate the desktop. + + + +

First a vetoable queryTermination-event is broadcast. If no + TerminationVetoException was thrown, a notifyTermination-event is + broadcast and will be returned; otherwise an + abortTermination-event is broadcast and will be returned. +

@see exception com::sun::star::frame::TerminationVetoException + @see interface XTerminateListener + */ + boolean terminate(); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XDesktop::addTerminateListener + /** registers an event listener to the desktop, which is called + when the desktop is queried to terminate and when it really + terminates. + */ + [oneway] void addTerminateListener( [in] com::sun::star::frame::XTerminateListener xListener ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XDesktop::removeTerminateListener + /** unregisters an event listener which was registered with + + + + + + . + */ + [oneway] void removeTerminateListener( [in] com::sun::star::frame::XTerminateListener xListener ); + + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::frame::XDesktop::getComponents + /** @returns + a collection of all components which are loaded into a frame. + +

The component is by definition the model of the control which + is loaded into a frame or, if no model exists, into the control + itself. + +

The service, Components, which is available from this + method is a collection of all components of the desktop which are open + within a frame of the desktop. + + @see service Components + */ + [const] com::sun::star::container::XEnumerationAccess getComponents(); + + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::frame::XDesktop::getCurrentComponent + /** @returns + the component within the desktop environment which has the UI focus. + +

Normally, the component is the model part of the + active component. If no model existsm it is the active controller + (view) itself. + */ + [const] com::sun::star::lang::XComponent getCurrentComponent(); + + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::frame::XDesktop::getCurrentFrame + /** @returns + the frame of the component which has the + UI focus within this desktop enviroment. + */ + [const] com::sun::star::frame::XFrame getCurrentFrame(); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.2 2000/10/09 14:24:56 mi + #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) + + Revision 1.1.1.1 2000/09/18 23:35:21 hjs + initial import + + Revision 1.6 2000/09/11 11:52:28 mi + documentation merged from XML + + Revision 1.2 1999/11/18 11:49:56 mi + XComponent now in module lang + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/XDesktopTask.idl b/offapi/com/sun/star/frame/XDesktopTask.idl new file mode 100644 index 000000000000..0f29a36b7e76 --- /dev/null +++ b/offapi/com/sun/star/frame/XDesktopTask.idl @@ -0,0 +1,125 @@ +/************************************************************************* + * + * $RCSfile: XDesktopTask.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:43 $ + * + * 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_frame_XDesktopTask_idl__ +#define __com_sun_star_frame_XDesktopTask_idl__ + +#ifndef __com_sun_star_lang_XComponent_idl__ +#include +#endif + +#ifndef __com_sun_star_awt_XWindow_idl__ +#include +#endif + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from xml: interface com::sun::star::frame::XDesktopTask +/** is used to initialize and close a desktop task. + */ +[ uik(E2280131-33D6-11D1-AABE00A0-249D5590), ident( "XDesktopTask", 1.0 ) ] +interface XDesktopTask: com::sun::star::lang::XComponent +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XDesktopTask::initialize + /** attaches a window to the task. + */ + void initialize( [in] com::sun::star::awt::XWindow xTaskWindow ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XDesktopTask::close + /** tries to close all windows within the task and the task by itself. + */ + boolean close(); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:21 hjs + initial import + + Revision 1.7 2000/09/11 11:52:28 mi + documentation merged from XML + + Revision 1.3 1999/11/25 16:03:32 mi + welforming HTML for XML + + Revision 1.2 1999/11/18 11:49:57 mi + XComponent now in module lang + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/XDispatch.idl b/offapi/com/sun/star/frame/XDispatch.idl new file mode 100644 index 000000000000..aca428bd76ed --- /dev/null +++ b/offapi/com/sun/star/frame/XDispatch.idl @@ -0,0 +1,191 @@ +/************************************************************************* + * + * $RCSfile: XDispatch.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:43 $ + * + * 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_frame_XDispatch_idl__ +#define __com_sun_star_frame_XDispatch_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include +#endif + +#ifndef __com_sun_star_util_URL_idl__ +#include +#endif + +#ifndef __com_sun_star_beans_PropertyValue_idl__ +#include +#endif + +#ifndef __com_sun_star_frame_XStatusListener_idl__ +#include +#endif + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from xml: interface com::sun::star::frame::XDispatch +/** serves state information of objects which can be connected to + controllers (e.g. toolbox controllers). + + + +

Each state change is to be broadcast to all registered + status listeners. The first notification should be performed + synchronously from + + + + + ; + if not, controllers may flicker. State listener must be aware of this + synchronous notification.

+ +

The state consists of enabled/disabled and a short descriptive text + of the function (e.g. "undo insert character"). It is to be broadcast + whenever this state changes or the controller should reget the value + for the URL to which it is connected. Additionally a context-switch-event + is to be broadcast whenever the object may be out of scope + to force the state listener to requery the XDispatch.

@see StatusEvent + @see Frame + @see View + */ +[ uik(E2280122-33D6-11D1-AABE00A0-249D5590), ident( "XDispatch", 1.0 ) ] +interface XDispatch: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XDispatch::dispatch + /** dispatches (executes) an URL asynchronously. + + + +

It is only allowed to dispatch URLs for which you get this + XDispatch. Additional arguments "'#..." or "?...") are + allowed.

+ + + + + + + + @example + // some code for a click-handler of a hyperlink in a view + XFrame xTargetFrame = m_xFrame->findFrame( + m_aHyperlink->getTargetFrameName(), FRAME_SEARCH_STANDARD ); + URL aURL; + aURL.Original = m_aHyperlink->getURL(); + XDispatch m_xFrame->queryDispatch( aURL, sequence<PropertyValue>() ); + xDispatch->dispatch( aURL ); + + */ + [oneway] void dispatch( [in] com::sun::star::util::URL aURL, + [in] sequence aArgs ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XDispatch::addStatusListener + /** registers a listener of a controller for a specific URL + to this object to receive status events. + + + +

It is only allowed to register for URLs for which you got this + XDispatch. Additional arguments ("#..." or "?...") will be ignored.

@see Dispatch#removeStatusListener(XListener, URL) + */ + [oneway] void addStatusListener( [in] com::sun::star::frame::XStatusListener xControl, + [in] com::sun::star::util::URL aURL ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XDispatch::removeStatusListener + /** unregisters a listener of a controller.@see Dispatch#addStatusListener(XListener, URL) + */ + [oneway] void removeStatusListener( [in] com::sun::star::frame::XStatusListener xControl, + [in] com::sun::star::util::URL aURL ); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:21 hjs + initial import + + Revision 1.6 2000/09/11 11:52:28 mi + documentation merged from XML + + Revision 1.2 1999/11/25 16:03:32 mi + welforming HTML for XML + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/XDispatchProvider.idl b/offapi/com/sun/star/frame/XDispatchProvider.idl new file mode 100644 index 000000000000..c9ba54d6d05f --- /dev/null +++ b/offapi/com/sun/star/frame/XDispatchProvider.idl @@ -0,0 +1,144 @@ +/************************************************************************* + * + * $RCSfile: XDispatchProvider.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:43 $ + * + * 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_frame_XDispatchProvider_idl__ +#define __com_sun_star_frame_XDispatchProvider_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include +#endif + +#ifndef __com_sun_star_frame_XDispatch_idl__ +#include +#endif + +#ifndef __com_sun_star_util_URL_idl__ +#include +#endif + +#ifndef __com_sun_star_frame_DispatchDescriptor_idl__ +#include +#endif + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from xml: interface com::sun::star::frame::XDispatchProvider +/** provides XDispatch interfaces for certain functions which + are useful at the UI. + */ +[ uik(E2280133-33D6-11D1-AABE00A0-249D5590), ident( "XDispatchProvider", 1.0 ) ] +interface XDispatchProvider: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XDispatchProvider::queryDispatch + /** searches for an XDispatch for the specified URL within + the specified target frame.@see XFrame::findFrame + @see queryDispatches + */ + com::sun::star::frame::XDispatch queryDispatch( [in] com::sun::star::util::URL aURL, + [in] string aTargetFrameName, + [in] long nSearchFlags ); + + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::frame::XDispatchProvider::queryDispatches + /** @returns + multiple dispatch interfaces for the specified descriptors at once. + +

Actually this method is redundant to + XDispatchProvider::queryDispatch to avoid multiple + remote calls. + */ + sequence queryDispatches( + [in] sequence aDescripts ); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:21 hjs + initial import + + Revision 1.7 2000/09/11 11:52:28 mi + documentation merged from XML + + Revision 1.3 2000/02/23 14:49:56 mi + missing documentations + + Revision 1.2 2000/01/31 09:44:58 mi + XML syntax for documentation + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/XDispatchProviderInterception.idl b/offapi/com/sun/star/frame/XDispatchProviderInterception.idl new file mode 100644 index 000000000000..d399ea59692d --- /dev/null +++ b/offapi/com/sun/star/frame/XDispatchProviderInterception.idl @@ -0,0 +1,132 @@ +/************************************************************************* + * + * $RCSfile: XDispatchProviderInterception.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:43 $ + * + * 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_frame_XDispatchProviderInterception_idl__ +#define __com_sun_star_frame_XDispatchProviderInterception_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include +#endif + +#ifndef __com_sun_star_frame_XDispatchProviderInterceptor_idl__ +#include +#endif + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from xml: interface com::sun::star::frame::XDispatchProviderInterception +/** makes it possible to register an XDispatchProvider which + intercepts all requests of XDispatch to this instance. + */ +[ uik(CB9642C0-5C62-11D3-9F5B0010-5AEF84A7), ident( "XDispatchProviderInterception", 1.0 ) ] +interface XDispatchProviderInterception: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XDispatchProviderInterception::registerDispatchProviderInterceptor + /** registers an XDispatchProviderInterceptor, which will become + the first interceptor in the chain of registered interceptors. + */ + void registerDispatchProviderInterceptor( [in] com::sun::star::frame::XDispatchProviderInterceptor xInterceptor ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XDispatchProviderInterception::releaseDispatchProviderInterceptor + /** removes an XDispatchProviderInterceptor which was previously registered + using + + + + + . + + + +

The order of removals is arbitrary. It is not necessary to remove the last + registered interceptor first.

+ */ + void releaseDispatchProviderInterceptor( [in] com::sun::star::frame::XDispatchProviderInterceptor xInterceptor ); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:21 hjs + initial import + + Revision 1.5 2000/09/11 11:52:28 mi + documentation merged from XML + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/XDispatchProviderInterceptor.idl b/offapi/com/sun/star/frame/XDispatchProviderInterceptor.idl new file mode 100644 index 000000000000..761a24601672 --- /dev/null +++ b/offapi/com/sun/star/frame/XDispatchProviderInterceptor.idl @@ -0,0 +1,149 @@ +/************************************************************************* + * + * $RCSfile: XDispatchProviderInterceptor.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:43 $ + * + * 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_frame_XDispatchProviderInterceptor_idl__ +#define __com_sun_star_frame_XDispatchProviderInterceptor_idl__ + +#ifndef __com_sun_star_frame_XDispatchProvider_idl__ +#include +#endif + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from xml: interface com::sun::star::frame::XDispatchProviderInterceptor +/** makes it possible to intercept request of XDispatch. + */ +[ uik(E2280135-33D6-11D1-AABE00A0-249D5590), ident( "XDispatchProviderInterceptor", 1.0 ) ] +interface XDispatchProviderInterceptor: com::sun::star::frame::XDispatchProvider +{ + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::frame::XDispatchProviderInterceptor::getSlaveDispatchProvider + /** @returns + the slave XDispatchProvider to which calls to + XDispatchProvider::queryDispatch can be forwarded + under control of this dispatch provider. + */ + com::sun::star::frame::XDispatchProvider getSlaveDispatchProvider(); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XDispatchProviderInterceptor::setSlaveDispatchProvider + /** sets the slave XDispatchProvider to which calls to + + + + + + can be forwarded + under control of this dispatch provider. + */ + void setSlaveDispatchProvider( [in] com::sun::star::frame::XDispatchProvider xNewDispatchProvider ); + + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::frame::XDispatchProviderInterceptor::getMasterDispatchProvider + /** @returns + the master XDispatchProvider, which may forward + calls to its XDispatchProvider::queryDispatch + to this dispatch provider. + */ + com::sun::star::frame::XDispatchProvider getMasterDispatchProvider(); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XDispatchProviderInterceptor::setMasterDispatchProvider + /** sets the master XDispatchProvider, which may forward + calls to its + + + + + + to this dispatch provider. + */ + void setMasterDispatchProvider( [in] com::sun::star::frame::XDispatchProvider xNewSupplier ); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:21 hjs + initial import + + Revision 1.5 2000/09/11 11:52:28 mi + documentation merged from XML + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/XExtendedFilterDetection.idl b/offapi/com/sun/star/frame/XExtendedFilterDetection.idl new file mode 100644 index 000000000000..fe7ce2f4428e --- /dev/null +++ b/offapi/com/sun/star/frame/XExtendedFilterDetection.idl @@ -0,0 +1,112 @@ +/************************************************************************* + * + * $RCSfile: XExtendedFilterDetection.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:44 $ + * + * 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_frame_XExtendedFilterDetection_idl__ +#define __com_sun_star_frame_XExtendedFilterDetection_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include +#endif + +#ifndef __com_sun_star_beans_PropertyValue_idl__ +#include +#endif + +//============================================================================ + + module com { + module sun { + module star { + module frame { + +//============================================================================ + +// DocMerge from xml: interface com::sun::star::frame::XExtendedFilterDetection +/** extended filter detection for frame loader factories. + + + + + + @deprecated + */ +[ uik(56EA6A4A-90FA-476d-870218F8-25066010), ident("XExtendedFilterDetection", 1.0) ] +interface XExtendedFilterDetection: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + + + // DocMerge from xml: method com::sun::star::frame::XExtendedFilterDetection::detect + /** control agreement of a frameloader with given URL or arguments + +

+ Implement it as an extra service for your frameloader to give information about + your responsibility for given URL. If you can handle these document return + a valid name for a filter or an empty string otherwise.

+ */ + string detect( [in] string sURL, [in] sequence< com::sun::star::beans::PropertyValue > aArgumentlist ); + + }; // XExtendedFilterDetection + }; // frame + }; // star + }; // sun +}; // com + +#endif diff --git a/offapi/com/sun/star/frame/XFilterDetect.idl b/offapi/com/sun/star/frame/XFilterDetect.idl new file mode 100644 index 000000000000..f71d490f5655 --- /dev/null +++ b/offapi/com/sun/star/frame/XFilterDetect.idl @@ -0,0 +1,129 @@ +/************************************************************************* + * + * $RCSfile: XFilterDetect.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:44 $ + * + * 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_frame_XFilterDetect_idl__ +#define __com_sun_star_frame_XFilterDetect_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include +#endif + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from xml: interface com::sun::star::frame::XFilterDetect +/** makes it possible to determine the content type. + + + + + + + + + + + + @deprecated + */ +[ uik(E2280128-33D6-11D1-AABE00A0-249D5590), ident( "XFilterDetect", 1.0 ) ] +interface XFilterDetect: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + + // DocMerge: empty anyway + string getContentType( [in] string URL ); + + //------------------------------------------------------------------------- + + // DocMerge: empty anyway + boolean useExternBrowser( [in] string URL ); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:21 hjs + initial import + + Revision 1.7 2000/09/11 11:52:28 mi + documentation merged from XML + + Revision 1.3 2000/02/23 14:49:56 mi + missing documentations + + Revision 1.2 2000/01/31 09:44:58 mi + XML syntax for documentation + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/XFrame.idl b/offapi/com/sun/star/frame/XFrame.idl new file mode 100644 index 000000000000..c8aa9d4869d5 --- /dev/null +++ b/offapi/com/sun/star/frame/XFrame.idl @@ -0,0 +1,358 @@ +/************************************************************************* + * + * $RCSfile: XFrame.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:44 $ + * + * 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_frame_XFrame_idl__ +#define __com_sun_star_frame_XFrame_idl__ + +#ifndef __com_sun_star_lang_XComponent_idl__ +#include +#endif + +#ifndef __com_sun_star_awt_XWindow_idl__ +#include +#endif + +//============================================================================= + + module com { module sun { module star { module frame { + +interface XFrameActionListener; +interface XController; +interface XFramesSupplier; + +//============================================================================= + +// DocMerge from xml: interface com::sun::star::frame::XFrame +/** makes it possible to control a Frame + */ +[ uik(E2280107-33D6-11D1-AABE00A0-249D5590), ident( "XFrame", 1.0 ) ] +interface XFrame: com::sun::star::lang::XComponent +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XFrame::initialize + /** is called to initialize the frame within a window.@see getContainerWindow() + */ + void initialize( [in] com::sun::star::awt::XWindow xWindow ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XFrame::getContainerWindow + /** provides access to the window of the frame. + + + +

Normally this is used as the parent window of the + controller window. + +

@see initialize() + */ + com::sun::star::awt::XWindow getContainerWindow(); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XFrame::setCreator + /** sets the frame container that created this frame. + + + +

Only the creator is allowed to call this method.

+ */ + [oneway] void setCreator( [in] XFramesSupplier xCreator ); + + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::frame::XFrame::getCreator + /** @returns + the frame container that created this frame. + */ + [const] XFramesSupplier getCreator(); + + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::frame::XFrame::getName + /** @returns + the programmatic name of this frame. + +

See specification of HTML framesets for reference. + */ + [const] string getName(); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XFrame::setName + /** sets the name of the frame. + + + +

Normally the name of the frame is set initially.

+ */ + [oneway] void setName( [in] string aName ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XFrame::findFrame + /** searches for a frame with the specified name. + + + +

Frames may contain other frames (e.g. a frameset) and may + be contained in other frames. This hierarchy is searched with + this method.

+ +

First some special names are taken into account, i.e. "", + "_self", "_top", "_active" etc. nSearchFlags is ignored when + comparing these names with aTargetFrameName; further steps are + controlled by nSearchFlags. If allowed, the name of the frame + itself is compared with the desired one, then ( again if allowed ) + the method + + + + + is called for all children + of the frame. Finally + + + + + may be called + for the parent frame (if allowed).

+ +

If no frame with the given name is found, a new top frame is + created if this is not suppressed by a special FrameSearchFlag. + The new frame also gets the desired name.

+ */ + com::sun::star::frame::XFrame findFrame( [in] string aTargetFrameName, + [in] long nSearchFlags ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XFrame::isTop + /** determines if the frame is a top frame. + + + +

In general a top frame is the frame which is a direct child of + a task frame or which does not have a parent. If a frame returns + for this method, all calls to + + + + + + have to stop the search at such a frame unless the flag + FrameSearchFlag::TASKS is set.

+ */ + boolean isTop(); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XFrame::activate + /** activates this frame and thus the component within. + + + +

At first the frame sets itself as the active frame of its + creator by calling + + + + + , + then it broadcasts a FrameActionEvent with + FrameAction::FRAME_ACTIVATED. The component within + this frame may listen to this event to grab the focus on activation. + For simple components this can be done by the FrameLoader. + +

+

Finally, most frames may grab the focus to one of its windows + or forward the activation to a sub-frame.

+ */ + [oneway] void activate(); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XFrame::deactivate + /** is called by the creator frame when another sub-frame gets activated. + + + +

At first the frame deactivates its active sub-frame, if any. + Then broadcasts a FrameActionEvent with + FrameAction::FRAME_DEACTIVATING.

+ */ + [oneway] void deactivate(); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XFrame::isActive + /** determines if the frame is active. + */ + boolean isActive(); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XFrame::setComponent + /** sets a new component into the frame. + */ + boolean setComponent( [in] com::sun::star::awt::XWindow xComponentWindow, + [in] com::sun::star::frame::XController xController ); + + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::frame::XFrame::getComponentWindow + /** @returns + the current visible component in this frame. + +

The frame is the owner of the window. + */ + [const] com::sun::star::awt::XWindow getComponentWindow(); + + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::frame::XFrame::getController + /** @returns + the current controller within this frame. + +

Normally it is set by a frame loader. + */ + [const] XController getController(); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XFrame::contextChanged + /** notifies the frame that the context of the controller within this + frame changed (i.e. the selection). + + + +

According to a call to this interface, the frame calls + + + + + + with + FrameAction::CONTEXT_CHANGED to all listeners which + are registered using + + + + + . + For external controllers this event can be used to requery dispatches.

+ */ + void contextChanged(); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XFrame::addFrameActionListener + /** registers an event listener, which will be called when certain things + happen to the components within this frame or within sub-frames of this frame. + + + +

E.g. it is possible to determine instantiation/destruction and + activation/deactivation of components.

+ */ + [oneway] void addFrameActionListener( [in]XFrameActionListener xListener ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XFrame::removeFrameActionListener + /** unregisters an event listener which was registered with + XFrame::addFrameActionListener(). + */ + [oneway] void removeFrameActionListener( [in] XFrameActionListener xListener ); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:21 hjs + initial import + + Revision 1.9 2000/09/11 11:52:29 mi + documentation merged from XML + + Revision 1.5 2000/02/23 14:49:56 mi + missing documentations + + Revision 1.4 2000/01/31 09:44:59 mi + XML syntax for documentation + + Revision 1.3 1999/12/06 13:21:14 mba + #67620#: isActive + + Revision 1.2 1999/11/18 11:49:57 mi + XComponent now in module lang + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/XFrameActionListener.idl b/offapi/com/sun/star/frame/XFrameActionListener.idl new file mode 100644 index 000000000000..c50a094b77bc --- /dev/null +++ b/offapi/com/sun/star/frame/XFrameActionListener.idl @@ -0,0 +1,119 @@ +/************************************************************************* + * + * $RCSfile: XFrameActionListener.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:44 $ + * + * 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_frame_XFrameActionListener_idl__ +#define __com_sun_star_frame_XFrameActionListener_idl__ + +#ifndef __com_sun_star_lang_XEventListener_idl__ +#include +#endif + +#ifndef __com_sun_star_frame_FrameActionEvent_idl__ +#include +#endif + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from idl: interface com::sun::star::frame::XFrameActionListener +/** has to be provided if an object wants to receive events + when several things happen to components within frames of the desktop. + +

E.g. you can receive events of instanciation/destruction and + activation/deactivation of components. + + @see XDesktop::addFrameActionListener + @see XDesktop::removeFrameActionListener + */ +[ uik(E2280118-33D6-11D1-AABE00A0-249D5590), ident( "XFrameActionListener", 1.0 ) ] +interface XFrameActionListener: com::sun::star::lang::XEventListener +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XFrameActionListener::frameAction + /** is called whenever any action occurs to a component within a frame. + */ + [oneway] void frameAction( [in] com::sun::star::frame::FrameActionEvent aEvent ); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:21 hjs + initial import + + Revision 1.5 2000/09/11 11:52:29 mi + documentation merged from XML + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/XFrameLoader.idl b/offapi/com/sun/star/frame/XFrameLoader.idl new file mode 100644 index 000000000000..ba23757a847d --- /dev/null +++ b/offapi/com/sun/star/frame/XFrameLoader.idl @@ -0,0 +1,133 @@ +/************************************************************************* + * + * $RCSfile: XFrameLoader.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:44 $ + * + * 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_frame_XFrameLoader_idl__ +#define __com_sun_star_frame_XFrameLoader_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include +#endif + +#ifndef __com_sun_star_frame_XFrame_idl__ +#include +#endif + +#ifndef __com_sun_star_beans_PropertyValue_idl__ +#include +#endif + +#ifndef __com_sun_star_frame_XLoadEventListener_idl__ +#include +#endif + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge: empty anyway +[ uik(E2280103-33D6-11D1-AABE00A0-249D5590), ident( "XFrameLoader", 1.0 ) ] +interface XFrameLoader: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XFrameLoader::load + /** starts the loading of the specified resource into the specified Frame. + */ + [oneway] void load( [in] com::sun::star::frame::XFrame aFrame, + [in] string aURL, + [in] sequence aArgs, + [in] com::sun::star::frame::XLoadEventListener xListener ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XFrameLoader::cancel + /** cancels the loading process. + + + +

After returning from this call, neither the frame nor the + load-event-listener specified in "load" may be called back.

+ */ + [oneway] void cancel(); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:21 hjs + initial import + + Revision 1.5 2000/09/11 11:52:29 mi + documentation merged from XML + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/XFrameLoaderQuery.idl b/offapi/com/sun/star/frame/XFrameLoaderQuery.idl new file mode 100644 index 000000000000..6f66e91898ea --- /dev/null +++ b/offapi/com/sun/star/frame/XFrameLoaderQuery.idl @@ -0,0 +1,147 @@ +/************************************************************************* + * + * $RCSfile: XFrameLoaderQuery.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:44 $ + * + * 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_frame_XFrameLoaderQuery_idl__ +#define __com_sun_star_frame_XFrameLoaderQuery_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include +#endif + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include +#endif + +#ifndef __com_sun_star_beans_PropertyValue_idl__ +#include +#endif + +//============================================================================ + + module com { + module sun { + module star { + module frame { + +//============================================================================ + + +// DocMerge from xml: interface com::sun::star::frame::XFrameLoaderQuery +/** Use this interface together with a XMultiServiceFactory to implement a frame + loader. You can support detailed informations about supported with XFrameLoaderQuery + and create matching loader with XMultiServiceFactory. + + + + + + @deprecated + */ +[ uik(D65567DA-E825-4f90-BFABE287-98340C75), ident("XFrameLoaderQuery", 1.0) ] +interface XFrameLoaderQuery: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + + + // DocMerge from idl: method com::sun::star::frame::XFrameLoaderQuery::getAvailableFilterNames + /** return filter names of all available frame loader +

+ You can use a name of returned list to create a new frame loader + at a XMultiServiceFactory implementation. If you wish to get further + informations about loader properties use method getLoaderProperties() + of this interface. + */ + sequence< string > getAvailableFilterNames(); + + //------------------------------------------------------------------------- + + + // DocMerge from idl: method com::sun::star::frame::XFrameLoaderQuery::getLoaderProperties + /** return extended informations about all supported properties of an frame loader +

+ If you know a name of a loader call these method to get a set of all + supported properties. Use these values to create a new loader with special + arguments. + */ + sequence< ::com::sun::star::beans::PropertyValue > getLoaderProperties( [in] string sFilterName ); + + //------------------------------------------------------------------------- + + + // DocMerge from xml: method com::sun::star::frame::XFrameLoaderQuery::searchFilter + /** search a filter for given parameter + +

+ If you don't know a filter name of a loader call these method to search anyone + which support given parameter. Use returned name to get further informations + by means of getLoaderProperties() or create a new frame loader at a + XMultiServiceFactory. Don't forget to add returned filter name to argument list + for faster creation! Otherwise we search for right loader again. + (We look for FilterName first!)

+ */ + string searchFilter( [in] string sURL, [in] sequence< com::sun::star::beans::PropertyValue > seqArguments ); + + }; // XFrameLoaderQuery + }; // frame + }; // star + }; // sun +}; // com + +#endif diff --git a/offapi/com/sun/star/frame/XFrameSetModel.idl b/offapi/com/sun/star/frame/XFrameSetModel.idl new file mode 100644 index 000000000000..bc5a528043ee --- /dev/null +++ b/offapi/com/sun/star/frame/XFrameSetModel.idl @@ -0,0 +1,131 @@ +/************************************************************************* + * + * $RCSfile: XFrameSetModel.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:44 $ + * + * 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_frame_XFrameSetModel_idl__ +#define __com_sun_star_frame_XFrameSetModel_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include +#endif + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from xml: interface com::sun::star::frame::XFrameSetModel +/** This is the main interface for model objects. + + + + + + + + + + + + + + @deprecated + */ +[ uik(E2280100-33D6-11D1-AABE00A0-249D5590), ident( "XFrameSetModel", 1.0 ) ] +interface XFrameSetModel: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + + // DocMerge: empty anyway + string getSource(); + + //------------------------------------------------------------------------- + + // DocMerge: empty anyway + void setSource( [in] string Source ); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:22 hjs + initial import + + Revision 1.7 2000/09/11 11:52:29 mi + documentation merged from XML + + Revision 1.3 2000/02/23 14:49:56 mi + missing documentations + + Revision 1.2 2000/01/31 09:44:59 mi + XML syntax for documentation + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/XFrames.idl b/offapi/com/sun/star/frame/XFrames.idl new file mode 100644 index 000000000000..83e8079dcf4f --- /dev/null +++ b/offapi/com/sun/star/frame/XFrames.idl @@ -0,0 +1,159 @@ +/************************************************************************* + * + * $RCSfile: XFrames.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:44 $ + * + * 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_frame_XFrames_idl__ +#define __com_sun_star_frame_XFrames_idl__ + +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include +#endif + +#ifndef __com_sun_star_frame_XFrame_idl__ +#include +#endif + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from xml: interface com::sun::star::frame::XFrames +/** manages and creates frames. + + + +

Frames may contain other frames (by implementing an XFrames + interface) and may be contained in other frames. + +

@see interface XFrame + @see service Frame + */ +[ uik(E2280109-33D6-11D1-AABE00A0-249D5590), ident( "XFrames", 1.0 ) ] +interface XFrames: com::sun::star::container::XIndexAccess +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XFrames::append + /** appends the specified Frame to the list of sub-frames. + */ + void append( [in] com::sun::star::frame::XFrame xFrame ); + + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::frame::XFrames::queryFrames + /** @returns + all child frames of the container which are intended to be visible + to other objects. + +

The content of the sequence may be limited by the caller through + the FrameSearchFlags.

+ */ + sequence queryFrames( [in] long nSearchFlags ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XFrames::remove + /** removes the frame from its container. + + + +

The method + + + + + is not called implicitly + by this method. + +

+

The creator attribute of the frame must be reset by the caller of + this method.

+ */ + void remove( [in] com::sun::star::frame::XFrame xFrame ); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:21 hjs + initial import + + Revision 1.7 2000/09/11 11:52:29 mi + documentation merged from XML + + Revision 1.3 2000/02/23 14:49:56 mi + missing documentations + + Revision 1.2 2000/01/31 09:44:59 mi + XML syntax for documentation + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/XFramesSupplier.idl b/offapi/com/sun/star/frame/XFramesSupplier.idl new file mode 100644 index 000000000000..04b37b13ac67 --- /dev/null +++ b/offapi/com/sun/star/frame/XFramesSupplier.idl @@ -0,0 +1,165 @@ +/************************************************************************* + * + * $RCSfile: XFramesSupplier.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:44 $ + * + * 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_frame_XFramesSupplier_idl__ +#define __com_sun_star_frame_XFramesSupplier_idl__ + +#ifndef __com_sun_star_frame_XFrame_idl__ +#include +#endif + +//============================================================================= + + module com { module sun { module star { module frame { + +interface XFrames; + +//============================================================================= + +// DocMerge: empty anyway +[ uik(E2280108-33D6-11D1-AABE00A0-249D5590), ident( "XFramesSupplier", 1.0 ) ] +interface XFramesSupplier: XFrame +{ + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::frame::XFramesSupplier::getFrames + /** @returns + the collection of (sub-) frames which is represented by + a FramesContainer. + */ + XFrames getFrames(); + + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::frame::XFramesSupplier::getActiveFrame + /** @returns + the sub-Frame which is active within this frame. + +

This may be the frame itself. The active frame is defined as + the frame which contains (recursively) the window with the focus. + If no window within the frame contains the focus, this method + returns the last frame which had the focus. If no containing + window ever had the focus, the first frame within this frame is + returned. + */ + [const] XFrame getActiveFrame(); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XFramesSupplier::setActiveFrame + /** is called on activation of a direct sub-frame. + + + +

This method is only allowed to be called by a sub-frame according to + + + + + + or + + + + + + . After this call + + + + + + will return the + frame specified by xFrame. + +

+

In general this method first calls the method + + + + + + at the creator frame + with this as the current argument. Then it broadcasts + the FrameActionEvent FrameAction::FRAME_ACTIVATED.

+ */ + void setActiveFrame( [in] XFrame xFrame ); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:21 hjs + initial import + + Revision 1.5 2000/09/11 11:52:29 mi + documentation merged from XML + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/XInterceptorInfo.idl b/offapi/com/sun/star/frame/XInterceptorInfo.idl new file mode 100644 index 000000000000..e76d6caab144 --- /dev/null +++ b/offapi/com/sun/star/frame/XInterceptorInfo.idl @@ -0,0 +1,103 @@ +/************************************************************************* + * + * $RCSfile: XInterceptorInfo.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:44 $ + * + * 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_frame_XInterceptorInfo_idl__ +#define __com_sun_star_frame_XInterceptorInfo_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include +#endif + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +/** Makes it possible to get informations about registered interceptor. + zB. get URL lists for interception + Use it as an additional interface to XDispatchProviderInterceptor. + */ +[ uik(599AC162-87F4-4b55-A3F9D09E-6710B0C4), ident( "XInterceptorInfo", 1.0 ) ] +interface XInterceptorInfo: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + + /** return URL list for interception + */ + sequence< string > getInterceptedURLs(); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1 2000/10/18 12:09:31 as + #79050# new interface support interception of selected URLs + + Revision 1.1.1.1 2000/09/18 23:35:21 hjs + initial import + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/XLoadEventListener.idl b/offapi/com/sun/star/frame/XLoadEventListener.idl new file mode 100644 index 000000000000..796d22e7ca3a --- /dev/null +++ b/offapi/com/sun/star/frame/XLoadEventListener.idl @@ -0,0 +1,116 @@ +/************************************************************************* + * + * $RCSfile: XLoadEventListener.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:44 $ + * + * 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_frame_XLoadEventListener_idl__ +#define __com_sun_star_frame_XLoadEventListener_idl__ + +#ifndef __com_sun_star_lang_XEventListener_idl__ +#include +#endif + +//============================================================================= + + module com { module sun { module star { module frame { + +interface XFrameLoader; + +//============================================================================= + +// DocMerge from xml: interface com::sun::star::frame::XLoadEventListener +/** is used to receive callbacks from a frame loader. + */ +[ uik(E2280102-33D6-11D1-AABE00A0-249D5590), ident( "XLoadEventListener", 1.0 ) ] +interface XLoadEventListener: com::sun::star::lang::XEventListener +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XLoadEventListener::loadFinished + /** is called when a new control is loaded into a frame. + */ + [oneway] void loadFinished( [in] XFrameLoader aLoader ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XLoadEventListener::loadCancelled + /** is called when a frame load is cancelled. + */ + [oneway] void loadCancelled( [in] XFrameLoader aLoader ); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:22 hjs + initial import + + Revision 1.5 2000/09/11 11:52:29 mi + documentation merged from XML + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/XModel.idl b/offapi/com/sun/star/frame/XModel.idl new file mode 100644 index 000000000000..b80b36b420fc --- /dev/null +++ b/offapi/com/sun/star/frame/XModel.idl @@ -0,0 +1,294 @@ +/************************************************************************* + * + * $RCSfile: XModel.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:44 $ + * + * 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_frame_XModel_idl__ +#define __com_sun_star_frame_XModel_idl__ + +#ifndef __com_sun_star_lang_XComponent_idl__ +#include +#endif + +#ifndef __com_sun_star_beans_PropertyValue_idl__ +#include +#endif + +#ifndef __com_sun_star_frame_XController_idl__ +#include +#endif + +#ifndef __com_sun_star_container_NoSuchElementException_idl__ +#include +#endif + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include +#endif + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from idl: interface com::sun::star::frame::XModel +/** represents a component which is created from an URL and arguments. + +

It is a representation of a resource in the sense that it was + created/loaded from the resource. The arguments are passed to the loader + to modify its behavior. An example for such an argument is "AsTemplate", + which loads the resource as a template for a new document. + +

Models can be controlled by controller components, which are usually + views of the model. + +

If there is at least one controller, there is by definition a + current controller. And if that controller supports the interface + XSelectionSupplier, it has a current selection too. + */ +[ uik(E2280111-33D6-11D1-AABE00A0-249D5590), ident( "XModel", 1.0 ) ] +interface XModel: com::sun::star::lang::XComponent +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XModel::attachResource + /** informs a model about its resource description. + */ + boolean attachResource( [in] string aURL, + [in] sequence aArgs ); + + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::frame::XModel::getURL + /** @returns + the URL of the resource which is represented by this model. + + @see XStorable::getLocation + */ + string getURL(); + + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::frame::XModel::getArgs + /** @returns + the arguments with which the model was originally created or + stored the last time. + */ + sequence getArgs(); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XModel::connectController + /** is called whenever a new controller is created for this model. + + + +

The XComponent interface of the controller must be used to + recognize when it is deleted. + +

@see releaseController + */ + [oneway] void connectController( [in] com::sun::star::frame::XController xController ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XModel::disconnectController + /** is called whenever a new controller is created for this model. + + + +

The XComponent interface of the controller must be + used to recognize when it is deleted. + +

@see registerController + */ + [oneway] void disconnectController( [in] com::sun::star::frame::XController xController ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XModel::lockControllers + /** suspends some notifications to the controllers which are used + for display updates. + + + +

The calls to + + + + + and + + + + + + may be + nested and even overlapping, but they must be in pairs. While + there is at least one lock remaining, some notifications + for display updates are not broadcasted.

+ */ + [oneway] void lockControllers(); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XModel::unlockControllers + /** resumes the notifications which were suspended by + + + + + + . + + + +

The calls to + + + + + and + + + + + + may be + nested and even overlapping, but they must be in pairs. While + there is at least one lock remaining, some notifications for + display updates are not broadcasted.

+ */ + [oneway] void unlockControllers(); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XModel::hasControllersLocked + /** determines if there is at least one lock remaining. + + + +

While there is at least one lock remaining, some notifications + for display updates are not broadcasted to the controllers.

+ */ + boolean hasControllersLocked(); + + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::frame::XModel::getCurrentController + /** @returns + the controller which currently controls this model. + +

If the controller which is active is a controller of this model, + it will be returned. If not, the controller which was the last + active of this model is returned. If no controller of this model + ever was active, the controller first registered is returned. If no + controller is registered for this model, NULL is returned. + */ + [const] com::sun::star::frame::XController getCurrentController(); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XModel::setCurrentController + /** sets a registered controller as the current controller. + */ + void setCurrentController( [in] com::sun::star::frame::XController xController ) + raises( com::sun::star::container::NoSuchElementException ); + + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::frame::XModel::getCurrentSelection + /** @returns + the current selection in the current controller. + +

If there is no current controller, it returns NULL. + */ + [const] com::sun::star::uno::XInterface getCurrentSelection(); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:22 hjs + initial import + + Revision 1.8 2000/09/11 11:52:29 mi + documentation merged from XML + + Revision 1.4 2000/02/23 14:49:56 mi + missing documentations + + Revision 1.3 2000/01/31 09:44:59 mi + XML syntax for documentation + + Revision 1.2 1999/11/18 11:49:57 mi + XComponent now in module lang + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/XStatusListener.idl b/offapi/com/sun/star/frame/XStatusListener.idl new file mode 100644 index 000000000000..19a9fe06434d --- /dev/null +++ b/offapi/com/sun/star/frame/XStatusListener.idl @@ -0,0 +1,118 @@ +/************************************************************************* + * + * $RCSfile: XStatusListener.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:44 $ + * + * 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_frame_XStatusListener_idl__ +#define __com_sun_star_frame_XStatusListener_idl__ + +#ifndef __com_sun_star_lang_XEventListener_idl__ +#include +#endif + +#ifndef __com_sun_star_frame_FeatureStateEvent_idl__ +#include +#endif + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from xml: interface com::sun::star::frame::XStatusListener +/** makes it possible to receive events when the state of a feature changes. + */ +[ uik(E2280121-33D6-11D1-AABE00A0-249D5590), ident( "XStatusListener", 1.0 ) ] +interface XStatusListener: com::sun::star::lang::XEventListener +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XStatusListener::statusChanged + /** is called when the status of the feature changes. + */ + [oneway] void statusChanged( [in] com::sun::star::frame::FeatureStateEvent Event ); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:22 hjs + initial import + + Revision 1.7 2000/09/11 11:52:29 mi + documentation merged from XML + + Revision 1.3 2000/02/23 14:49:56 mi + missing documentations + + Revision 1.2 2000/01/31 09:44:59 mi + XML syntax for documentation + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/XStorable.idl b/offapi/com/sun/star/frame/XStorable.idl new file mode 100644 index 000000000000..08adaa62d739 --- /dev/null +++ b/offapi/com/sun/star/frame/XStorable.idl @@ -0,0 +1,237 @@ +/************************************************************************* + * + * $RCSfile: XStorable.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:44 $ + * + * 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_frame_XStorable_idl__ +#define __com_sun_star_frame_XStorable_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include +#endif + +#ifndef __com_sun_star_io_IOException_idl__ +#include +#endif + +#ifndef __com_sun_star_beans_PropertyValue_idl__ +#include +#endif + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from xml: interface com::sun::star::frame::XStorable +/** offers a simple way to store a component to a URL. + + + +

It is usually only useful for two cases: + +

+
    +
  1. Large components which are wrapped with StarOne interfaces + and for which distinct filters are not available separately as + components. + +
    2. +
  2. Very small components for which only one or very few hard + coded file format filters make sense or even exist. +
    3. +
+ */ +[ uik(E2280112-33D6-11D1-AABE00A0-249D5590), ident( "XStorable", 1.0 ) ] +interface XStorable: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::frame::XStorable::hasLocation + /** @returns + if the object knows a location where it is persistent. + +

The object may know the location because it was loaded from there, + or because it is stored there. + */ + [const] boolean hasLocation(); + + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::frame::XStorable::getLocation + /** @returns + the URL of the resource which is represented by this object. + +

After XStorable::storeAsURL it returns the + URL the object was stored to. + */ + [const] string getLocation(); + + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::frame::XStorable::isReadonly + /** @returns + if the data store is readonly or opened readonly. + +

It is not possible to call store() successfully when the data + store is read-only. + */ + [const] boolean isReadonly(); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XStorable::store + /** stores the data to the URL from which it was loaded. + + + +

Only objects which know their locations can be stored.

+ */ + void store() + raises( com::sun::star::io::IOException ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XStorable::storeAsURL + /** stores the object's persistent data to a URL and + lets the object become the representation of this new URL. + + + +

This is the normal behavior for UI's "save-as" feature. + +

+

The arguments depend on the object itself. Commonly used are: +

+
string FilterName +
+
The programmatic name of the file format filter to be used. + +
+
string FilterFlags +
+
This string contains flags which depend on the filter. + They describe how the data is to be stored. (E.g. the + field delimitors for text database formats or the + character set.) + +
+
boolean Overwrite +
+
Overwrites the target file if it exists. Otherwise the + call would result in an exception if the file exists. + +
+
string Password +
+
This argument specifies the password to be used to + encrypt the document. +
+
+ +

@see storeTo + */ + void storeAsURL( [in] string aURL, + [in] sequence aArgs ) + raises( com::sun::star::io::IOException ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XStorable::storeToURL + /** stores the object's persistent data to a URL and + continues to be a representation of the old URL. + + + +

This is the normal behavior for UI's export feature. + +

@see storeAs + */ + void storeToURL( [in] string aURL, + [in] sequence aArgs ) + raises( com::sun::star::io::IOException ); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:22 hjs + initial import + + Revision 1.7 2000/09/11 11:52:29 mi + documentation merged from XML + + Revision 1.3 2000/02/23 14:49:56 mi + missing documentations + + Revision 1.2 2000/01/31 09:44:59 mi + XML syntax for documentation + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/XTask.idl b/offapi/com/sun/star/frame/XTask.idl new file mode 100644 index 000000000000..fd031c874e69 --- /dev/null +++ b/offapi/com/sun/star/frame/XTask.idl @@ -0,0 +1,144 @@ +/************************************************************************* + * + * $RCSfile: XTask.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:44 $ + * + * 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_frame_XTask_idl__ +#define __com_sun_star_frame_XTask_idl__ + +#ifndef __com_sun_star_frame_XFrame_idl__ +#include +#endif + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from xml: interface com::sun::star::frame::XTask +/** This is the main interface of a task within the desktop. + + + + + + + + @deprecated@see XDesktopTask + for substitute. + + @see XWindowArranger + for substitute. + */ +[ uik(E2280116-33D6-11D1-AABE00A0-249D5590), ident( "XTask", 1.0 ) ] +interface XTask: com::sun::star::frame::XFrame +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XTask::close + /** tries to close all windows within the task and the task by itself. + */ + boolean close(); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XTask::tileWindows + /** arranges the windows within the task in tiles. + */ + [oneway] void tileWindows(); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XTask::arrangeWindowsVertical + /** arranges the windows within the task vertically. + */ + [oneway] void arrangeWindowsVertical(); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XTask::arrangeWindowsHorizontal + /** arranges the windows within the task horizontally. + */ + [oneway] void arrangeWindowsHorizontal(); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:22 hjs + initial import + + Revision 1.6 2000/09/11 11:52:29 mi + documentation merged from XML + + Revision 1.2 1999/11/25 16:03:32 mi + welforming HTML for XML + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/XTasksSupplier.idl b/offapi/com/sun/star/frame/XTasksSupplier.idl new file mode 100644 index 000000000000..27c780493e34 --- /dev/null +++ b/offapi/com/sun/star/frame/XTasksSupplier.idl @@ -0,0 +1,138 @@ +/************************************************************************* + * + * $RCSfile: XTasksSupplier.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:44 $ + * + * 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_frame_XTasksSupplier_idl__ +#define __com_sun_star_frame_XTasksSupplier_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include +#endif + +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include +#endif + +#ifndef __com_sun_star_frame_XTask_idl__ +#include +#endif + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from xml: interface com::sun::star::frame::XTasksSupplier +/** provides access to the tasks of a desktop environment. + + + +

Note: Not all desktop environments support tasks at all. + +

@see service Desktop + */ +[ uik(E2280124-33D6-11D1-AABE00A0-249D5590), ident( "XTasksSupplier", 1.0 ) ] +interface XTasksSupplier: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::frame::XTasksSupplier::getTasks + /** @returns + a collection of all tasks currently running in the desktop. + +

The service Tasks contained in this attribute is + a collection object of all tasks of the desktop. + + @see service Tasks + */ + [const] com::sun::star::container::XEnumerationAccess getTasks(); + + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::frame::XTasksSupplier::getActiveTask + /** @returns + the task of the currently active component within this desktop enviroment. + +

Even if an active component exists, there may be no active task. + */ + [const] com::sun::star::frame::XTask getActiveTask(); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:22 hjs + initial import + + Revision 1.5 2000/09/11 11:52:29 mi + documentation merged from XML + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/XTerminateListener.idl b/offapi/com/sun/star/frame/XTerminateListener.idl new file mode 100644 index 000000000000..605fd1300e76 --- /dev/null +++ b/offapi/com/sun/star/frame/XTerminateListener.idl @@ -0,0 +1,126 @@ +/************************************************************************* + * + * $RCSfile: XTerminateListener.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:44 $ + * + * 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_frame_XTerminateListener_idl__ +#define __com_sun_star_frame_XTerminateListener_idl__ + +#ifndef __com_sun_star_lang_XEventListener_idl__ +#include +#endif + +#ifndef __com_sun_star_lang_EventObject_idl__ +#include +#endif + +#ifndef __com_sun_star_frame_TerminationVetoException_idl__ +#include +#endif + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from xml: interface com::sun::star::frame::XTerminateListener +/** has to be provided if an object wants to receive an event + when the master environment (e.g. desktop) is terminated.@see XDesktop::addTerminateListener + @see XDesktop::removeTerminateListener + */ +[ uik(E2280117-33D6-11D1-AABE00A0-249D5590), ident( "XTerminateListener", 1.0 ) ] +interface XTerminateListener: com::sun::star::lang::XEventListener +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XTerminateListener::queryTermination + /** is called when the master environment (e.g. desktop) is about to terminate. + */ + void queryTermination( [in] com::sun::star::lang::EventObject aEvent ) + raises( com::sun::star::frame::TerminationVetoException ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XTerminateListener::notifyTermination + /** is called when the master environment is finally terminated. + */ + void notifyTermination( [in] com::sun::star::lang::EventObject aEvent ); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:22 hjs + initial import + + Revision 1.5 2000/09/11 11:52:29 mi + documentation merged from XML + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/XUrlList.idl b/offapi/com/sun/star/frame/XUrlList.idl new file mode 100644 index 000000000000..aca4129122a1 --- /dev/null +++ b/offapi/com/sun/star/frame/XUrlList.idl @@ -0,0 +1,88 @@ +/************************************************************************* + * + * $RCSfile: XUrlList.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:44 $ + * + * 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_frame_XUrlList_idl__ +#define __com_sun_star_frame_XUrlList_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include +#endif + + +//============================================================================= + +module com { module sun { module star { module frame { + +//============================================================================= +/** povides a list of URLs (i.e. to represent a selection). + + @deprecated +*/ +[ uik(E2280123-33D6-11D1-AABE00A0-249D5590), ident( "XUrlList", 1.0 ) ] +interface XUrlList: com::sun::star::uno::XInterface +{ + [attribute] sequence List; +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/frame/XWindowArranger.idl b/offapi/com/sun/star/frame/XWindowArranger.idl new file mode 100644 index 000000000000..0c66bccf287b --- /dev/null +++ b/offapi/com/sun/star/frame/XWindowArranger.idl @@ -0,0 +1,118 @@ +/************************************************************************* + * + * $RCSfile: XWindowArranger.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:44 $ + * + * 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_frame_XWindowArranger_idl__ +#define __com_sun_star_frame_XWindowArranger_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include +#endif + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + +// DocMerge from xml: interface com::sun::star::frame::XWindowArranger +/** makes it possible to arrange the sub-windows within this component. + */ +[ uik(E2280130-33D6-11D1-AABE00A0-249D5590), ident( "XWindowArranger", 1.0 ) ] +interface XWindowArranger: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::frame::XWindowArranger::hasArrangeCommand + /** @returns + if the specified arrangement style is supported. + + @see constants WindowArrange + */ + boolean hasArrangeCommand( [in] short nCommand ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::frame::XWindowArranger::arrange + /** arranges the window according to the specified style.@see constants WindowArrange + */ + [oneway] void arrange( [in] short nCommand ); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:22 hjs + initial import + + Revision 1.5 2000/09/11 11:52:29 mi + documentation merged from XML + + Revision 1.1.1.1 1999/11/11 09:48:43 jsc + new + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/frame/makefile.mk b/offapi/com/sun/star/frame/makefile.mk new file mode 100644 index 000000000000..c37231e49069 --- /dev/null +++ b/offapi/com/sun/star/frame/makefile.mk @@ -0,0 +1,128 @@ +#************************************************************************* +# +# $RCSfile: makefile.mk,v $ +# +# $Revision: 1.1 $ +# +# last change: $Author: mi $ $Date: 2000-11-06 09:21:44 $ +# +# 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=cssframe +PACKAGE=com$/sun$/star$/frame + +# --- Settings ----------------------------------------------------- +.INCLUDE : $(PRJ)$/util$/makefile.pmk + +# ------------------------------------------------------------------------ + +IDLFILES=\ + Components.idl\ + Controller.idl\ + Desktop.idl\ + DesktopTask.idl\ + DesktopTasks.idl\ + DispatchDescriptor.idl\ + FeatureStateEvent.idl\ + Frame.idl\ + FrameAction.idl\ + FrameActionEvent.idl\ + FrameControl.idl\ + FrameLoader.idl\ + FramesContainer.idl\ + FrameSearchFlag.idl\ + MediaTypeDetectionHelper.idl\ + Settings.idl\ + TerminationVetoException.idl\ + WindowArrange.idl\ + XBrowseHistoryRegistry.idl\ + XComponentLoader.idl\ + XComponentRegistry.idl\ + XConfigManager.idl\ + XController.idl\ + XDesktop.idl\ + XDesktopTask.idl\ + XDispatch.idl\ + XDispatchProvider.idl\ + XDispatchProviderInterception.idl\ + XDispatchProviderInterceptor.idl\ + XExtendedFilterDetection.idl\ + XFilterDetect.idl\ + XFrame.idl\ + XFrameActionListener.idl\ + XFrameLoader.idl\ + XFrameLoaderQuery.idl\ + XFrames.idl\ + XFrameSetModel.idl\ + XFramesSupplier.idl\ + XInterceptorInfo.idl\ + XLoadEventListener.idl\ + XModel.idl\ + XStatusListener.idl\ + XStorable.idl\ + XTask.idl\ + XTasksSupplier.idl\ + XTerminateListener.idl\ + XUrlList.idl\ + XWindowArranger.idl\ + +# ------------------------------------------------------------------ + +.INCLUDE : target.mk +.INCLUDE : $(PRJ)$/util$/target.pmk -- cgit