diff options
| author | Michael Hönnig <mi@openoffice.org> | 2002-10-03 12:11:20 +0000 |
|---|---|---|
| committer | Michael Hönnig <mi@openoffice.org> | 2002-10-03 12:11:20 +0000 |
| commit | cb23f6a62077022736a40d6315ee92a218f489e0 (patch) | |
| tree | 713895d0de4930fd1a37b2fb7bb6ded971a2acdf /offapi/com/sun/star/frame | |
| parent | 625aff4ec7a47d618a9da160e962fc6fb5c834c5 (diff) | |
#94968# IDL reviews merged
Diffstat (limited to 'offapi/com/sun/star/frame')
62 files changed, 2337 insertions, 2519 deletions
diff --git a/offapi/com/sun/star/frame/Components.idl b/offapi/com/sun/star/frame/Components.idl index dabd3faca4dd..a33f78ac8212 100644 --- a/offapi/com/sun/star/frame/Components.idl +++ b/offapi/com/sun/star/frame/Components.idl @@ -2,9 +2,9 @@ * * $RCSfile: Components.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:14 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,54 +65,31 @@ #include <com/sun/star/container/XEnumerationAccess.idl> #endif - //============================================================================= - module com { module sun { module star { module frame { +module com { module sun { module star { module frame { //============================================================================= +/** specifies a collection of components -// DocMerge from xml: service com::sun::star::frame::Components -/** specifies a collection of components. - + <p> + One important instance of this service is available from the + <type>Desktop</type> object via the <type>XDesktop</type> interface. + </p> - <p>One important instance of this service is available from the - <type>Desktop</type> object via the <type>XDesktop</type> interface. </p> - @see com::sun::star::lang::XComponent - @see XDesktop + @see com::sun::star::lang::XComponent + @see XDesktop */ service Components { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + /** use it to get snapshot of current avaliable components as an enumeration + */ interface com::sun::star::container::XEnumerationAccess; - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:10 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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/ContentHandler.idl b/offapi/com/sun/star/frame/ContentHandler.idl new file mode 100644 index 000000000000..ba633a3ebaf0 --- /dev/null +++ b/offapi/com/sun/star/frame/ContentHandler.idl @@ -0,0 +1,104 @@ +/************************************************************************* + * + * $RCSfile: ContentHandler.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05:14 $ + * + * 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_ContentHandler_idl__ +#define __com_sun_star_frame_ContentHandler_idl__ + +#ifndef __com_sun_star_frame_XNotifyingDispatch_idl__ +#include <com/sun/star/frame/XNotifyingDispatch.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module frame { + +//============================================================================= +/** special dispatcher for non visible contents, e.g. sounds + + <p> + This handler doesn't need any frame as target for loading components. + Content handler are registered for content types. + (See type/filter configuration of <type scope="com::sun::star::document">TypeDetection</type> + for further informations) If generic load mechanism found such documents which + can be handled by a ContentHandler it will create and use it. + </p> + + @see com::sun::star::document::TypeDetection + */ +service ContentHandler +{ + //------------------------------------------------------------------------- + /** provides handling of dispatches with defined result state + + <p> + Base interface of <type>XNotifyingDispatch</type> is <type>XDispatch</type> + and can be called for requests if result isn't neccessary for dispatch operation. + </p> + + @see XDispatch + */ + interface XNotifyingDispatch; +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/frame/ContentHandlerFactory.idl b/offapi/com/sun/star/frame/ContentHandlerFactory.idl new file mode 100644 index 000000000000..64b9573843f6 --- /dev/null +++ b/offapi/com/sun/star/frame/ContentHandlerFactory.idl @@ -0,0 +1,145 @@ +/************************************************************************* + * + * $RCSfile: ContentHandlerFactory.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05:15 $ + * + * 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_ContentHandlerFactory_idl__ +#define __com_sun_star_frame_ContentHandlerFactory_idl__ + +#ifndef __com_sun_star_lang_XMultiServiceFactory_idl__ +#include <com/sun/star/lang/XMultiServiceFactory.idl> +#endif + +#ifndef __com_sun_star_container_XNameAccess_idl__ +#include <com/sun/star/container/XNameAccess.idl> +#endif + +#ifndef __com_sun_star_container_XContainerQuery_idl__ +#include <com/sun/star/container/XContainerQuery.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module frame { + +//============================================================================= +/** factory to create content loader + + <p> + With this factory it's possible to + <ul> + <li>have access on configuration of set of registered content handler objects</li> + <li>create a content handler by his internal name</li> + <li>query for a content handler by using special query or property description.</li> + </ul> + </p> + */ +service ContentHandlerFactory +{ + //------------------------------------------------------------------------- + /** interface to create handler objects by using his internal name + + <p> + Returned objects must support the service specification of a <type>ContentHandler</type>. + They can be created by using of his internal name, which must be unambigous everytime, only. + To get this name use further specified interfaces of this factory for access on + the flat configuration. + </p> + */ + interface com::sun::star::lang::XMultiServiceFactory; + + //------------------------------------------------------------------------- + /** provides access to the whole content handler configuration + + <p> + This interface supports an access to the internal configuration + of all accessible handler objects. The return value of + <member>XNameAccess::getByName()</member> is a property sequence + packed in an any. + </p> + <table border=1> + <tr> + <td><b>Types<b></td> + <td>[string]</td> + <td>file types for which handler is registered</td> + </tr> + <tr> + <td><b>UIName<b></td> + <td>[string]</td> + <td>UI representable and localized name</td> + </tr> + </table> + */ + interface com::sun::star::container::XNameAccess; + + //------------------------------------------------------------------------- + /** supports query mode for configuration access + + <p> + This interface can be used to get sub sets of current configuration entries + which represent given search parameters. + </p> + */ + interface com::sun::star::container::XContainerQuery; +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/frame/Controller.idl b/offapi/com/sun/star/frame/Controller.idl index 25435626fc73..68dfdd9580b7 100644 --- a/offapi/com/sun/star/frame/Controller.idl +++ b/offapi/com/sun/star/frame/Controller.idl @@ -2,9 +2,9 @@ * * $RCSfile: Controller.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: arellano $ $Date: 2001-04-13 20:26:41 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,34 +73,70 @@ #include <com/sun/star/awt/XWindow.idl> #endif +#ifndef __com_sun_star_ui_XContextMenuInterception_idl__ +#include <com/sun/star/ui/XContextMenuInterception.idl> +#endif + +#ifndef __com_sun_star_view_XSelectionSupplier_idl__ +#include <com/sun/star/view/XSelectionSupplier.idl> +#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 <type scope="com::sun::star::awt">UnoControl</type> - can offer. - - <!-- Dennis: Are the descriptions of XController and XDispatchProvider missing descriptions? -->*/ + desktop components than a <type scope="com::sun::star::awt">XWindow</type> + can offer + + <p> + Such components can be loaded into a <type>Frame</type> inside a <type>Desktop</type> + environment. A controller is a recher component then a pure window, but full featured + components need a <type>XModel</type> interface too. + <br> + (see service <type scope="com::sun::star::document">OfficeDocument</type> for further information) + <p> + + @see com::sun::star::document::OfficeDocument + */ service Controller { - // DocMerge: empty anyway - interface com::sun::star::frame::XController; + //------------------------------------------------------------------------- + /** with this interface, components viewed in a <type>Frame</type> can serve + events (by supplying dispatches) + */ + interface XController; - // DocMerge: empty anyway - interface com::sun::star::frame::XDispatchProvider; + //------------------------------------------------------------------------- + /** for certain functions which are useful at the UI + <p> + Mostly used by the <type>Frame</type> service, which contains this + controller object. There will be an interception mechanism for dispatches + available too. + </p> - // 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 - are the same object. + @see XDispatch + @see XDispatchProviderInterception */ - interface com::sun::star::awt::XWindow; + interface XDispatchProvider; + //------------------------------------------------------------------------- + /** this interface enables the controller to get interceptors registered that + change context menue or prevent them from beeing executed + + <p> + Don't mix it with <type>XDispatchProviderInterception</type> which + intercept calls of <member>XDispatch::dispatch()</member>. + </p> + */ + [optional] interface com::sun::star::ui::XContextMenuInterception; + + //------------------------------------------------------------------------- + /** makes it possible to access and change the selection in a view + */ + [optional] interface com::sun::star::view::XSelectionSupplier; }; //============================================================================= @@ -110,6 +146,12 @@ service Controller /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.14.1 2002/06/17 08:44:10 as + odk review + + Revision 1.4 2001/04/13 20:26:41 arellano + revised plural and added question + Revision 1.3 2000/11/08 12:43:14 mi moved from api diff --git a/offapi/com/sun/star/frame/Desktop.idl b/offapi/com/sun/star/frame/Desktop.idl index 6062b6fe8819..ac4c56e67abe 100644 --- a/offapi/com/sun/star/frame/Desktop.idl +++ b/offapi/com/sun/star/frame/Desktop.idl @@ -2,9 +2,9 @@ * * $RCSfile: Desktop.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,8 +65,16 @@ #include <com/sun/star/frame/Frame.idl> #endif -#ifndef __com_sun_star_lang_Locale_idl__ -#include <com/sun/star/lang/Locale.idl> +#ifndef __com_sun_star_frame_XDesktop_idl__ +#include <com/sun/star/frame/XDesktop.idl> +#endif + +#ifndef __com_sun_star_frame_XComponentLoader_idl__ +#include <com/sun/star/frame/XComponentLoader.idl> +#endif + +#ifndef __com_sun_star_document_XEventBroadcaster_idl__ +#include <com/sun/star/document/XEventBroadcaster.idl> #endif #ifndef __com_sun_star_beans_XPropertySet_idl__ @@ -77,64 +85,48 @@ 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 instantiate within frames. - - <p>A desktop environment contains tasks with one or more frames - in which components can be loaded.</p> +/** is the environment for components which can instantiate within frames + + <p> + A desktop environment contains tasks with one or more frames + in which components can be loaded. The term "task" or naming a frame as a + "task frame" is not in any way related to any additional implemented + interfaces, it's just because these frames use task windows. + </p> */ service Desktop { + //------------------------------------------------------------------------- + /** make it possible to be the global root of different seperated frame trees + + <p> + It's not a must for a frame (neither a frame tree) to be a part of this + global tree. But such outstanding frames willn't be accessible by the normal + frame api. + </p> + */ service Frame; + //------------------------------------------------------------------------- + /** regulate life time of desktop environment and support high level + access to components of sub frame tree + */ interface XDesktop; + + //------------------------------------------------------------------------- + /** supports simple api for loading components into the frame environment + */ interface XComponentLoader; - interface XTasksSupplier; - interface com::sun::star::beans::XPropertySet; //------------------------------------------------------------------------- - /** returns currently active child frame of desktop + /** provides listener support for events on currently loaded documents */ - [property, readonly] com::sun::star::frame::XFrame ActiveFrame; + interface com::sun::star::document::XEventBroadcaster; }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2001/09/26 09:57:05 as - #79395# actualize service description - - Revision 1.4 2001/03/15 08:53:46 as - #80780# remove non supported property - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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 index 6e51369abc99..c16e8fe51837 100644 --- a/offapi/com/sun/star/frame/DesktopTask.idl +++ b/offapi/com/sun/star/frame/DesktopTask.idl @@ -2,9 +2,9 @@ * * $RCSfile: DesktopTask.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: arellano $ $Date: 2001-04-13 20:38:58 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -89,112 +89,31 @@ #include <com/sun/star/awt/Size.idl> #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 DesktopTasks +/** @deprecated */ 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 pixels 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.4 2000/12/21 08:35:10 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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 index f4a2685d45a8..719e2298797a 100644 --- a/offapi/com/sun/star/frame/DesktopTasks.idl +++ b/offapi/com/sun/star/frame/DesktopTasks.idl @@ -2,9 +2,9 @@ * * $RCSfile: DesktopTasks.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-21 08:35:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,50 +65,20 @@ #include <com/sun/star/container/XEnumerationAccess.idl> #endif - //============================================================================= module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: service com::sun::star::frame::DesktopTasks -/** specifies a collection of tasks. - - - - <p>One important instance of this service is available from the - <type>Desktop</type> object via the <type>XDesktop</type> interface. - - </p>@see DesktopTask - @see XDesktop +/** @deprecated */ service DesktopTasks { - // DocMerge: empty anyway interface com::sun::star::container::XEnumerationAccess; - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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 index 4d295130e4b7..d3d92389da3a 100644 --- a/offapi/com/sun/star/frame/DispatchDescriptor.idl +++ b/offapi/com/sun/star/frame/DispatchDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: DispatchDescriptor.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: arellano $ $Date: 2001-04-13 20:42:04 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,59 +71,57 @@ module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: struct com::sun::star::frame::DispatchDescriptor /** describes a feature to be retrieved by a URL that - has to be loaded into a specified frame. + has to be loaded into a specified frame + + <p> + For a normal dispatch calls all needed parameters are seperated. + For optimized remote functionality <member>XDispatch::queryDispatches()</member> + it's neccessary to pack these parameters in a flat structure wich can be used + in a simple manner. + </p> + + @see XDispatchProvider::queryDispatches() */ struct DispatchDescriptor { - // DocMerge from xml: field com::sun::star::frame::DispatchDescriptor::FeatureURL - /** Specifies the URL of the resource/function. + //------------------------------------------------------------------------- + /** specifies the URL of the resource/function + + <p> + Must be a full parsed URL. Use service <type scope="com::sun::star::util">URLTransformer</type> + for that. + </p> + + @see com::sun::star::util::URLTransformer */ com::sun::star::util::URL FeatureURL; //------------------------------------------------------------------------- + /** name of the target frame + + <p> + Special targets (e.g. "_blank", "_self") can be used. + </p> - // DocMerge from xml: field com::sun::star::frame::DispatchDescriptor::FrameName - /** Name of the target frame. + @see XDispatchProvider::queryDispatch() */ string FrameName; //------------------------------------------------------------------------- + /** describes how the target frame is to be searched - // DocMerge from xml: field com::sun::star::frame::DispatchDescriptor::SearchFlags - /** How the target frame is to be searched. + <p> + This optional parameter is used if <var>FrameName</var> isn't a special target only. + </p> + + @see FrameSearchFlag */ long SearchFlags; - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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/DispatchProvider.idl b/offapi/com/sun/star/frame/DispatchProvider.idl new file mode 100644 index 000000000000..a58875b6e274 --- /dev/null +++ b/offapi/com/sun/star/frame/DispatchProvider.idl @@ -0,0 +1,121 @@ +/************************************************************************* + * + * $RCSfile: DispatchProvider.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05:16 $ + * + * 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_DispatchProvider_idl__ +#define __com_sun_star_frame_DispatchProvider_idl__ + +#ifndef __com_sun_star_frame_XDispatchProvider_idl__ +#include <com/sun/star/frame/XDispatchProvider.idl> +#endif + +#ifndef __com_sun_star_frame_XDispatchProviderInterception_idl__ +#include <com/sun/star/frame/XDispatchProviderInterception.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module frame { + +//============================================================================= +/** provides <type>XDispatch</type> objects for certain functions which + are useful at the UI + + <p> + Such dispatch objects must be queried explicitly and used for + queried purposes only. They can handle requests with guaranteed + notifications (<type>XNotifyingDispatch</type>) and with possible + (but not guaranteed) notifications + </p> + + @see XNotifyingDispatch + @see XDispatch + */ +service DispatchProvider +{ + //------------------------------------------------------------------------- + /** provides handling of dispatches with defined result state + + <p> + Base interface of <type>XNotifyingDispatch</type> is <type>XDispatch</type> + and can be called for requests if result isn't neccessary for dispatch operation. + </p> + + @see XDispatch + */ + interface XDispatchProvider; + + //------------------------------------------------------------------------- + /** provides handling of dispatches with defined result state + + <p> + Base interface of <type>XNotifyingDispatch</type> is <type>XDispatch</type> + and can be called for requests if result isn't neccessary for dispatch operation. + </p> + + @see XDispatch + */ + [optional] interface XDispatchProviderInterception; +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/frame/DispatchResultEvent.idl b/offapi/com/sun/star/frame/DispatchResultEvent.idl index 174d4f92f554..4595e937cfdd 100644 --- a/offapi/com/sun/star/frame/DispatchResultEvent.idl +++ b/offapi/com/sun/star/frame/DispatchResultEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: DispatchResultEvent.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mba $ $Date: 2001-11-21 12:49:54 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,19 +75,29 @@ module com { module sun { module star { module frame { //============================================================================= +/** contains the result of the dispatch action, if State is set to SUCCESS + <p> + The type of the result is dispatch action dependend. The member State + can be set to one of the values defined in <type>DispatchResultState</type>. + If State is set to <const>DispatchResultState::FAILURE</const>, Result may + specify the reason (or is empty). The type is also dispatch action dependend. + If State is set to <const>DispatchResultState::DONTKNOW</const>, Result is empty. + </p> + + @see DispatchResultState +*/ struct DispatchResultEvent: com::sun::star::lang::EventObject { //------------------------------------------------------------------------- - /**Contains the result of the dispatch action, if State is set to SUCCESS. - The type of the result is dispatch action dependend.<BR> - The member State can be set to one of the values defined in <type>DispatchResultState</type>.<BR> - If State is set to FAILURE, Result may specify the reason (or is empty). - The type is also dispatch action dependend.<BR> - If State is set to DONTKNOW, Result is empty.<BR> - */ - short State; - any Result; + /** describes state of dispatch + */ + short State; + + //------------------------------------------------------------------------- + /** describes result for given <var>State</var> + */ + any Result; }; //============================================================================= diff --git a/offapi/com/sun/star/frame/DispatchResultState.idl b/offapi/com/sun/star/frame/DispatchResultState.idl index 79fa017fccd7..2638ad99a9e4 100644 --- a/offapi/com/sun/star/frame/DispatchResultState.idl +++ b/offapi/com/sun/star/frame/DispatchResultState.idl @@ -2,9 +2,9 @@ * * $RCSfile: DispatchResultState.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: mba $ $Date: 2001-11-21 12:49:54 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -66,16 +66,24 @@ module com { module sun { module star { module frame { //============================================================================= -/** +/** possible values for <type>DispatchResultEvent</type> */ - constants DispatchResultState { - const short FAILURE = 0; + //------------------------------------------------------------------------- + /** indicates: dispatch failed + */ + const short FAILURE = 0; - const short SUCCESS = 1; + //------------------------------------------------------------------------- + /** indicates: dispatch was successfully + */ + const short SUCCESS = 1; - const short DONTKNOW = 2; + //------------------------------------------------------------------------- + /** indicates: result isn't defined + */ + const short DONTKNOW = 2; }; //============================================================================= diff --git a/offapi/com/sun/star/frame/DocumentTemplates.idl b/offapi/com/sun/star/frame/DocumentTemplates.idl index a74d19799ae6..2d12d5101b5b 100644 --- a/offapi/com/sun/star/frame/DocumentTemplates.idl +++ b/offapi/com/sun/star/frame/DocumentTemplates.idl @@ -2,9 +2,9 @@ * * $RCSfile: DocumentTemplates.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,42 +70,20 @@ module com { module sun { module star { module frame { //============================================================================= - /** is an abstract service for accessing the document templates of the office and manipulate them ( add or rename or remove templates ) */ - service DocumentTemplates { - // DocMerge: empty anyway - interface com::sun::star::frame::XDocumentTemplates; + //------------------------------------------------------------------------- + /** implements a high level interface on top of an ucb content provider + which is used for template configuration + */ + interface XDocumentTemplates; }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1 2001/07/27 12:34:51 dv - #86311# Added for documentation purposes - - Revision 1.4 2001/04/13 20:26:41 arellano - revised plural and added question - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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/FeatureStateEvent.idl b/offapi/com/sun/star/frame/FeatureStateEvent.idl index 5b617cb5fc80..37dc7d226529 100644 --- a/offapi/com/sun/star/frame/FeatureStateEvent.idl +++ b/offapi/com/sun/star/frame/FeatureStateEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: FeatureStateEvent.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,92 +75,55 @@ module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: struct com::sun::star::frame::FeatureStateEvent /** This event is broadcast by a <type>Controller</type> whenever the state of - the feature changes. @see XController - @see XStatusListener + the feature changes + + @see XController + @see 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 <type>XDispatch</type> has to be requeried. + + <p> + Interest code should listen for <type>FrameActionEvents</type> + too, to update own feature states and dispatch listener on + <const>FrameAction::CONTEXT_CHANGED</const>. + </p> */ boolean Requery; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::frame::FeatureStateEvent::State /** contains the state of the feature in this dispatch. - <p>This can be, for example, simply <TRUE/> for a boolean feature like + <p> + This can be, for example, simply <TRUE/> for a boolean feature like underline on/off. Some simple types like <code>string</code> or <atom>boolean</atom> are useful here for generic UI elements, like - a checkmark in a menu.</p> - - <!-- Dennis: The <true> is appearing on the openoffice Web page. --> + a checkmark in a menu. + </p> */ any State; - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.6 2001/04/13 20:49:34 arellano - corrected tense and added comment - - Revision 1.5 2000/12/21 08:35:10 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.4 2000/12/14 12:53:37 mi - <true></true> -> <TRUE/> and same with FALSE - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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 index 3abdde00ce2b..c03cf97bdced 100644 --- a/offapi/com/sun/star/frame/Frame.idl +++ b/offapi/com/sun/star/frame/Frame.idl @@ -2,9 +2,9 @@ * * $RCSfile: Frame.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,6 +69,14 @@ #include <com/sun/star/frame/XDispatchProvider.idl> #endif +#ifndef __com_sun_star_frame_XDispatchRecorderSupplier_idl__ +#include <com/sun/star/frame/XDispatchRecorderSupplier.idl> +#endif + +#ifndef __com_sun_star_frame_XDispatchProviderInterception_idl__ +#include <com/sun/star/frame/XDispatchProviderInterception.idl> +#endif + #ifndef __com_sun_star_frame_XFramesSupplier_idl__ #include <com/sun/star/frame/XFramesSupplier.idl> #endif @@ -77,94 +85,127 @@ #include <com/sun/star/task/XStatusIndicatorFactory.idl> #endif +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#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. +/** represents the environment for a desktop component + + <p> + Frames are the anchors for the office components and they are the components' link + to the outside world. They create a skeleton for the whole office api infrastructure + by building frame hierarchys. These hierarchies contains all currently loaded + documents and make it possible to walk during these trees. + A special service <type>Desktop</type> can(!) combine different of such trees + to a global one which life time will be controlled by it. + </p> + + @see Desktop */ service Frame { - - - // DocMerge from xml: service com::sun::star::frame::Frame: interface com::sun::star::frame::XFrame + //------------------------------------------------------------------------- /** allows the component to be loaded and accessed - within the frame; it is the main connection to the - environment of the component. + within the frame; it is the main connection to the + environment of the component. */ - interface com::sun::star::frame::XFrame; + interface XFrame; + //------------------------------------------------------------------------- /** provides access to dispatchers for the frame. - <p>What kind of URLs a frame accepts in the calls to <method>XDispatchProvider::queryDispatch</method>, + <p> + What kind of URLs a frame accepts in the calls to <member>XDispatchProvider::queryDispatch()</member>, and how the returned dispatcher handles dispatches is completely implementation dependent - (though of course the restrictions of <type>XDispatchProvider</type> must be met).</p> - - <p>Frame implementations may (optionally) support special targets in the call to - <method>XDispatchProvider::queryDispatch</method>.</p> - - <p>Such special targets are passed as target frame name. They may, in addition, + (though of course the restrictions of <type>XDispatchProvider</type> must be met). + Frame implementations may (optionally) support special targets in the call to + <member>XDispatchProvider::queryDispatch()</member>. + Such special targets are passed as target frame name. They may, in addition, require special frame search flags (see <type>FrameSearchFlag</type>), or, in opposite, limit the set of allowed flags.<br> Common special targets include: <ul> <li><b>_blank</b> is used to create a new frame when dispatching the URL.</li> - <li><b>_self</b> forces the frame to dispatch the URL into itself.</li> + <li><b>_default</b> is used to recycle empty or create a new frame when dispatching the URL.</li> + <li><b>_self</b> forces the frame to dispatch the URL into itself. ("" means the same)</li> <li><b>_parent</b> dispatches the URL into the parent frame.</li> <li><b>_top</b> dispatches the URL into the top level frame, the frame where this is invoked belongs to.</li> - <li><b>_helpagent</b> dispatches the URL into the help agent window belonging to the frame.</li> </ul> </p> @see XDispatch + @see XFrame::findFrame() */ - interface com::sun::star::frame::XDispatchProvider; + interface XDispatchProvider; + //------------------------------------------------------------------------- + /** supports interception mechanism for dispatched URLs - // 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. + <p> + Registered objects can intercept, supress or deroute dispatched URLs. + If they support another interface too (<type>XInterceptorInfo</type>) + it's possible to perform it by directly calling of right interceptor without + using list of all registered ones. + </p> */ - [optional] interface com::sun::star::frame::XFramesSupplier; + interface XDispatchProviderInterception; + //------------------------------------------------------------------------- + /** provides access to sub frames within this frame + */ + interface XFramesSupplier; - // DocMerge from xml: service com::sun::star::frame::Frame: interface com::sun::star::task::XStatusIndicatorFactory - /** This optional interface supplies access to <type>XStatusIndicator</type>s - for the component within the frame. + //------------------------------------------------------------------------- + /** supplies access to <type scope="com::sun::star::task">XStatusIndicator</type> objects + for the component within the frame to show progresses */ [optional] interface com::sun::star::task::XStatusIndicatorFactory; + //------------------------------------------------------------------------- + /** if possible it sets/gets the UI title on/from the frame container window + + <p> + It depends from the type of the frame container window. If it is a system + task window all will be OK. Otherwise the title can't be set. + Setting/getting of the pure value of this property must be possible in every + case. Only showing on the UI can be fail. + </p> + */ + [property] string Title; + + //------------------------------------------------------------------------- + /** provides access to the dispatch recorder of the frame + + <p> + Such recorder can be used to record dispatch requests. + The supplier contains a dispatch recorder and provide the functionality + to use it for any dispatch object from outside which supports the interface + <type>XDispatch</type>. A supplier is available only, if recording was enabled. + That means: if somewhere whish to enable recoding on a frame he must set + a supplier with a recorder object inside of it. Every user of dispatches + has to check then if such supplier is available at this frame property. + If value of this property is <NULL/> he must call <member>XDispatch::dispatch()</member> + on the original dispatch object. If it's a valid value he must use the supplier + by calling his method <member>XDispatchRecordeSupplier::dispatchAndRecord()</member> + with the original dispatch object as argument. + </p> + + <p> + Note:<br> + It's not recommended to cache an already getted supplier. Because there exist + no possibility to check for enabled/disabled recording then. + </p> + */ + [property] XDispatchRecorderSupplier RecorderSupplier; }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2001/05/11 12:09:47 fs - added a rudimentary documentation to the XDispatchProvider interface (mainlyfor mentioning the _helpagent target) - - Revision 1.4 2001/01/23 10:08:25 mi - optional interfaces now marked as [optional] instead of just a prosa description of this fact - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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 index 88bb42dc6241..8700905cc5c9 100644 --- a/offapi/com/sun/star/frame/FrameAction.idl +++ b/offapi/com/sun/star/frame/FrameAction.idl @@ -2,9 +2,9 @@ * * $RCSfile: FrameAction.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,123 +67,119 @@ module com { module sun { module star { module frame { //============================================================================= +/** these are the events which can happen to the components in frames + of the desktop -// DocMerge from xml: enum com::sun::star::frame::FrameAction -/** These are the events which can happen to the components in frames - of the desktop. + <p> + Interest listener can get informations about loaded/realoed or unloaded + components into a <type>Frame</type>. + </p> + + @see XFrame + @see XFrameActionListener + @see FrameActionEvent */ enum FrameAction { //------------------------------------------------------------------------- + /** an event of this kind is broadcast whenever a component is + attached to a frame - // 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. - - <p>This is almost the same as the instantiation of the component + <p> + This is almost the same as the instantiation of the component within that frame. The component is attached to the frame - immediately before this event is broadcast.</p>@see XFrame::activated + immediately before this event is broadcast. + </p> + + @see XFrame::setComponent() */ COMPONENT_ATTACHED, //------------------------------------------------------------------------- + /** an event of this kind is broadcast whenever a component is + detaching from a frame - // 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. - - <p>This is quite the same as the destruction of the component + <p> + 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. </p> + + @see XFrame::setComponent() */ COMPONENT_DETACHING, //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::frame::FrameAction::COMPONENT_REATTACHED - /** An event of this kind is broadcast whenever a component is + /** an event of this kind is broadcast whenever a component is attached to a new model. - <p>In this case the component remains the same but operates - on a new model component.</p> + <p> + In this case the component remains the same but operates + on a new model component. + </p> */ COMPONENT_REATTACHED, //------------------------------------------------------------------------- + /** an event of this kind is broadcast whenever a component gets + activated - // DocMerge from xml: value com::sun::star::frame::FrameAction::FRAME_ACTIVATED - /** An event of this kind is broadcast whenever a component gets - activated. + <p> + Activations are broacast from the top component which was + not active before, down to the inner most component. + </p> - <p>Activations are broacast from the top component which was - not active before, down to the inner most component.</p>@see XFrame::activated + @see XFrame::activate() */ FRAME_ACTIVATED, //------------------------------------------------------------------------- + /** an event of this kind is broadcasted immediately before the + component is deactivated - // DocMerge from xml: value com::sun::star::frame::FrameAction::FRAME_DEACTIVATING - /** An event of this kind is broadcasted immediately before the - component is deactivated. - - <p>Deactivations are broadcast from the innermost component which + <p> + Deactivations are broadcast from the innermost component which does not stay active up to the outer most component which does not - stay active.</p> - @see XFrame::contextChanged + stay active. + </p> + + @see XFrame::deactivate() */ FRAME_DEACTIVATING, //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::frame::FrameAction::CONTEXT_CHANGED - /** An event of this kind is broadcast whenever a component changes + /** an event of this kind is broadcast whenever a component changes its internal context (i.e., the selection). - <p>If the activation status within a frame changes, this counts as + <p> + If the activation status within a frame changes, this counts as a context change too. </p> + + @see XFrame::contexChanged() */ 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 + /** an event of this kind is broadcast by an active frame when it is getting UI control (tool control). + + @see XFrame::activate() */ 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 + /** an event of this kind is broadcast by an active frame when it is losing UI control (tool control). + + @see XFrame::deactivate() */ FRAME_UI_DEACTIVATING - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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 index 30b1480c5587..31e2d8aa68a1 100644 --- a/offapi/com/sun/star/frame/FrameActionEvent.idl +++ b/offapi/com/sun/star/frame/FrameActionEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: FrameActionEvent.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,63 +73,31 @@ #include <com/sun/star/frame/FrameAction.idl> #endif - //============================================================================= module com { module sun { module star { module frame { //============================================================================= +/** this event struct is broadcast for actions which can happen to + components within frames -// DocMerge from xml: struct com::sun::star::frame::FrameActionEvent -/** This event struct is broadcast for actions which can happen to - components within frames. @see XFrameActionListener + @see 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. + /** contains the frame in which the event occured */ - com::sun::star::frame::XFrame Frame; + XFrame Frame; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::frame::FrameActionEvent::Action - /** specifies the concrete event. + /** specifies the concrete event */ - com::sun::star::frame::FrameAction Action; - + FrameAction Action; }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:10 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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 index f79edfe5a43d..e124fbda2af3 100644 --- a/offapi/com/sun/star/frame/FrameControl.idl +++ b/offapi/com/sun/star/frame/FrameControl.idl @@ -2,9 +2,9 @@ * * $RCSfile: FrameControl.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,77 +69,46 @@ #include <com/sun/star/beans/XPropertySet.idl> #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. - - <p>If the control is visible and has a valid (loadable) component URL, - then the <member>FrameControl::Frame</member> property is set.</p> +/** contains a frame with a desktop component + + <p> + If the control is visible and has a valid (loadable) component URL, + then the <member>FrameControl::Frame</member> property is set. + Normaly this control can be used for preview functionality inside + any UI. + </p> */ service FrameControl { - - - // DocMerge from xml: service com::sun::star::frame::FrameControl: service com::sun::star::awt::UnoControl - /** The base service of all controls. + //------------------------------------------------------------------------- + /** 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. + or the document which implicitly specifies the type */ [property] string ComponentUrl; //------------------------------------------------------------------------- + /** the frame held by this control - // DocMerge from xml: property com::sun::star::frame::FrameControl::Frame - /** The frame held by this control. The <type>Frame</type> is created if the control - is shown and the component's URL is set. + <p> + The <type>Frame</type> is created if the control + is shown and the <member>ComponentUrl</member> is set. + </p> */ - [readonly, property] string Frame; - + [property, readonly] string Frame; }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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 index 2b895deb6885..cebe39ad361f 100644 --- a/offapi/com/sun/star/frame/FrameLoader.idl +++ b/offapi/com/sun/star/frame/FrameLoader.idl @@ -2,9 +2,9 @@ * * $RCSfile: FrameLoader.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,56 +58,76 @@ * * ************************************************************************/ -#ifndef __com_sun_star_frame_Frame_idl__ -#define __com_sun_star_frame_Frame_idl__ +#ifndef __com_sun_star_frame_FrameLoader_idl__ +#define __com_sun_star_frame_FrameLoader_idl__ #ifndef __com_sun_star_frame_XFrameLoader_idl__ #include <com/sun/star/frame/XFrameLoader.idl> #endif +#ifndef __com_sun_star_lang_XInitialization_idl__ +#include <com/sun/star/lang/XInitialization.idl> +#endif + +#ifndef __com_sun_star_container_XNamed_idl__ +#include <com/sun/star/container/XNamed.idl> +#endif + //============================================================================= module com { module sun { module star { module frame { //============================================================================= +/** derivations of this abstract service are used to load components + into <type>Frame</type>s of the environment -// DocMerge from xml: service com::sun::star::frame::FrameLoader -/** Derivations of this abstract service are used to load components - into <type>Frame</type>s of the environment. - - <p>Concrete implementations of this service register, for example, + <p> + 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 <type>Controller</type>.</p> + components. The components loaded are at least <type>Controller</type>. + Instead of <type>SynchronousFrameLoader</type> this one use asynchronous + processes to load the component. + </p> - <!-- Dennis: Please reword the above paragraph -->*/ + @see SynchronousFrameLoader + */ service FrameLoader { - // DocMerge: empty anyway - interface com::sun::star::frame::XFrameLoader; + //------------------------------------------------------------------------- + /** support asynchronous loading of the component + */ + interface XFrameLoader; + + //------------------------------------------------------------------------- + /** support initialization of loader with its own configuration! + + <p> + Concrete implementations should use it to get her own configuration data + directly after creation by the <type>FrameLoaderFactory</type>. + Otherwhise they must use normal configuration api to do so. + </p> + */ + [optional] interface com::sun::star::lang::XInitialization; + + //------------------------------------------------------------------------- + /** provides access to the internal name of this frame loader + + <p> + The internal name is a part of his configuration and will be passed by + the <type>FrameLoaderFactory</type> after creation + if optional interface <type scope="com::sun::star::lang">XInitialization</type> + is supported. Value of function <member>XNamed::getName()</member> can be + used on service <type>FrameLoaderFactory</type> to get further informations about this loader. + Setting of this name by calling <member>XNamed::setName()</member> must be + forwarded to same factory service. He should decide, if it's allowed or not. + The reason: prevent code against name ambigities. + </p> + */ + [optional] interface com::sun::star::container::XNamed; }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2001/04/24 00:07:05 arellano - added comment - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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/FrameLoaderFactory.idl b/offapi/com/sun/star/frame/FrameLoaderFactory.idl index ea01c93f5e77..8cb95f7e73ae 100644 --- a/offapi/com/sun/star/frame/FrameLoaderFactory.idl +++ b/offapi/com/sun/star/frame/FrameLoaderFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: FrameLoaderFactory.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,44 +69,73 @@ #include <com/sun/star/container/XNameAccess.idl> #endif +#ifndef __com_sun_star_container_XContainerQuery_idl__ +#include <com/sun/star/container/XContainerQuery.idl> +#endif + //============================================================================= module com { module sun { module star { module frame { //============================================================================= - /** factory to create frame loader + + <p> + With this factory it's possible to + <ul> + <li>have access on configuration of set of registered frame laoder objects</li> + <li>create a frame laoder by his internal name</li> + <li>query for a frame laoder by using special query or property description.</li> + </ul> + </p> */ service FrameLoaderFactory { //------------------------------------------------------------------------- - /**interface to create the loader - <p> - After a <type>TypeDetection</type> you can use these interfaces to create the right loader to - load the document into a frame. Give it an internal type name and it creates a suitable - <type>XSynchronousFrameLoader</type> or <type>XFrameLoader</type> and returns it by calling - XMultiServiceFactory::createInstance...() - - casted to XInterface! Please check returned object for his supported interface! + /** interface to create loader objects by using his internal name - @attention Method XMultiServiceFactory::getAvailableServiceNames() isn't supported! - Please use XNameAcces of these service for access on loader configuration. + <p> + Returned objects must support the service specification of a <type>FrameLoader</type> + or <type>SynchronousFrameLoader</type>. (Note: last one will be prefered if both ones + are available) + They can be created by using of his internal name, which must be unambigous everytime, only. + To get this name use further specified interfaces of this factory for access on + the flat configuration. </p> */ interface com::sun::star::lang::XMultiServiceFactory; //------------------------------------------------------------------------- - /**readonly access to loader configuration + /** provides access to the whole frame loader configuration <p> - These interface support a readonly access to our internal configuration of all accessible loader. - The return value of XNameAccess::getByName() is a sequence<PropertyValue> packed in an Any!</p> -<pre> -Supported properties are: -<property name value type of property description/> -"Types" [sequence< string > ] loader is registered for these types -"UIName" [string ] localized name of loader to show it at UI -</pre> */ + This interface supports an access to the internal configuration of all accessible loader objects. + The return value of <member>XNameAccess::getByName()</member> is a property sequence packed in an any. + </p> + <table border=1> + <tr> + <td><b>Types<b></td> + <td>[string]</td> + <td>file types which loader is registered for</td> + </tr> + <tr> + <td><b>UIName<b></td> + <td>[string]</td> + <td>UI representable and localized name</td> + </tr> + </table> + */ interface com::sun::star::container::XNameAccess; + + //------------------------------------------------------------------------- + /** supports query mode for configuration access + + <p> + This interface can be used to get sub sets of current configuration entries + which represent given search parameters. + </p> + */ + interface com::sun::star::container::XContainerQuery; }; //============================================================================= diff --git a/offapi/com/sun/star/frame/FrameSearchFlag.idl b/offapi/com/sun/star/frame/FrameSearchFlag.idl index 826da8b70e22..da5274348d3c 100644 --- a/offapi/com/sun/star/frame/FrameSearchFlag.idl +++ b/offapi/com/sun/star/frame/FrameSearchFlag.idl @@ -2,9 +2,9 @@ * * $RCSfile: FrameSearchFlag.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:14 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,99 +67,98 @@ 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. +/** these types describe the algorithm to be used to search a frame + + <p> + Such flags will be used on methods <type>XFrame::findFrame()</type>, + <type>XDispatchProvider::queryDispatch()</type> or + <type>XComponentLoader::loadComponentFromURL()</type> if no special target + frame name (e.g. "_blank", "_self") is used. + </p> + + @see XFrame::findFrame() + @see XDispatchProvider::queryDispatch() + @see XComponentLoader::loadComponentFromURL() */ constants FrameSearchFlag { //------------------------------------------------------------------------- + /** no longer supported + + <p> + Using of this flag will do nothing. Use right combination of other flags + instead of this one. + </p> - // DocMerge from idl: value com::sun::star::frame::FrameSearchFlag::AUTO - /** SELF+CHILDREN + @deprecated */ const long AUTO = 0; //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::frame::FrameSearchFlag::PARENT - /** includes the parent frame + /** allows search on the parent frames */ const long PARENT = 1; //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::frame::FrameSearchFlag::SELF - /** includes the start frame + /** includes the start frame himself */ const long SELF = 2; //------------------------------------------------------------------------- + /** includes all child frames of the start frame - // DocMerge from idl: value com::sun::star::frame::FrameSearchFlag::CHILDREN - /** includes the child frames of the start frame - */ + <p> + Note: That means all direct children and of course her childrens too. + Search doesn't stop at the next level inside the tree! + </p> + */ 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; //------------------------------------------------------------------------- + /** includes the direct siblings of the start frame - // DocMerge from idl: value com::sun::star::frame::FrameSearchFlag::SIBLINGS - /** includes the other child frames of the parent of the start frame + <p> + Normaly it's interpreted as search on the direct childs of the parent + only. But in combination with e.g. the CHILDREN flag it can include all + children of it too. + </p> */ 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 + /** allow the search outside the current sub task tree of the whole possible frame tree + + <p> + If this flag isn't present, any search from bottom to top has to stop, if a top frame + will be reached. It doesn't influence a search from top to bottom. + But it can be used at the root of the frame tree to search on direct childrens of it only. + Because the direct children of the root node are the root's of the task sub trees, which + are top frames too. Instead of using the CHILDREN flag there, it's possible so to supress + a deeper search so. + </p> */ const long TASKS = 32; //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::frame::FrameSearchFlag::ALL - /** includes all frames except frames in other tasks + /** includes all frames except frames in other tasks sub trees + but doesn't create any new frame */ const long ALL = 23; //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::frame::FrameSearchFlag::GLOBAL - /** searches in the whole hierarchy of frames. + /** searches in the whole hierarchy of frames + but doesn't create any new frame */ 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 index fbdae66cd73e..19ef53c83cf4 100644 --- a/offapi/com/sun/star/frame/FramesContainer.idl +++ b/offapi/com/sun/star/frame/FramesContainer.idl @@ -2,9 +2,9 @@ * * $RCSfile: FramesContainer.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,55 +65,31 @@ #include <com/sun/star/frame/XFrames.idl> #endif -#ifndef __com_sun_star_container_XNameAccess_idl__ -#include <com/sun/star/container/XNameAccess.idl> -#endif - - //============================================================================= module com { module sun { module star { module frame { //============================================================================= +/** this is a special container which can contain frames -// DocMerge from xml: service com::sun::star::frame::FramesContainer -/** This is a special container which can contain frames. + <p> + All elements in this container support the service frame. + Implementations of this service are available by interface + <type>XFramesSupplier</type>. + </p> - <p>All elements in this container support the service frame. - </p>@see Frame + @see XFramesSupplier */ service FramesContainer { - // DocMerge: empty anyway - interface com::sun::star::frame::XFrames; - - // DocMerge: empty anyway - interface com::sun::star::container::XNameAccess; - + //------------------------------------------------------------------------- + /** access to frame collection by reference + */ + interface XFrames; }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:10 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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 index 44cc2c1652e2..4d6258101410 100644 --- a/offapi/com/sun/star/frame/MediaTypeDetectionHelper.idl +++ b/offapi/com/sun/star/frame/MediaTypeDetectionHelper.idl @@ -2,9 +2,9 @@ * * $RCSfile: MediaTypeDetectionHelper.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,19 +70,19 @@ module com { module sun { module star { module frame { //============================================================================= - - -// DocMerge from xml: service com::sun::star::frame::MediaTypeDetectionHelper -/** provides for mapping a given sequence of ContentIdentifierStrings - to a sequence of respective MediaTypes. +/** provides for mapping a given sequence of content identifier strings + to a sequence of respective media (mime) types */ service MediaTypeDetectionHelper { - - // DocMerge from xml: service com::sun::star::frame::MediaTypeDetectionHelper: interface com::sun::star::util::XStringMapping - /** provides a mapping from <atom>string<atom> to <atom>string<atom>. - - This interface is required. + //------------------------------------------------------------------------- + /** provides a mapping from <atom>string<atom> to <atom>string<atom> + + <p> + Order of given and their returned coressponding strings is important. + Don't pack or optimize it. Every item of [in] list must match + to an item of [out] list. + </p> */ interface com::sun::star::util::XStringMapping; }; @@ -91,23 +91,5 @@ service MediaTypeDetectionHelper }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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/ProtocolHandler.idl b/offapi/com/sun/star/frame/ProtocolHandler.idl index 641b61ed6b18..ca54a618f3d8 100644 --- a/offapi/com/sun/star/frame/ProtocolHandler.idl +++ b/offapi/com/sun/star/frame/ProtocolHandler.idl @@ -2,9 +2,9 @@ * * $RCSfile: ProtocolHandler.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: as $ $Date: 2002-09-05 11:31:11 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/offapi/com/sun/star/frame/Settings.idl b/offapi/com/sun/star/frame/Settings.idl index 414b77e99175..61c32ccb996f 100644 --- a/offapi/com/sun/star/frame/Settings.idl +++ b/offapi/com/sun/star/frame/Settings.idl @@ -2,9 +2,9 @@ * * $RCSfile: Settings.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:14 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,39 +65,20 @@ #include <com/sun/star/container/XNameAccess.idl> #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/SynchronousFrameLoader.idl b/offapi/com/sun/star/frame/SynchronousFrameLoader.idl index c66d72b2a363..b10450dccba0 100644 --- a/offapi/com/sun/star/frame/SynchronousFrameLoader.idl +++ b/offapi/com/sun/star/frame/SynchronousFrameLoader.idl @@ -2,9 +2,9 @@ * * $RCSfile: SynchronousFrameLoader.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: jsc $ $Date: 2001-11-09 09:22:40 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,8 +58,8 @@ * * ************************************************************************/ -#ifndef __com_sun_star_frame_SynchronousFrame_idl__ -#define __com_sun_star_frame_SynchronousFrame_idl__ +#ifndef __com_sun_star_frame_SynchronousFrameLoader_idl__ +#define __com_sun_star_frame_SynchronousFrameLoader_idl__ #ifndef __com_sun_star_frame_XSynchronousFrameLoader_idl__ #include <com/sun/star/frame/XSynchronousFrameLoader.idl> @@ -69,8 +69,8 @@ #include <com/sun/star/lang/XInitialization.idl> #endif -#ifndef __com_sun_star_beans_XPropertySet_idl__ -#include <com/sun/star/beans/XPropertySet.idl> +#ifndef __com_sun_star_container_XNamed_idl__ +#include <com/sun/star/container/XNamed.idl> #endif //============================================================================= @@ -78,75 +78,56 @@ module com { module sun { module star { module frame { //============================================================================= +/** derivations of this abstract service are used to load components + into <type>Frame</type>s of the environment -// DocMerge from xml: service com::sun::star::frame::SynchronousFrameLoader -/** Derivations of this abstract service are used to load components - into <type>Frame</type>s of the environment. - - <p>Concrete implementations of this service register, for example, + <p> + 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 <type>Controller</type>.</p> + components. The components loaded are at least <type>Controller</type>. + Instead of service <type>FrameLoader</type> this one use synchronous + processes to load the component. + </p> + + @see FrameLoader */ service SynchronousFrameLoader { //------------------------------------------------------------------------- - /**support synchron loading + /** support synchronous loading of component */ - interface com::sun::star::frame::XSynchronousFrameLoader; + interface XSynchronousFrameLoader; //------------------------------------------------------------------------- /** support initialization of loader with its own configuration! + <p> - A loader can support a readonly access to its own configuration. - But readonly properties couldn't be set ... - That's the reason for these interface! - All Anys of given sequence are from Type <type>PropertyValue</type>. + Concrete implementations should use it to get her own configuration data + directly after creation by the <type>FrameLoaderFactory</type>. + Otherwhise they must use normal configuration api to do so. </p> */ [optional] interface com::sun::star::lang::XInitialization; //------------------------------------------------------------------------- - /**readonly(!) access to loader configuration + /** provides access to the internal name of this frame loader + <p> - These interfaces support readonly access to our internal configuration of THIS loader. - The loader itself gets its configuration about <type>XInitialization</type> at creation by using - the <type>FrameLoaderFactory</type>! - </p> + The internal name is a part of his configuration and will be passed by + the <type>FrameLoaderFactory</type> after creation + if optional interface <type scope="com::sun::star::lang">XInitialization</type> + is supported. Value of function <member>XNamed::getName()</member> can be + used on service <type>FrameLoaderFactory</type> to get further informations about this loader. + Setting of this name by calling <member>XNamed::setName()</member> must be + forwarded to same factory service. He should decide, if it's allowed or not. + The reason: prevent code against name ambigities. + </p> */ - [optional] interface com::sun::star::beans::XPropertySet; - - /// loader is registered for these types - [optional, property, readonly] sequence< string > Types ; - - /// localized name of loader to show it at UI elements - [optional, property, readonly] string UIName ; + [optional] interface com::sun::star::container::XNamed; }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.2 2001/11/01 10:29:29 mi - proofreading and corrections from Richard Holt - - Revision 1.1 2000/11/20 10:06:11 as - new interfaces for filter and type detection - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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/TemplateAccess.idl b/offapi/com/sun/star/frame/TemplateAccess.idl index 7647907291a4..8d446d1e3836 100644 --- a/offapi/com/sun/star/frame/TemplateAccess.idl +++ b/offapi/com/sun/star/frame/TemplateAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: TemplateAccess.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,33 +69,37 @@ #include <com/sun/star/frame/XDocumentTemplates.idl> #endif - //============================================================================= module com { module sun { module star { module frame { //============================================================================= +/** provides a high level api to organize document templates -// DocMerge from xml: service com::sun::star::frame::TemplateAccess -/**specifies a collection of TemplateAccess. + <p> + AS_??? + One important instance of this service is available from the + <type>Desktop</type> object via the <type>XDesktop</type> interface. + </p> - <p>One important instance of this service is available from the - <type>Desktop</type> object via the <type>XDesktop</type> interface. </p> - @see com::sun::star::lang::XComponent - @see XDesktop + @see com::sun::star::lang::XComponent + @see XDesktop */ service TemplateAccess { - // DocMerge: empty anyway - interface com::sun::star::lang::XLocalizable; - // DocMerge: empty anyway - interface com::sun::star::frame::XDocumentTemplates; + //------------------------------------------------------------------------- + /** used to organize document templates + */ + interface XDocumentTemplates; + //------------------------------------------------------------------------- + /** + */ + interface com::sun::star::lang::XLocalizable; }; //============================================================================= }; }; }; }; - #endif diff --git a/offapi/com/sun/star/frame/TerminationVetoException.idl b/offapi/com/sun/star/frame/TerminationVetoException.idl index a3a3602866b0..26d70d553135 100644 --- a/offapi/com/sun/star/frame/TerminationVetoException.idl +++ b/offapi/com/sun/star/frame/TerminationVetoException.idl @@ -2,9 +2,9 @@ * * $RCSfile: TerminationVetoException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,16 +65,24 @@ #include <com/sun/star/uno/Exception.idl> #endif - //============================================================================= module com { module sun { module star { module frame { //============================================================================= +/** can be thrown by a <type>XTerminateListener</type> to prevent the environment + (e.g., desktop) from terminating + + <p> + If a <type>XTerminateListener</type> use this exception for a veto against + the termination of the office, he will be the new "owner" of it. + After his own operation will be finished, he MUST try to terminate the + office again. Any other veto listener can intercept that again or office + will die realy. + </p> -// DocMerge from xml: exception com::sun::star::frame::TerminationVetoException -/** This exception can be thrown to prevent the environment (e.g., desktop) - from terminating. + @see XDesktop::terminate() + @see XTerminateListener */ exception TerminationVetoException: com::sun::star::uno::Exception { @@ -84,21 +92,4 @@ exception TerminationVetoException: com::sun::star::uno::Exception }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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 index 0a7513df488f..5bf61f90111c 100644 --- a/offapi/com/sun/star/frame/WindowArrange.idl +++ b/offapi/com/sun/star/frame/WindowArrange.idl @@ -2,9 +2,9 @@ * * $RCSfile: WindowArrange.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:14 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -61,84 +61,48 @@ #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. +/** 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. + /** arranges the windows in tiles */ const short TILE = 1; //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::frame::WindowArrange::VERTICAL - /** arranges the windows vertically. + /** arranges the windows vertically */ const short VERTICAL = 2; //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::frame::WindowArrange::HORIZONTAL - /** arranges the windows horizontally. + /** arranges the windows horizontally */ const short HORIZONTAL = 3; //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::frame::WindowArrange::CASCADE - /** cascades the windows. + /** cascades the windows */ const short CASCADE = 4; //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::frame::WindowArrange::MAXIMIZE - /** maximizes all windows. + /** maximizes all windows */ const short MAXIMIZE = 5; //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::frame::WindowArrange::MINIMIZE - /** minimizes all windows. + /** 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 index 44ca44240fa7..1df4306f2df4 100644 --- a/offapi/com/sun/star/frame/XBrowseHistoryRegistry.idl +++ b/offapi/com/sun/star/frame/XBrowseHistoryRegistry.idl @@ -2,9 +2,9 @@ * * $RCSfile: XBrowseHistoryRegistry.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,51 +75,26 @@ module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: interface com::sun::star::frame::XBrowseHistoryRegistry /** @deprecated */ interface XBrowseHistoryRegistry: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge: empty anyway + /** @deprecated + */ [oneway] void updateViewData( [in] any Value ); //------------------------------------------------------------------------- - - // DocMerge: empty anyway - [oneway] void createNewEntry( [in] string aURL, - [in] sequence<com::sun::star::beans::PropertyValue> aArgs, - [in] string aTitle ); - + /** @deprecated + */ + [oneway] void createNewEntry( + [in] string URL, + [in] sequence<com::sun::star::beans::PropertyValue> Arguments, + [in] string Title); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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 index 3225d4d0724e..9398a88602e4 100644 --- a/offapi/com/sun/star/frame/XComponentLoader.idl +++ b/offapi/com/sun/star/frame/XComponentLoader.idl @@ -2,9 +2,9 @@ * * $RCSfile: XComponentLoader.idl,v $ * - * $Revision: 1.11 $ + * $Revision: 1.12 $ * - * last change: $Author: as $ $Date: 2001-11-20 14:05:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -87,98 +87,140 @@ module com { module sun { module star { module frame { //============================================================================= +/** this is a simple interface to load components by an URL into a + frame environment -// 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 Desktop - @see Frame - @see XFrame + @see Desktop + @see Frame + @see XFrame */ 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. - @param aURL - specifies the URL of the document to load. To create new documents, - use "private:factory/scalc", "private:factory/swriter", etc. + @param URL + specifies the URL of the document to load + + <p> + To create new documents, use "private:factory/scalc", "private:factory/swriter", etc. + Other special protocols (e.g. "slot:", ".uno") are not allowed and raise + an <type scope="com::sun::star::lang">IllegalArgumentException</type>. + </p> + + @param TargetFrameName + specifies the name of the frame to view the document in + + <p> + If a frame with the specified name already exists, it is used, otherwise it + is created. There exist some special targets which never can be used + as real frame names: + <table border=1> + <tr> + <td><strong>"_blank"</strong></td> + <td>always creates a new frame</td> + </tr> + <tr> + <td><strong>"_default"</strong></td> + <td>recycle empty frame or create new one</td> + </tr> + <tr> + <td><strong>"_self", ""(!)</strong></td> + <td>means frame himself</td> + </tr> + <tr> + <td><strong>"_parent"</strong></td> + <td>address direct parent of frame</td> + </tr> + <tr> + <td><strong>"_top"</strong></td> + <td>indicates top frame of current path in tree</td> + </tr> + <tr> + <td><strong>"_beamer"</strong></td> + <td>means special sub frame</td> + </tr> + </table> + + @param SearchFlags + use the values of <type>FrameSearchFlag</type> to specify + how to find the specified <var>TargetFrameName</var> - @param aTargetFrameName - specifies the name of the frame to view the document in. If a frame - with the specified name already exists, it is used, otherwise it - is created. "_blank" always creates a new frame, "_self" means frame himself, - "_parent" address direct parent of frame, "_top" indicates top frame of - current path in tree. + <p> + Note: These flags are optional ones and will be used for non special + target names only. + </p> - @param nSearchFlags - use the values of <type>FrameSearchFlag</type> to specify - how to find the specified <var>aTargetFrameName</var>. - Normally, simply use <code>0</code>. + @param Arguments + these arguments specify component or filter specific behavior - @param aArgs - these arguments specify component or filter specific behavior. + <p> For example, "ReadOnly" with a boolean value specifies whether the document is opened read-only. "FilterName" specifies the component type to create and the filter to use, for example: - "scalc: Text - csv". For more information see + "Text - CSV". For more information see <type scope="com::sun::star::document">MediaDescriptor</type>. + </p> + + @return + a <type scope="com::sun::star::lang">XComponent</type> for successfully loaded + documents or + <br> + <NULL/>if it failed + + <p> + This interface is a generic one and can be used to start further requests on + loaded document or control the lifetime of it (means dispose() it after using). + The real document service behind this interface can be one of follow three ones: + <ul> + <li> + <type scope="com::sun::star::awt">XWindow</type> for simple components<br/> + Should be used for viewable components only. It is not allowed to dispose + it after use directly, because the frame containing the component is its owner. + Because the frame object is not accessible through the interface too, + only an interacting user can do this by closing the frames' window. + </li> + <li> + <type>XController</type> for richer components<br/> + Should be used for real editable components which doesn't need a model. + It is not allowed to dispose it after use directly, because the frame + containing the component is its owner. Here the object can be disposed + by disposing the frame, that the <member>XController::getFrame()</member> + method of the controller returns. But for visible components the controller + should be asked for permission by calling <member>XController::suspend()</member> before. + </li> + <li> + <type>XModel</type> for full featured components<br/> + A model that in general can be shared between several view/controller pairs, + does not have an explicit owner. Every view and also the component that + loaded the document may consider itself as an owner. + Simply calling <member>XComponent::dispose()</member> on this model may + cause problems, if some members of the "owner community" are currently + busy working on the model. These problems are handled by explicit closing + negotiations through the interface <type scope="com::sun::star::util">XCloseable</type>. + Direct dispose of the model is allowed only, if this special interface doesn't exist. + </li> + </ul> + </p> + + @throws com::sun::star::io::IOException + when <var>URL</var> couldn't be found or was corrupt + + @throws com::sun::star::lang::IllegalArgumentException + when given parameters doesn't perform the specification */ - com::sun::star::lang::XComponent loadComponentFromURL( [in] string aURL, - [in] string aTargetFrameName, - [in] long nSearchFlags, - [in] sequence<com::sun::star::beans::PropertyValue> aArgs ) - raises( com::sun::star::io::IOException, - com::sun::star::lang::IllegalArgumentException ); - + com::sun::star::lang::XComponent loadComponentFromURL( + [in] string URL, + [in] string TargetFrameName, + [in] long SearchFlags, + [in] sequence<com::sun::star::beans::PropertyValue> Arguments) + raises( com::sun::star::io::IOException, + com::sun::star::lang::IllegalArgumentException ); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.10 2001/11/01 10:29:29 mi - proofreading and corrections from Richard Holt - - Revision 1.9 2001/03/22 17:25:56 mi - #77161# arguments of XComponentLoader::loadComponents - - Revision 1.8 2001/03/16 16:41:25 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.7 2000/12/21 15:04:54 mi - typo fixed: FrameSearchFlags now without s at the end - - Revision 1.6 2000/12/21 15:03:56 mi - typo fixed: FrameSearchFlagsy now without y at the end - - Revision 1.5 2000/12/21 08:35:10 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.4 2000/12/12 12:27:50 mi - documentation for arguments added - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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 index 5af553556dc9..108b372d04ff 100644 --- a/offapi/com/sun/star/frame/XComponentRegistry.idl +++ b/offapi/com/sun/star/frame/XComponentRegistry.idl @@ -2,9 +2,9 @@ * * $RCSfile: XComponentRegistry.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,54 +75,20 @@ module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: interface com::sun::star::frame::XComponentRegistry -/** makes it possible to instantiate desktop components. - - @deprecated - @see XFrame +/** @deprecated */ 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 ); - + /** @deprecated + */ + com::sun::star::uno::XInterface createObject( + [in] string URL, + [in] com::sun::star::uno::Uik Uik ); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2001/03/22 17:26:29 mi - Formatting error in documentation fixed - - Revision 1.4 2001/03/16 16:41:25 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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 index 7731cc39eb61..716d24e510ba 100644 --- a/offapi/com/sun/star/frame/XConfigManager.idl +++ b/offapi/com/sun/star/frame/XConfigManager.idl @@ -2,9 +2,9 @@ * * $RCSfile: XConfigManager.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,47 +77,71 @@ module frame { //============================================================================ - -// DocMerge from xml: interface com::sun::star::frame::XConfigManager /** @deprecated */ 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" + /** add a listener to notify changes on well known variables + inside the real implementation - <p> If <var>sKeyName</var> specifies a group of keys, the listener gets one notify for each subkey.</p> - */ - [oneway] void addPropertyChangeListener( [in] string sKeyName, [in] com::sun::star::beans::XPropertyChangeListener xListener ) ; + <p> + Listener can update his text values by calling <member>XConfigManager::substituteVariables()</member> + again. If <var>KeyName</var> specifies a group of keys, the listener gets one notify for each subkey. + </p> - //------------------------------------------------------------------------- + @param KeyName + specifies variable about listener will be informed on changes + @param Listener + listener which will be informed - // 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 ) ; + @see XConfigManager::removePropertyChangeListener() + + @deprecated + */ + [oneway] void addPropertyChangeListener( + [in] string KeyName, + [in] com::sun::star::beans::XPropertyChangeListener Listener ); //------------------------------------------------------------------------- + /** remove a registered listener + @param KeyName + specifies variable on which listener was registered - // DocMerge from xml: method com::sun::star::frame::XConfigManager::substituteVariables - /** substitute variables in "sText" + @param Listener + listener which will be deregistered + @see XConfigManager::addPropertyChangeListener() - <p> - The value of "sText" is NOT changed.</p> + @deprecated */ - string substituteVariables( [in] string sText ) ; + [oneway] void removePropertyChangeListener( + [in] string KeyName, + [in] com::sun::star::beans::XPropertyChangeListener Listener); //------------------------------------------------------------------------- + /** substitute variables (place holder) inside given parameter <var>Text</var> + + <p> + The value of <var>Text</var> is NOT changed. + </p> + @param Text + original value including variables - // DocMerge from xml: method com::sun::star::frame::XConfigManager::flush - /** write data of INI-file to disk + @return + changed copy of <var>Text</var> without any variables + */ + string substituteVariables( [in] string Text ); + + //------------------------------------------------------------------------- + /** was designed for additional functionality for interface <type scope="com::sun::star::registry">XSimpleRegistry</type> + and make no sense without that + @deprecated */ - [oneway] void flush() ; + [oneway] void flush(); }; //XConfigManager }; //frame diff --git a/offapi/com/sun/star/frame/XController.idl b/offapi/com/sun/star/frame/XController.idl index 54f9e734b2a9..766b5f31b78e 100644 --- a/offapi/com/sun/star/frame/XController.idl +++ b/offapi/com/sun/star/frame/XController.idl @@ -2,9 +2,9 @@ * * $RCSfile: XController.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,101 +73,87 @@ interface XFrame; interface XModel; //============================================================================= - -// DocMerge from xml: interface com::sun::star::frame::XController /** With this interface, components viewed in a <type>Frame</type> can serve - events (by supplying dispatches). @see XModel - @see XFrame - @see com::sun::star::awt::XWindow + events (by supplying dispatches). + + @see XFrame + @see com::sun::star::awt::XWindow + @see XModel */ 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. + + @param Frame + the new owner frame of this controller */ - void attachFrame( [in] XFrame xFrame ); + void attachFrame( [in] XFrame Frame ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XController::attachModel /** is called to attach the controller to a new model. + + @param Model + the new model for this controller + + @return + <TRUE/>if attach was successfully + <br> + <FALSE/>otherwise */ - boolean attachModel( [in] XModel xModel ); + boolean attachModel( [in] XModel Model ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XController::suspend /** is called to prepare the controller for closing the view + + @param Suspend + <TRUE/>force the controller to suspend his work + <FALSE/>try to reactivate the controller + + @return + <TRUE/>if request was accepted and of course successfully finished + <br> + <FALSE/>otherwise */ - boolean suspend( [in] boolean bSuspend ); + boolean suspend( [in] boolean Suspend ); //------------------------------------------------------------------------- + /** provides access to current view status - // DocMerge from idl: method com::sun::star::frame::XController::getViewData - /** @returns - data that can be used to restore the current view status. + @returns + set of data that can be used to restore the current view status + at later time by using <member>XController::restoreViewData()</member> */ 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 - <member>XController::getViewData</member>. + <member>XController::getViewData()</member>. + + @param Data + set of data to restore it */ void restoreViewData( [in] any Data ); //------------------------------------------------------------------------- + /** provides access to currently attached model - // DocMerge from idl: method com::sun::star::frame::XController::getModel - /** @returns - the currently attached model. + @returns + the currently attached model. */ XModel getModel(); //------------------------------------------------------------------------- + /** provides access to owner frame of this controller - // DocMerge from idl: method com::sun::star::frame::XController::getFrame - /** @returns - the frame containing this controller. + @returns + the frame containing this controller. */ XFrame getFrame(); - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2001/03/16 16:41:25 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.4 2000/12/21 08:35:10 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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 index cb8da4088b2a..8e65b06a6189 100644 --- a/offapi/com/sun/star/frame/XDesktop.idl +++ b/offapi/com/sun/star/frame/XDesktop.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDesktop.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -87,125 +87,113 @@ 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. - <p>A desktop is an environment for components which can be viewed in + <p> + 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. + </p> - </p>@see Desktop + @see Desktop */ interface XDesktop: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XDesktop::terminate /** tries to terminate the desktop. - <p>First, a vetoable queryTermination-event is broadcast. If no - TerminationVetoException was thrown, a notifyTermination-event is - broadcast and <TRUE/> will be returned; otherwise an - abortTermination-event is broadcast and <FALSE/> will be returned. - </p>@see com::sun::star::frame::TerminationVetoException - @see XTerminateListener + <p> + First, every terminate listener is called by his <member>XTerminateListener::queryTermination()</member> method. + Throwing of a <type>TerminationVetoException</type> can break the termination process and the listener how has + done that will be the new "controller" of the desktop lifetime. He should try to terminate it by himself after + his own processes will be finished. + If nobody disagree with the termination request, every listener will be called by his + <member>XTerminateListener::notifyTermination()</member> method. + </p> + + @return + <TRUE/>if all listener agree with this request + <br> + <FALSE/>otherwise + + @see XTerminateListener + @see TerminationVetoException */ 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 ); - //------------------------------------------------------------------------- + @param Listener + listener for termination events - // DocMerge from xml: method com::sun::star::frame::XDesktop::removeTerminateListener - /** unregisters an event listener which was registered with - <member>XDesktop::addTerminateListener</member>. + @see XDesktop::removeTerminateListener() */ - [oneway] void removeTerminateListener( [in] com::sun::star::frame::XTerminateListener xListener ); + [oneway] void addTerminateListener( [in] XTerminateListener Listener ); //------------------------------------------------------------------------- + /** unregisters an event listener for termination events. - // DocMerge from idl: method com::sun::star::frame::XDesktop::getComponents - /** @returns - a collection of all components which are loaded into a frame. - - <p>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. + @param Listener + listener which wish to be deregistered - <p>The service, <type>Components</type>, 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 XDesktop::addTerminateListener() + */ + [oneway] void removeTerminateListener( [in] XTerminateListener Listener ); - @see Components + //------------------------------------------------------------------------- + /** provides read access to collection of all currently loaded components + inside the frame tree + + <p> + 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 <type>Components</type> which is available from this + method is a collection of all components of the desktop which are open + within a frame of the desktop. + </p> + + @returns + the collection of all components + + @see Components */ com::sun::star::container::XEnumerationAccess getComponents(); //------------------------------------------------------------------------- + /** provides read access to the component inside the tree which has the UI focus + + <p> + Normally, the component is the model part of the + active component. If no model exists it is the active controller + (view) itself. + </p> - // DocMerge from idl: method com::sun::star::frame::XDesktop::getCurrentComponent - /** @returns - the component within the desktop environment which has the UI focus. + @returns + the component within the desktop environment which has the UI focus. - <p>Normally, the component is the model part of the - active component. If no model exists it is the active controller - (view) itself. + @see XDesktop::getCurrentFrame() */ com::sun::star::lang::XComponent getCurrentComponent(); //------------------------------------------------------------------------- + /** provides read access to the frame wich contains the current component - // 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. - */ - com::sun::star::frame::XFrame getCurrentFrame(); + @returns + the frame of the component which has the + UI focus within this desktop enviroment + @see XDesktop::getCurrentComponent() + */ + XFrame getCurrentFrame(); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.6 2001/03/16 16:41:25 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.5 2000/12/21 08:35:10 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.4 2000/12/14 12:53:37 mi - <true></true> -> <TRUE/> and same with FALSE - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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 index 1721b2094541..f7cac5ae4461 100644 --- a/offapi/com/sun/star/frame/XDesktopTask.idl +++ b/offapi/com/sun/star/frame/XDesktopTask.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDesktopTask.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,53 +75,28 @@ 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. +/** use <type>XFrame</type> instead of this + @deprecated */ interface XDesktopTask: com::sun::star::lang::XComponent { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XDesktopTask::initialize - /** attaches a window to the task. + /** use <type scope="com::sun::star::lang">XInitialization</type> instead of this + @deprecated */ - void initialize( [in] com::sun::star::awt::XWindow xTaskWindow ); + void initialize( [in] com::sun::star::awt::XWindow TaskWindow ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XDesktopTask::close - /** tries to close all windows within the task and the task by itself. + /** use <type scope="com::sun::star::util">XClosable</type> + or <member scope="com::sun::star::lang">XComponent::dispose()</member> + instead of this + @deprecated */ boolean close(); - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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 index 305145eaae63..2dc0866cadc1 100644 --- a/offapi/com/sun/star/frame/XDispatch.idl +++ b/offapi/com/sun/star/frame/XDispatch.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDispatch.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,109 +83,114 @@ 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). - <p>Each state change is to be broadcast to all registered + <p> + Each state change is to be broadcast to all registered status listeners. The first notification should be performed - synchronously from <member>XDispatch::addStatusListener</member>; + synchronously from <member>XDispatch::addStatusListener()</member>; if not, controllers may flicker. State listener must be aware of this - synchronous notification.</p> + synchronous notification. + </p> - <p>The state consists of enabled/disabled and a short descriptive text + <p> + 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 re-get 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 <type>XDispatch</type>.</p> + to force the state listener to requery the <type>XDispatch</type>. + </p> - @see StatusEvent - @see Frame - @see View + @see Frame + @see FeatureStateEvent */ interface XDispatch: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XDispatch::dispatch /** dispatches (executes) an URL asynchronously. - <p>It is only allowed to dispatch URLs for which this <type>XDispatch</type> - was explicitely queried. Additional arguments "'#..." or "?...") are allowed.</p> + <p> + It is only allowed to dispatch URLs for which this <type>XDispatch</type> + was explicitely queried. Additional arguments "'#..." or "?...") are allowed. + </p> + + @param URL + full parsed URL wich describe the feature which should be dispatched (executed) + + @param Arguments + optional arguments for this request + They depends from the real implementation of the dipsatch object. @example - <listing> - // some code for a click-handler of a hyperlink in a view - XFrame xTargetFrame = m_xFrame-&gt;findFrame( - m_aHyperlink-&gt;getTargetFrameName(), FRAME_SEARCH_STANDARD ); - URL aURL; - aURL.Original = m_aHyperlink-&gt;getURL(); - XDispatch m_xFrame-&gt;queryDispatch( aURL, sequence&lt;PropertyValue&gt;() ); - xDispatch-&gt;dispatch( aURL ); - </listing> + <listing> + // some code for a click-handler + void <strong>myOnClick</strong>(<em>String</em> sURL,<em>String</em> sTargetFrame,<em>com.sun.star.beans.PropertyValue[]</em> lArguments) + { + com.sun.star.util.URL[] aURL = new com.sun.star.util.URL[1]; + aURL[0] = new com.sun.star.util.URL(); + aURL[0].Complete = sURL; + + com.sun.star.util.XURLTransformer xParser = (com.sun.star.util.XURLTransformer)UnoRuntime.queryInterface(com.sun.star.util.XURLTransformer.class, mxServiceManager.createInstance("com.sun.star.util.URLTransformer")); + + xParser->parseStrict(aURL); + + com.sun.star.frame.XDispatch xDispatcher = mxFrame.queryDispatch(aURL[0], sTargetFrame, com.sun.star.frame.FrameSearchFlag.GLOBAL); + + if(xDispatcher!=null) + xDispatcher.dispatch(aURL[0], lArguments); + } + </listing> */ - [oneway] void dispatch( [in] com::sun::star::util::URL aURL, - [in] sequence<com::sun::star::beans::PropertyValue> aArgs ); + [oneway] void dispatch( + [in] com::sun::star::util::URL URL, + [in] sequence<com::sun::star::beans::PropertyValue> Arguments); //------------------------------------------------------------------------- - - // 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. - <p>It is only allowed to register for URLs for which this <type>XDispatch</type> - was explicitely queried. Additional arguments ("#..." or "?...") will be ignored.</p> + <p> + It is only allowed to register for URLs for which this <type>XDispatch</type> + was explicitely queried. Additional arguments ("#..." or "?...") will be ignored. + Note: Notifications can't be guranteed! This will be a part of interface <type>XNotifyingDispatch</type>. + </p> + + @param Control + listener which wish to be informed - @see XDispatch::removeStatusListener + @param URL + the URL (without additional arguments) for which the listener wish to be registered + So a listener can be registered for more then one URLs at the same time. + + @see XStatusListener + @see XDispatch::removeStatusListener() */ - [oneway] void addStatusListener( [in] com::sun::star::frame::XStatusListener xControl, - [in] com::sun::star::util::URL aURL ); + [oneway] void addStatusListener( + [in] XStatusListener Control, + [in] com::sun::star::util::URL URL); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XDispatch::removeStatusListener /** unregisters a listener of a controller. - @see Dispatch::addStatusListener - */ - [oneway] void removeStatusListener( [in] com::sun::star::frame::XStatusListener xControl, - [in] com::sun::star::util::URL aURL ); + @param Control + listener which wish to be unregistered + @param URL + the URL for which the listener was registered + Additional arguments ("#..." or "?...") will be ignored. + + @see XStatusListener + @see XDispatch::addStatusListener() + */ + [oneway] void removeStatusListener( + [in] XStatusListener Control, + [in] com::sun::star::util::URL URL); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.6 2001/03/16 16:41:25 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.5 2000/12/19 16:03:30 mi - documentations syntax errors fixed - - Revision 1.4 2000/12/19 13:37:15 mi - syntax errors in documentation fixed - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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 index 5f1bee3d1a73..badcaee4d81c 100644 --- a/offapi/com/sun/star/frame/XDispatchProvider.idl +++ b/offapi/com/sun/star/frame/XDispatchProvider.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDispatchProvider.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,70 +83,61 @@ module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: interface com::sun::star::frame::XDispatchProvider /** provides <type>XDispatch</type> interfaces for certain functions which are useful at the UI. + + @see XDispatch */ interface XDispatchProvider: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XDispatchProvider::queryDispatch /** searches for an <type>XDispatch</type> 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. - - <p>Actually this method is redundant to - <member>XDispatchProvider::queryDispatch</member> to avoid multiple - remote calls. - */ - sequence<com::sun::star::frame::XDispatch> queryDispatches( - [in] sequence<com::sun::star::frame::DispatchDescriptor> aDescripts ); - -}; + the specified target frame. -//============================================================================= + @param URL + describe the feature which should be supported by returned dispatch object -}; }; }; }; + @param TargetFrameName + specify the frame which should be the target for this request -/*============================================================================= + @param SearchFlags + optional search parameter for finding the frame if no special + <var>TargetFrameName</var> was used - $Log: not supported by cvs2svn $ - Revision 1.5 2001/03/16 16:41:25 jsc - remove interfaceheader with uik and remove [const] in method definitions + @return + the dispatch object which provides queried functionality + <br> + or <NULL/> if no dispatch object is available - Revision 1.4 2000/12/19 16:03:30 mi - documentations syntax errors fixed - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api + @see XFrame::findFrame() + @see XDispatchProvider::queryDispatches() + */ + XDispatch queryDispatch( + [in] com::sun::star::util::URL URL, + [in] string TargetFrameName, + [in] long SearchFlags ); - Revision 1.1.1.1 2000/09/18 23:35:21 hjs - initial import + //------------------------------------------------------------------------- + /** actually this method is redundant to <member>XDispatchProvider::queryDispatch()</member> + to avoid multiple remote calls. - Revision 1.7 2000/09/11 11:52:28 mi - documentation merged from XML + @param Requests + list of dispatch requests - Revision 1.3 2000/02/23 14:49:56 mi - missing documentations + @returns + multiple dispatch interfaces for the specified descriptors at once - Revision 1.2 2000/01/31 09:44:58 mi - XML syntax for documentation + <p> + It's not allowed to pack it - because every request must match + to his real result. Means: don't delete <NULL/> entries inside this list. + </p> + */ + sequence< XDispatch > queryDispatches( + [in] sequence<DispatchDescriptor> Requests); +}; - 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 index 814159b21a27..bf6a7e4ee213 100644 --- a/offapi/com/sun/star/frame/XDispatchProviderInterception.idl +++ b/offapi/com/sun/star/frame/XDispatchProviderInterception.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDispatchProviderInterception.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,56 +75,50 @@ module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: interface com::sun::star::frame::XDispatchProviderInterception /** makes it possible to register an <type>XDispatchProvider</type> which intercepts all requests of <type>XDispatch</type> to this instance. + + <p> + Note: Nobody can guarantee order of used interceptor objects if more then ones exist. + Later registered ones will be used at first. But it's possible to increase the chance + for that by providing the optional interface <type>XInterceptorInfo</type>. + </p> + + @see XDispatchProvider + @see XDispatch + @see XInterceptorInfo */ interface XDispatchProviderInterception: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XDispatchProviderInterception::registerDispatchProviderInterceptor /** registers an <type>XDispatchProviderInterceptor</type>, which will become the first interceptor in the chain of registered interceptors. + + @param Interceptor + the interceptor which whish to be registered + + @see XDispatchProviderInterception::releaseDispatchProviderInterceptor() */ - void registerDispatchProviderInterceptor( [in] com::sun::star::frame::XDispatchProviderInterceptor xInterceptor ); + void registerDispatchProviderInterceptor( [in] XDispatchProviderInterceptor Interceptor ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XDispatchProviderInterception::releaseDispatchProviderInterceptor /** removes an <type>XDispatchProviderInterceptor</type> which was previously registered - using <member>XDispatchProviderInterception::registerDispatchProviderInterceptor</member>. - <p>The order of removals is arbitrary. It is not necessary to remove the last - registered interceptor first.</p> - */ - void releaseDispatchProviderInterceptor( [in] com::sun::star::frame::XDispatchProviderInterceptor xInterceptor ); + <p> + The order of removals is arbitrary. It is not necessary to remove the last + registered interceptor first. + </p> + + @param Interceptor + the interceptor which whish to be unregistered + @see XDispatchProviderInterception::registerDispatchProviderInterceptor() + */ + void releaseDispatchProviderInterceptor( [in] XDispatchProviderInterceptor Interceptor ); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/11 17:11:00 mi - broken member-link fixed - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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 index 6341d1c43ef3..524dd8b77128 100644 --- a/offapi/com/sun/star/frame/XDispatchProviderInterceptor.idl +++ b/offapi/com/sun/star/frame/XDispatchProviderInterceptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDispatchProviderInterceptor.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,49 +71,59 @@ module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: interface com::sun::star::frame::XDispatchProviderInterceptor /** makes it possible to intercept request of <type>XDispatch</type>. + + <p> + Can be registered as an interceptor by using interface <type>XDispatchProviderInterception</type>. + </p> + + @see XDispatchProviderInterception */ -interface XDispatchProviderInterceptor: com::sun::star::frame::XDispatchProvider +interface XDispatchProviderInterceptor: XDispatchProvider { //------------------------------------------------------------------------- + /** access to the slave <type>XDispatchProvider</type> of this interceptor - // DocMerge from idl: method com::sun::star::frame::XDispatchProviderInterceptor::getSlaveDispatchProvider - /** @returns - the slave <type>XDispatchProvider</type> to which calls to - <member>XDispatchProvider::queryDispatch</member> can be forwarded - under control of this dispatch provider. + @returns + the slave of this interceptor + + @see XDispatchProviderInterceptor::setSlaveDispatchProvider() */ - com::sun::star::frame::XDispatchProvider getSlaveDispatchProvider(); + XDispatchProvider getSlaveDispatchProvider(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XDispatchProviderInterceptor::setSlaveDispatchProvider /** sets the slave <type>XDispatchProvider</type> to which calls to - <member>XDispatchProvider::queryDispatch</member> can be forwarded + <member>XDispatchProvider::queryDispatch()</member> can be forwarded under control of this dispatch provider. + + @param xNewDispatchProvider + the new slave of this interceptor + + @see XDispatchProviderInterceptor::getSlaveDispatchProvider() */ - void setSlaveDispatchProvider( [in] com::sun::star::frame::XDispatchProvider xNewDispatchProvider ); + void setSlaveDispatchProvider( [in] XDispatchProvider NewDispatchProvider ); //------------------------------------------------------------------------- + /** access to the master <type>XDispatchProvider</type> of this interceptor + + @returns + the master of this interceptor - // DocMerge from idl: method com::sun::star::frame::XDispatchProviderInterceptor::getMasterDispatchProvider - /** @returns - the master <type>XDispatchProvider</type>, which may forward - calls to its <member>XDispatchProvider::queryDispatch</member> - to this dispatch provider. + @see XDispatchProviderInterceptor::setMasterDispatchProvider() */ - com::sun::star::frame::XDispatchProvider getMasterDispatchProvider(); + XDispatchProvider getMasterDispatchProvider(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XDispatchProviderInterceptor::setMasterDispatchProvider /** sets the master <type>XDispatchProvider</type>, which may forward - calls to its <member>XDispatchProvider::queryDispatch</member> + calls to its <member>XDispatchProvider::queryDispatch()</member> to this dispatch provider. + + @param NewSupplier + the master of this interceptor + + @see XDispatchProviderInterceptor::getMasterDispatchProvider() */ - void setMasterDispatchProvider( [in] com::sun::star::frame::XDispatchProvider xNewSupplier ); + void setMasterDispatchProvider( [in] XDispatchProvider NewSupplier ); }; @@ -121,27 +131,4 @@ interface XDispatchProviderInterceptor: com::sun::star::frame::XDispatchProvider }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2001/03/16 16:41:25 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.4 2000/12/19 16:03:30 mi - documentations syntax errors fixed - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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/XDispatchResultListener.idl b/offapi/com/sun/star/frame/XDispatchResultListener.idl index e4ad8efc321f..be579193136a 100644 --- a/offapi/com/sun/star/frame/XDispatchResultListener.idl +++ b/offapi/com/sun/star/frame/XDispatchResultListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDispatchResultListener.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: mba $ $Date: 2001-11-09 16:20:07 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,10 +74,21 @@ module com { module sun { module star { module frame { //============================================================================= +/** listener for results of <member>XNotifyingDispatch::dispatchWithNotification()</member> + @see XNotifyingDispatch + */ interface XDispatchResultListener: com::sun::star::lang::XEventListener { - void dispatchFinished( [in] com::sun::star::frame::DispatchResultEvent Evt ); + //------------------------------------------------------------------------- + /** indicates finished dispatch + + @param Result + contains the result of the dispatch action + + @see DispatchResultEvent + */ + void dispatchFinished( [in] DispatchResultEvent Result ); }; //============================================================================= diff --git a/offapi/com/sun/star/frame/XDocumentTemplates.idl b/offapi/com/sun/star/frame/XDocumentTemplates.idl index 147a79bf505e..40c23f0bbc1f 100644 --- a/offapi/com/sun/star/frame/XDocumentTemplates.idl +++ b/offapi/com/sun/star/frame/XDocumentTemplates.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDocumentTemplates.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,76 +74,176 @@ module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: interface com::sun::star::frame::XDocumentTemplates -/** makes it possible to receive events when the state of a feature changes. +/** provides a high level api to organize document templates + + <p> + Template informations are saved as links to the original content + and organized in groups. This data should be persistent and can be + updated by calling special method <member>XDocumentTemplates::update()</member>. + A real implementation of this interface can do that on top of + an ucb content provider. Method <member>XDocumentTemplates::getContent()</member> + force that. + </p> */ interface XDocumentTemplates: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- -// [attribute] sequence<string> Directories; + /** privides access to the root of internal used hierarchy + + <p> + This content can be used for accessing the groups directly. + </p> - /** returns a content, which can be used for accessing the groups. + @return + the ucb content for template configuration */ - com::sun::star::ucb::XContent getContent(); + com::sun::star::ucb::XContent getContent(); + //------------------------------------------------------------------------- /** creates the template with the given name in the given group using the - data from the storable. + data from the storable + + @param GroupName + specifies the group + + @param TemplateName + specifies the template + + @param Storable + specifies the target + + @return + <TRUE/> if operation was sucessfully + <br> + <FALSE/> otherwise + + @see XDocumentTemplates::addTemplate() */ - boolean storeTemplate( [in] string GroupName, [in] string TemplateName, - [in] com::sun::star::frame::XStorable Storable ); -// raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception ); - /** is called when the status of the feature changes. + boolean storeTemplate( + [in] string GroupName, + [in] string TemplateName, + [in] XStorable Storable); + + //------------------------------------------------------------------------- + /** creates the template with the given name in the given group using the + given URL + + @param GroupName + specifies the group + + @param TemplateName + specifies the template + + @param SourceURL + specifies the position of template + + @return + <TRUE/> if operation was sucessfully + <br> + <FALSE/> otherwise + + @see XDocumentTemplates::storeTemplate() */ - boolean addTemplate( [in] string GroupName, [in] string TemplateName, - [in] string SourceURL ); - /** is called when the status of the feature changes. + boolean addTemplate( + [in] string GroupName, + [in] string TemplateName, + [in] string SourceURL); + + //------------------------------------------------------------------------- + /** remove a template from specified group + + @param GroupName + specifies the group which include the template + + @param TemplateName + specifies the template for delete + + @return + <TRUE/> if operation was sucessfully + <br> + <FALSE/> otherwise */ - boolean removeTemplate( [in] string GroupName, [in] string TemplateName ); + boolean removeTemplate( + [in] string GroupName, + [in] string TemplateName); + + //------------------------------------------------------------------------- + /** rename a template inside specified group - /** is called when the status of the feature changes. + @param GroupName + specifies the group which include the template + + @param TemplateName + specifies the template for renaming + + @return + <TRUE/> if operation was sucessfully + <br> + <FALSE/> otherwise */ - boolean renameTemplate( [in] string GroupName, [in] string OldTemplateName, - [in] string NewTemplateName ); + boolean renameTemplate( + [in] string GroupName, + [in] string OldTemplateName, + [in] string NewTemplateName); - /** Creates a new Group + //------------------------------------------------------------------------- + /** creates a new group @param GroupName - the name of the group to be created + the name of the group to be created @return - true, if the group could be created, false otherwise + <TRUE/> if operation was sucessfully + <br> + <FALSE/> otherwise */ - boolean addGroup( [in] string GroupName ); - /** is called when the status of the feature changes. - */ - boolean removeGroup( [in] string GroupName ); + boolean addGroup( [in] string GroupName ); - /** is called when the status of the feature changes. - */ - boolean renameGroup( [in] string OldGroupName, [in] string NewGroupName ); + //------------------------------------------------------------------------- + /** remove an existing group + + @param GroupName + the name of the group to be removed - /** is called when the status of the feature changes. + @return + <TRUE/> if operation was sucessfully + <br> + <FALSE/> otherwise */ - [oneway] void update(); -}; + boolean removeGroup( [in] string GroupName ); -//============================================================================= + //------------------------------------------------------------------------- + /** rename an existing group -}; }; }; }; + @param OldGroupName + the old name of the group -/*============================================================================= + @param NewGroupName + the new name of the group - $Log: not supported by cvs2svn $ - Revision 1.3 2001/03/23 14:45:09 dv - added renameTemplate and renameGroup + @return + <TRUE/> if operation was sucessfully + <br> + <FALSE/> otherwise + */ + boolean renameGroup( + [in] string OldGroupName, + [in] string NewGroupName); - Revision 1.2 2001/03/16 16:41:25 jsc - remove interfaceheader with uik and remove [const] in method definitions + //------------------------------------------------------------------------- + /** force an update for internal structures + + <p> + Because the templates are well known by links and not as direct content + they can be outdated. An update force actualization of that to find + wrong links. + </p> + */ + [oneway] void update(); +}; - Revision 1.1 2001/03/09 15:06:21 dv - First checkin +//============================================================================= +}; }; }; }; -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/XExtendedFilterDetection.idl b/offapi/com/sun/star/frame/XExtendedFilterDetection.idl index 86d2873075ff..c415551ec31c 100644 --- a/offapi/com/sun/star/frame/XExtendedFilterDetection.idl +++ b/offapi/com/sun/star/frame/XExtendedFilterDetection.idl @@ -2,9 +2,9 @@ * * $RCSfile: XExtendedFilterDetection.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,30 +77,18 @@ module frame { //============================================================================ - -// DocMerge from xml: interface com::sun::star::frame::XExtendedFilterDetection -/** extended filter detection for frame loader factories. - - - - - +/** use <type scope="com::sun::star::document">XExtendedFilterDetection</type> instead of this @deprecated */ 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 - - <p> - Implement it as an extra service for your frameloader to give information about - your responsibility for a given URL. If you can handle these documents return - a valid name for a filter or an empty string otherwise.</p> + /** use <member scope="com::sun::star::document">XExtendedFilterDetection::detect()</member> instead of this + @deprecated */ - string detect( [in] string sURL, [in] sequence< com::sun::star::beans::PropertyValue > aArgumentlist ); + string detect( + [in] string URL, + [in] sequence< com::sun::star::beans::PropertyValue > Argumentlist); }; // XExtendedFilterDetection }; // frame diff --git a/offapi/com/sun/star/frame/XFilterDetect.idl b/offapi/com/sun/star/frame/XFilterDetect.idl index 52d51d97b26a..d82f80c92128 100644 --- a/offapi/com/sun/star/frame/XFilterDetect.idl +++ b/offapi/com/sun/star/frame/XFilterDetect.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFilterDetect.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,61 +71,20 @@ 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. - - - - - - - - - - - +/** use <type scope="com::sun::star::document">XExtendedFilterDetection</type> instead of this @deprecated */ 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.3 2000/11/08 12:43:14 mi - moved from api - - 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 index f72ff693bc5d..3ff59362fb58 100644 --- a/offapi/com/sun/star/frame/XFrame.idl +++ b/offapi/com/sun/star/frame/XFrame.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFrame.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,282 +78,331 @@ interface XController; interface XFramesSupplier; //============================================================================= +/** a frame object can be considered to be an "anchor" object where a component + can be attached to. -// DocMerge from xml: interface com::sun::star::frame::XFrame -/** makes it possible to control a <type>Frame</type> + <p> + A frame can be (it's not a must!) a part of a frame tree. If not this frame willn't be + accessible by using the api. This mode make sense for previews. + The root node of the tree can be a <type>Desktop</type> implementation. + </p> + + @see Desktop */ interface XFrame: com::sun::star::lang::XComponent { //------------------------------------------------------------------------- + /** is called to initialize the frame within a window - the container window. + + <p> + This window will be used as parent for the component window and to support + some UI relevant features of the frame service. + Note: Re-parenting mustn't supported by a real frame implementation! + It's designed for initializing - not for setting. + </p> - // DocMerge from xml: method com::sun::star::frame::XFrame::initialize - /** is called to initialize the frame within a window. + @param Window + the new container window - @see XFrame::getContainerWindow + @see XFrame::getContainerWindow() */ - void initialize( [in] com::sun::star::awt::XWindow xWindow ); + void initialize( [in] com::sun::star::awt::XWindow Window ); //------------------------------------------------------------------------- + /** provides access to the container window of the frame. - // DocMerge from xml: method com::sun::star::frame::XFrame::getContainerWindow - /** provides access to the window of the frame. + <p> + Normally this is used as the parent window of the + component window. + </p> - <p>Normally this is used as the parent window of the - controller window. </p> + @return + the container window of this frame - @see XFrame::initialize + @see XFrame::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. + <p> + Only the creator is allowed to call this method. + But creator doesn't mean the implementation which creates this instance ... + it means the parent frame of the frame hierarchy. + Because; normaly a frame should be created by using the api + and is neccessary for searches inside the tree (e.g. <member>XFrame::findFrame()</member>) + </p> + @param Creator + the creator (parent) of this frame - <p>Only the creator is allowed to call this method.</p> + @see XFrame::getCreator() */ - [oneway] void setCreator( [in] XFramesSupplier xCreator ); + [oneway] void setCreator( [in] XFramesSupplier Creator ); //------------------------------------------------------------------------- + /** provides access to the creator (parent) of this frame + + @returns + the frame container that created and contains this frame. - // DocMerge from idl: method com::sun::star::frame::XFrame::getCreator - /** @returns - the frame container that created this frame. + @see XFrame::setCreator() */ XFramesSupplier getCreator(); //------------------------------------------------------------------------- + /** access to the name property of this frame - // DocMerge from idl: method com::sun::star::frame::XFrame::getName - /** @returns - the programmatic name of this frame. + @returns + the programmatic name of this frame. - <p>See specification of HTML framesets for reference. + @see XFrame::setName() */ string getName(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XFrame::setName /** sets the name of the frame. + <p> + Normally the name of the frame is set initially (e.g. by the creator). + The name of a frame will be used for identifying it if a frame search was started. + These searches can be forced by: + <ul> + <li><member>XFrame::findFrame()</member> + <li><member>XDispatchProvider::queryDispatch()</member> + <li><member>XComponentLoader::loadComponentFromURL()</member> + </ul> + Note: Special targets like "_blank", "_self" etc. are not allowed. + That's why frame names shouldn't start with a sign "_". + </p> + @param Name + the new programmatic name of this frame - <p>Normally the name of the frame is set initially.</p> + @see XFrame::findFrame() + @see XFrame::getName() + @see XDispatchProvider + @see XComponentLoader */ - [oneway] void setName( [in] string aName ); + [oneway] void setName( [in] string Name ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XFrame::findFrame /** searches for a frame with the specified name. - <p>Frames may contain other frames (e.g., a frameset) and may + <p> + Frames may contain other frames (e.g., a frameset) and may be contained in other frames. This hierarchy is searched with - this method.</p> + this method. + </p> - <p>First some special names are taken into account, i.e. "", - "_self", "_top", "_active" etc. <var>nSearchFlags</var> is ignored when - comparing these names with <var>aTargetFrameName</var>; further steps are - controlled by <var>nSearchFlags</var>. If allowed, the name of the frame + <p> + First some special names are taken into account, i.e. "", + "_self", "_top", "_blank" etc. <var>SearchFlags</var> is ignored when + comparing these names with <var>TargetFrameName</var>; further steps are + controlled by <var>SearchFlags</var>. If allowed, the name of the frame itself is compared with the desired one, and then ( again if allowed ) - the method - - - - - - is called for all children - of the frame. Finally - - + the method is called for all children of the frame. Finally may be called + for the siblings and then for parent frame (if allowed). + </p> + <p> + If no frame with the given name is found, a new top frame is + created; if this is allowed by a special flag <const>FrameSearchFlag::CREATE</const>. + The new frame also gets the desired name. + </p> - may be called - for the parent frame (if allowed).</p> + @param TargetFrameName + identify (a) a special target ("_blank","_self" ...) + or (b) any well known frame + to search it inside the current hierarchy - <p>If no frame with the given name is found, a new top frame is - created; if this is not suppressed by a special <type>FrameSearchFlag</type>. - The new frame also gets the desired name.</p> + @param SearchFlags + optional parameter to regulate search if no special target was used for <var>TargetFrameName</var> */ - com::sun::star::frame::XFrame findFrame( [in] string aTargetFrameName, - [in] long nSearchFlags ); + XFrame findFrame( + [in] string TargetFrameName, + [in] long SearchFlags); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XFrame::isTop /** determines if the frame is a top frame. - <p>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 - <TRUE/> for this method, all calls to <member>XDispatchProvider::queryDispatch</member> - have to stop the search at such a frame unless the flag - <const>FrameSearchFlag::TASKS</const> is set.</p> + <p> + In general a top frame is the frame which is a direct child of + a task frame or which does not have a parent. Possible frame searches must + stop the search at such a frame unless the flag <const>FrameSearchFlag::TASKS</const> + is set. + </p> + + @return + <TRUE/> if frame supports top frame specification + <br> + <FALSE/> otherwise */ boolean isTop(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XFrame::activate /** activates this frame and thus the component within. - <p>At first the frame sets itself as the active frame of its - creator by calling - -<!-- JRH: Something seems to be missing from here? --> - - - , - then it broadcasts a <type>FrameActionEvent</type> with + <p> + At first the frame sets itself as the active frame of its + creator by calling <member>XFramesSupplier::setActiveFrame()</member>, + then it broadcasts an <type>FrameActionEvent</type> with <const>FrameAction::FRAME_ACTIVATED</const>. 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 <type>FrameLoader</type>. + this frame may listen to this event to grab the focus on activation; + for simple components this can be done by the <type>FrameLoader</type>. + </p> + <p> + Finally, most frames may grab the focus to one of its windows + or forward the activation to a sub-frame. </p> - <p>Finally, most frames may grab the focus to one of its windows - or forward the activation to a sub-frame.</p> -*/ + + @see XFrame::deactivate() + @see XFrame::isActive() + */ [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. - - - <p>At first the frame deactivates its active sub-frame, if any. + <p> + At first the frame deactivates its active sub-frame, if any. Then broadcasts a <type>FrameActionEvent</type> with - <const>FrameAction::FRAME_DEACTIVATING</const>.</p> + <const>FrameAction::FRAME_DEACTIVATING</const>. + </p> + + @see XFrame::activate() + @see XFrame::isActive() */ [oneway] void deactivate(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XFrame::isActive /** determines if the frame is active. + + @return + <TRUE/> for active or UI active frames + <br> + <FALSE/> otherwise + + @see XFrame::activate() + @see XFrame::deactivate() */ boolean isActive(); //------------------------------------------------------------------------- + /** sets a new component into the frame or release an existing one from a frame. - // DocMerge from xml: method com::sun::star::frame::XFrame::setComponent - /** sets a new component into the frame. + @param ComponentWindow + the window of the new component or <NULL/> for release + + <p> + A valid component window should be a child of the frame container window. + </p> + + @param Controller + the controller of the new component or <NULL/> for release + + <p> + Simple components may implement a <type scope="com::sun::star::awt">XWindow</type> only. + In this case no controller must be given here. + </p> + + @return + <TRUE/>if setting of new component or release of an existing one was successfully + <br> + <FALSE/> otherwise (especialy, if an existing controller disagree within his + <member>XController::suspend()</member> call) + + @see XFrame::getComponentWindow() + @see XFrame::getContainerWindow() + @see XFrame::getController() */ - boolean setComponent( [in] com::sun::star::awt::XWindow xComponentWindow, - [in] com::sun::star::frame::XController xController ); + boolean setComponent( + [in] com::sun::star::awt::XWindow ComponentWindow, + [in] XController Controller); //------------------------------------------------------------------------- + /** provides access to the component window - // DocMerge from idl: method com::sun::star::frame::XFrame::getComponentWindow - /** @returns - the current visible component in this frame. + <p> + Note: Don't dispose this window - the frame is the owner of it. + </p> + + @returns + the current visible component in this frame + <br> + or <NULL/> if no one currently exist - <p>The frame is the owner of the window. + @see XFrame::setComponent() */ com::sun::star::awt::XWindow getComponentWindow(); //------------------------------------------------------------------------- + /** provides access to the controller - // DocMerge from idl: method com::sun::star::frame::XFrame::getController - /** @returns - the current controller within this frame. + <p> + Note: Don't dispose it - the frame is the owner of it. + Use <member>XController::getFrame()</member> to dispose + the frame after you the controller agreed with a + <member>XController::suspend()</member> call. + </p> - <p>Normally it is set by a frame loader. + @returns + the current controller within this frame + <br> + or <NULL/> if no one currently exist + + @see XFrame::setComponent() */ 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). + frame changed (i.e. the selection). - - - <p>According to a call to this interface, the frame calls - -<!-- JRH: Something seems to be missing from here? --> - - - - with + <p> + According to a call to this interface, the frame calls + <member>XFrameEventListener::frameAction()</member> with <const>FrameAction::CONTEXT_CHANGED</const> to all listeners which - are registered using - - - + are registered using <member>XFrame::addFrameActionListener</member>. + For external controllers this event can be used to requery dispatches. - . - For external controllers this event can be used to requery dispatches.</p> - */ + @see XFrameEventListener + @see FrameAction + @see XFrame::addFrameActionListener() + */ 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. + <p> + E.g., it is possible to determine instantiation/destruction and + activation/deactivation of components. + </p> + @param Listener + specifies the listener which will be informed - <p>E.g., it is possible to determine instantiation/destruction and - activation/deactivation of components.</p> + @see XFrame::removeFrameActionListener() */ - [oneway] void addFrameActionListener( [in]XFrameActionListener xListener ); + [oneway] void addFrameActionListener( [in]XFrameActionListener Listener ); //------------------------------------------------------------------------- + /** unregisters an event listener - // DocMerge from xml: method com::sun::star::frame::XFrame::removeFrameActionListener - /** unregisters an event listener which was registered with - <member>XFrame::addFrameActionListener()</member>. - */ - [oneway] void removeFrameActionListener( [in] XFrameActionListener xListener ); + @param Listener + specifies the listener which willn't be informed any longer + @see XFrame::addFrameActionListener() + */ + [oneway] void removeFrameActionListener( [in] XFrameActionListener Listener ); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.6 2001/03/16 16:41:25 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.5 2000/12/19 16:03:30 mi - documentations syntax errors fixed - - Revision 1.4 2000/12/14 12:53:37 mi - <true></true> -> <TRUE/> and same with FALSE - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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 index 9713bf30edb2..5bd83d03575a 100644 --- a/offapi/com/sun/star/frame/XFrameActionListener.idl +++ b/offapi/com/sun/star/frame/XFrameActionListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFrameActionListener.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,50 +75,30 @@ 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. + when several things happen to components within frames of the desktop frame tree. - <p>E.g., you can receive events of instantiation/destruction and - activation/deactivation of components. + <p> + E.g., you can receive events of instantiation/destruction and + activation/deactivation of components. + </p> - @see XDesktop::addFrameActionListener - @see XDesktop::removeFrameActionListener + @see XFrame::addFrameActionListener() + @see XFrame::removeFrameActionListener() */ 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 ); + @param Action + describes the detected frame action for which the listener can react + */ + [oneway] void frameAction( [in] FrameActionEvent Action ); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2001/03/16 16:41:25 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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 index d7dfdbfe10ed..f01c8865b664 100644 --- a/offapi/com/sun/star/frame/XFrameLoader.idl +++ b/offapi/com/sun/star/frame/XFrameLoader.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFrameLoader.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,53 +83,61 @@ module com { module sun { module star { module frame { //============================================================================= +/** load components into a frame -// DocMerge: empty anyway + <p> + It's an asynchronous loading. For synchronous processes use <type>XSynchronousFrameLoader</type> + instead of this one. The generic load algorithm of the office supports both ones - but prefered + the synchronous interface. + </p> + + @see XFrame + */ 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 <type>Frame</type>. - */ - [oneway] void load( [in] com::sun::star::frame::XFrame aFrame, - [in] string aURL, - [in] sequence<com::sun::star::beans::PropertyValue> aArgs, - [in] com::sun::star::frame::XLoadEventListener xListener ); - //------------------------------------------------------------------------- + @param Frame + specifies the loading target - // DocMerge from xml: method com::sun::star::frame::XFrameLoader::cancel - /** cancels the loading process. + @param URL + describes the ressource of loading component + Support of special protocols are implementation details + and depends from the environment. + @param Arguments + optional arguments for loading + (see <type scope="com::sun::star::document">MediaDescriptor</type> for further informations) + @param Listener + this listener will be informed about success - <p>After returning from this call, neither the frame nor the - load-event-listener specified in "load" may be called back.</p> + @see XLoadEventListener */ - [oneway] void cancel(); + [oneway] void load( + [in] XFrame Frame, + [in] string URL, + [in] sequence< com::sun::star::beans::PropertyValue > Arguments, + [in] XLoadEventListener Listener); + + //------------------------------------------------------------------------- + /** cancels the loading process. + <p> + After returning from this call, neither the frame nor the + load-event-listener specified in <member>XFrameLoader::load()</member> may be called back. + Because only the owner of this process who called load method + before can cancel this process. And he doesn't need any notification about that. + On the other hand - nobody then this owner himself can be registered as an + <type>XLoadEventListener</type> here. + </p> + */ + [oneway] void cancel(); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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 index e8b1156638f5..c3536f8a2b22 100644 --- a/offapi/com/sun/star/frame/XFrameLoaderQuery.idl +++ b/offapi/com/sun/star/frame/XFrameLoaderQuery.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFrameLoaderQuery.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -81,59 +81,29 @@ 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 information about supported properties with XFrameLoaderQuery - and create matching loader with XMultiServiceFactory. - - - - - +/** use service <type>FrameLoaderFactory</type> instead of this @deprecated */ 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 - <P> - 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. + /** use member <member scope="com::sun::star::container">XNameAccess::getElementNames()</member> + provided by service <type>FrameLoaderFactory</type> instead of this + @deprecated */ sequence< string > getAvailableFilterNames(); //------------------------------------------------------------------------- - - - // DocMerge from idl: method com::sun::star::frame::XFrameLoaderQuery::getLoaderProperties - /** return extended information about all supported properties of an frame loader - <P> - 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. + /** use member <member scope="com::sun::star::container">XNameAccess::getByName()</member> + provided by service <type>FrameLoaderFactory</type> instead of this + @deprecated */ 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 - - <p> - If you don't know a filter name of a loader, call these method to search for anyone - who supports a given parameter. Use returned name to get further information - 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 must search for right loader again. - (We look for FilterName first!)</p> + /** use member <type scope="com::sun::star::container">XContainerQuery</type> + provided by service <type>FrameLoaderFactory</type> instead of this + @deprecated */ string searchFilter( [in] string sURL, [in] sequence< com::sun::star::beans::PropertyValue > seqArguments ); diff --git a/offapi/com/sun/star/frame/XFrameSetModel.idl b/offapi/com/sun/star/frame/XFrameSetModel.idl index 2703086ba0b8..ce423efbeaf5 100644 --- a/offapi/com/sun/star/frame/XFrameSetModel.idl +++ b/offapi/com/sun/star/frame/XFrameSetModel.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFrameSetModel.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,63 +71,20 @@ 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. - - - - - - - - - - - - - +/** use <type>XModel</type> instead of this @deprecated */ 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.3 2000/11/08 12:43:14 mi - moved from api - - 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 index 86928acc9464..5d58f2043377 100644 --- a/offapi/com/sun/star/frame/XFrames.idl +++ b/offapi/com/sun/star/frame/XFrames.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFrames.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,59 +75,57 @@ module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: interface com::sun::star::frame::XFrames /** manages and creates frames. - - - <p>Frames may contain other frames (by implementing an <type>XFrames</type> + <p> + Frames may contain other frames (by implementing an <type>XFrames</type> interface) and may be contained in other frames. + </p> - </p>@see XFrame - @see Frame + @see XFrame + @see Frame */ interface XFrames: com::sun::star::container::XIndexAccess { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XFrames::append /** appends the specified <type>Frame</type> to the list of sub-frames. + + @param xFrame + new frame for inserting into this container */ - void append( [in] com::sun::star::frame::XFrame xFrame ); + void append( [in] XFrame xFrame ); //------------------------------------------------------------------------- + /** provides access to the list of all currently existing + frames inside this container and her sub frames - // 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. + @param nSearchFlags + use combinations of <type>FrameSearchFlag</type> to specify which + frames should be found - <P>The content of the sequence may be limited by the caller through - the <type>FrameSearchFlags</type>.</P> + @return + all frames of this container and all available frames of the whole frame tree + which match search parameter <var>SearchFlags</var> */ - sequence<com::sun::star::frame::XFrame> queryFrames( [in] long nSearchFlags ); + sequence< XFrame > queryFrames( [in] long nSearchFlags ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XFrames::remove /** removes the frame from its container. - - - <p>The method - - - - - is not called implicitly - by this method. - + <p> + Note: + <ul> + <li>The method <method>XComponent::dispose()</method> is not called implicitly + by this method.</li> + <li>The creator attribute of the frame must be reset by the caller of + this method.</li> + </ul> </p> - <p>The creator attribute of the frame must be reset by the caller of - this method.</p> - */ - void remove( [in] com::sun::star::frame::XFrame xFrame ); + + @param xFrame + frame which should be removed from this container + */ + void remove( [in] XFrame xFrame ); }; @@ -135,30 +133,4 @@ interface XFrames: com::sun::star::container::XIndexAccess }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:10 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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 index 2fdeb64e8d87..fc18cda59aed 100644 --- a/offapi/com/sun/star/frame/XFramesSupplier.idl +++ b/offapi/com/sun/star/frame/XFramesSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFramesSupplier.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,100 +72,69 @@ interface XFrames; //============================================================================= +/** provides access to sub frames of current one -// DocMerge: empty anyway + @see XFrames + */ interface XFramesSupplier: XFrame { //------------------------------------------------------------------------- + /** provides access to this container and to all other <type>XFramesSupplier</type> + which are available from this node of frame tree - // DocMerge from idl: method com::sun::star::frame::XFramesSupplier::getFrames - /** @returns - the collection of (sub-) frames which is represented by - a <type>FramesContainer</type>. + @returns + the collection of frames which is represented by + a <type>FramesContainer</type>. */ XFrames getFrames(); //------------------------------------------------------------------------- + /** gets the current active frame of this container + (not of any other available supplier) + + <p> + 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. + </p> - // DocMerge from idl: method com::sun::star::frame::XFramesSupplier::getActiveFrame - /** @returns - the sub-<type>Frame</type> which is active within this frame. - - <p>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. + @returns + the <type>Frame</type> which is active within this frame. */ XFrame getActiveFrame(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XFramesSupplier::setActiveFrame /** is called on activation of a direct sub-frame. - - - <p>This method is only allowed to be called by a sub-frame according to - - - - - - or - - - - - - . After this call - - - - - - will return the - frame specified by <var>xFrame</var>. - + <p> + This method is only allowed to be called by a sub-frame according to + <member>XFrame::activate()</member> or <member>XFramesSupplier::setActiveFrame()</member>. + After this call <member>XFramesSupplier::getActiveFrame()</member> will return the + frame specified by <var>Frame</var>. </p> - <p>In general this method first calls the method - + <p> + In general this method first calls the method <member>XFramesSupplier::setActiveFrame()</member> + at the creator frame with <var>this</var> as the current argument. Then it broadcasts + the <type>FrameActionEvent</type> <const>FrameAction::FRAME_ACTIVATED</const>. + </p> + <p> + Note: Given parameter <var>Frame</var> must already exist inside the container + (e.g., inserted by using <member>XFrames::append()</member>) + </p> - - at the creator frame - with <var>this</var> as the current argument. Then it broadcasts - the <type>FrameActionEvent</type> <const>FrameAction::FRAME_ACTIVATED</const>.</p> - -<!-- JRH: Something seems to be missing from here? Or maybe there are pictures? --> */ - void setActiveFrame( [in] XFrame xFrame ); - + @param Frame + the new active child frame inside this container + */ + void setActiveFrame( [in] XFrame Frame ); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2001/03/16 16:41:25 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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 index 8391e062239b..3d5d6cceff32 100644 --- a/offapi/com/sun/star/frame/XInterceptorInfo.idl +++ b/offapi/com/sun/star/frame/XInterceptorInfo.idl @@ -2,9 +2,9 @@ * * $RCSfile: XInterceptorInfo.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,44 +71,37 @@ //============================================================================= -/** Makes it possible to get information about registered interceptor. - zB. get URL lists for interception +/** makes it possible to get information about a registered interceptor and is used by + frame interceptor mechanism to perform interception. + + <p> + Frame can call right interceptor directly without calling all of registered ones. Use it as an additional interface to <type>XDispatchProviderInterceptor</type>. + If any interceptor in list doesn't support this interface - these mechanism will be broken + and normal list of master-slave interceptor objects will be used from top to the bottom. + </p> - <!-- Dennis: What is the "zB"? --> - <!-- Dennis: What "gets" the URL lists? --> -<!-- JRH: Something still seems to be missing from here? -->*/ + @see XDispatchProviderInterception + @see XDispatchProviderInterceptor + */ interface XInterceptorInfo: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** returns the URL list for interception. + + <p> + Wildcards inside the URL's are allowed to register the interceptor for + URL's too, which can have optional arguments (e.g. "..#.." or "..?.."). + </p> + + @return + a list of URL's wich are handled by this interceptor */ sequence< string > getInterceptedURLs(); - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2001/04/24 00:10:37 arellano - modified grammatical number, spelling - - Revision 1.4 2001/03/16 16:41:25 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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 index 8961f19879bc..3356c82675b4 100644 --- a/offapi/com/sun/star/frame/XLoadEventListener.idl +++ b/offapi/com/sun/star/frame/XLoadEventListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XLoadEventListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,47 +72,31 @@ interface XFrameLoader; //============================================================================= +/** is used to receive callbacks from an asynchronous frame loader. -// DocMerge from xml: interface com::sun::star::frame::XLoadEventListener -/** is used to receive callbacks from a frame loader. + @see XFrameLoader */ interface XLoadEventListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- + /** is called when a new component is loaded into a frame successfully. - // DocMerge from xml: method com::sun::star::frame::XLoadEventListener::loadFinished - /** is called when a new control is loaded into a frame. + @param Loader + the source of this event */ - [oneway] void loadFinished( [in] XFrameLoader aLoader ); + [oneway] void loadFinished( [in] XFrameLoader Loader ); //------------------------------------------------------------------------- + /** is called when a frame load is cancelled or failed. - // DocMerge from xml: method com::sun::star::frame::XLoadEventListener::loadCancelled - /** is called when a frame load is cancelled. + @param Loader + the source of this event */ - [oneway] void loadCancelled( [in] XFrameLoader aLoader ); - + [oneway] void loadCancelled( [in] XFrameLoader Loader ); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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 index 6642308f4c80..eb20bb2116ad 100644 --- a/offapi/com/sun/star/frame/XModel.idl +++ b/offapi/com/sun/star/frame/XModel.idl @@ -2,9 +2,9 @@ * * $RCSfile: XModel.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -87,210 +87,184 @@ 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. - <p>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. - - <p>Models can be controlled by controller components, which are usually - views of the model. - - <p>If there is at least one controller, there is by definition a - current controller. And if that controller supports the interface - <type>XSelectionSupplier</type>, it has a current selection too. + <p> + 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. + (see <type scope="com::sun::star::document">MediaDescriptor</type> for further details) + </p> + + <p> + Models can be controlled by controller components, which are usually + views of the model. + (see <type>Controller</type> for further details) + </p> + + <p> + If there is at least one controller, there is by definition a + current controller. And if that controller supports the interface + <type>XSelectionSupplier</type>, it has a current selection too. + </p> + + @see MediaDescriptor + @see Controller + @see XSelectionSupplier */ interface XModel: com::sun::star::lang::XComponent { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XModel::attachResource /** informs a model about its resource description. + + @param URL + specifies the ressource + + @param Arguments + are optional arguments for that ressource + (see <type scope="com::sun::star::document">MediaDescriptor</type>) + + @return + <TRUE/> for success + <br> + <FALSE/> otherwise */ - boolean attachResource( [in] string aURL, - [in] sequence<com::sun::star::beans::PropertyValue> aArgs ); + boolean attachResource( + [in] string URL, + [in] sequence<com::sun::star::beans::PropertyValue> Arguments); //------------------------------------------------------------------------- + /** provides information about the location of this model - // DocMerge from idl: method com::sun::star::frame::XModel::getURL - /** @returns - the URL of the resource which is represented by this model. + @returns + the URL of the resource which is represented by this model. - @see XStorable::getLocation + @see XStorable::getLocation() */ string getURL(); //------------------------------------------------------------------------- + /** provides read acces on currently representation of the + <type scope="com::sun::star::document">MediaDescriptor</type> + of this model which describes the model and his state - // 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. + @returns + the arguments with which the model was originally created or + stored the last time. */ - sequence<com::sun::star::beans::PropertyValue> getArgs(); + sequence< com::sun::star::beans::PropertyValue > getArgs(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XModel::connectController /** is called whenever a new controller is created for this model. + <p> + The <type scope="com::sun::star::lang">XComponent</type> interface + of the controller must be used to recognize when it is deleted. + </p> + @param Controller + a new controller for this model - <p>The <type scope="com::sun::star::lang">XComponent</type> interface of the controller must be used to - recognize when it is deleted. - - </p>@see releaseController + @see XModel::disconnectController() */ - [oneway] void connectController( [in] com::sun::star::frame::XController xController ); + [oneway] void connectController( [in] XController Controller ); //------------------------------------------------------------------------- + /** is called whenever an existing controller should be deregistered at this model. - // DocMerge from xml: method com::sun::star::frame::XModel::disconnectController - /** is called whenever a new controller is created for this model. - - + <p> + The <type scope="com::sun::star::lang">XComponent</type> interface + of the controller must be used to recognize when it is deleted. + </p> - <p>The <type scope="com::sun::star::lang">XComponent</type> interface of the controller must be - used to recognize when it is deleted. + @param Controller + the existing controller which should be deregistered - </p>@see registerController + @see XModel::connectController() */ - [oneway] void disconnectController( [in] com::sun::star::frame::XController xController ); + [oneway] void disconnectController( [in] XController Controller ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XModel::lockControllers /** suspends some notifications to the controllers which are used for display updates. - - - <p>The calls to - - - - - and - - - - - - may be + <p> + The calls to <member>XModel::lockControllers()</member> and + <member>XModel::unlockControllers()</member> 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.</p> + for display updates are not broadcasted. + </p> */ [oneway] void lockControllers(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XModel::unlockControllers /** resumes the notifications which were suspended by + <member>XModel::lockControllers()</member>. - - - - - . - - - - <p>The calls to - - - - - and - - - - - - may be + <p> + The calls to <member>XModel::lockControllers()</member> and + <member>XModel::unlockControllers()</member> 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.</p> - */ + display updates are not broadcasted. + </p> + */ [oneway] void unlockControllers(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XModel::hasControllersLocked /** determines if there is at least one lock remaining. + <p> + While there is at least one lock remaining, some notifications + for display updates are not broadcasted to the controllers. + </p> - - <p>While there is at least one lock remaining, some notifications - for display updates are not broadcasted to the controllers.</p> + @return + <TRUE/> if any lock exist + <br> + <FALSE/> otherwise */ boolean hasControllersLocked(); //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::frame::XModel::getCurrentController - /** @returns - the controller which currently controls this model. - - <p>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. + /** provides access to the controller which currently controls this model + + @returns + 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. */ - com::sun::star::frame::XController getCurrentController(); + XController getCurrentController(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XModel::setCurrentController /** sets a registered controller as the current controller. + + @param Controller + reference to an already existing connected controller, which should be + the new active one + + @throws com::sun::star::container::NoSuchElementException + if <var>xController</var> isn't an already connected controller on this model */ - void setCurrentController( [in] com::sun::star::frame::XController xController ) + void setCurrentController( [in] XController Controller ) raises( com::sun::star::container::NoSuchElementException ); //------------------------------------------------------------------------- + /** provides read access on current selection on controller - // DocMerge from idl: method com::sun::star::frame::XModel::getCurrentSelection - /** @returns - the current selection in the current controller. - - <p>If there is no current controller, it returns NULL. + @returns + the current selection in the current controller. + If there is no current controller, it returns <NULL/>. */ com::sun::star::uno::XInterface getCurrentSelection(); - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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/XNotifyingDispatch.idl b/offapi/com/sun/star/frame/XNotifyingDispatch.idl index 372169806b01..8b0f160531d4 100644 --- a/offapi/com/sun/star/frame/XNotifyingDispatch.idl +++ b/offapi/com/sun/star/frame/XNotifyingDispatch.idl @@ -2,9 +2,9 @@ * * $RCSfile: XNotifyingDispatch.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: mba $ $Date: 2001-11-09 16:20:07 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,12 +73,31 @@ module com { module sun { module star { module frame { //============================================================================= +/** dispatch with guaranteed notify (instead of <type>XDispatch</type>) -interface XNotifyingDispatch: com::sun::star::frame::XDispatch + @see XDispatch + @see XStatusListener + */ +interface XNotifyingDispatch: XDispatch { - [oneway] void dispatchWithNotification( [in] com::sun::star::util::URL aURL, - [in] sequence<com::sun::star::beans::PropertyValue> aArgs, - [in] com::sun::star::frame::XDispatchResultListener Listener ); + //------------------------------------------------------------------------- + /** Do the same like <member>XDispatch::dispatch()</member> but notifies + listener in every case. Should be used if result must be known. + + @param URL + full parsed URL describes the feature which should be dispatched (executed) + + @param Arguments + optional arguments for this request + (see <type scope="com::sun::star::document">MediaDescriptor</type>) + + @param Listener + optional listener for guaranteed notifications of this request + */ + [oneway] void dispatchWithNotification( + [in] com::sun::star::util::URL URL, + [in] sequence<com::sun::star::beans::PropertyValue> Arguments, + [in] XDispatchResultListener Listener); }; //============================================================================= diff --git a/offapi/com/sun/star/frame/XStatusListener.idl b/offapi/com/sun/star/frame/XStatusListener.idl index 4a940d627888..13d20837e336 100644 --- a/offapi/com/sun/star/frame/XStatusListener.idl +++ b/offapi/com/sun/star/frame/XStatusListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XStatusListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,46 +75,30 @@ 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. + + <p> + Nobody guarantee any notification. Use combination of <type>XNotifyingDispatch</type> + and <type>XDispatchResultListener</type> for that. + </p> + + @see XDispatch + @see XNotifyingDispatch + @see XDispatchResultListener */ 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 ); + @param State + provides information about changes of the requested feature + */ + [oneway] void statusChanged( [in] FeatureStateEvent State ); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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 index d9fccb1a5751..fc17f09f1a27 100644 --- a/offapi/com/sun/star/frame/XStorable.idl +++ b/offapi/com/sun/star/frame/XStorable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XStorable.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,174 +79,117 @@ 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 an URL. - - - <p>It is usually only useful for two cases: - + <p> + It is usually only useful for two cases: </p> <ol> - <li>Large components which are wrapped with <em>StarOne</em> interfaces - and for which distinct filters are not available separately as - components. - - </li> - <li>Very small components for which only one or very few hard - coded file format filters make sense or even exist. - </li> + <li> + Large components which are wrapped with <em>StarOne</em> interfaces + and for which distinct filters are not available separately as + components. + </li> + <li> + Very small components for which only one or very few hard + coded file format filters make sense or even exist. + </li> </ol> */ interface XStorable: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- + /** The object may know the location because it was loaded from there, + or because it is stored there. - // DocMerge from idl: method com::sun::star::frame::XStorable::hasLocation - /** @returns - <TRUE/> if the object knows a location where it is persistent. - - <p>The object may know the location because it was loaded from there, - or because it is stored there. + @returns + <TRUE/> if the object knows a location where it is persistent + <FALSE/> otherwise */ boolean hasLocation(); //------------------------------------------------------------------------- + /** After <member>XStorable::storeAsURL()</member> it returns the + URL the object was stored to. - // DocMerge from idl: method com::sun::star::frame::XStorable::getLocation - /** @returns - the URL of the resource which is represented by this object. - - <p>After <member>XStorable::storeAsURL</member> it returns the - URL the object was stored to. + @returns + the URL of the resource which is represented by this object. */ string getLocation(); //------------------------------------------------------------------------- + /** It is not possible to call <member>XStorable::store()</member> successfully + when the data store is read-only. - // DocMerge from idl: method com::sun::star::frame::XStorable::isReadonly - /** @returns - <TRUE/> if the data store is readonly or opened readonly. - - <p>It is not possible to call store() successfully when the data - store is read-only. + @returns + <TRUE/> if the data store is readonly or opened readonly + <FALSE/> otherwise */ boolean isReadonly(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XStorable::store /** stores the data to the URL from which it was loaded. + <p>Only objects which know their locations can be stored.</p> + @throws com::sun::star::io::IOException + if an IO error occured during save operation + (may the location is unknown) - <p>Only objects which know their locations can be stored.</p> + @see XStorable::storeAsURL + @see XStorable::storeToURL */ 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. + <p>This is the normal behavior for UI's "save-as" feature.</p> + @param sURL + specifies the new location of this component - <p>This is the normal behavior for UI's "save-as" feature. - - </p> - <p>The arguments depend on the object itself. Commonly used are: - <dl> - <dt>string FilterName - </dt> - <dd> The programmatic name of the file format filter to be used. + @param lArguments + optional parameters for saving + (see <type scope="com::sun::star::document">MediaDescriptor</type> for further details) - </dd> - <dt>string FilterFlags - </dt> - <dd> 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.) + @throws com::sun::star::io::IOException + if an IO error occured during save operation + (may the location is unknown) - </dd> - <dt>boolean Overwrite - </dt> - <dd> Overwrites the target file if it exists. Otherwise the - call would result in an exception if the file exists. - - </dd> - <dt>string Password - </dt> - <dd> This argument specifies the password to be used to - encrypt the document. - </dd> - </dl> - - </p> - - @see storeTo - @see com::sun::star::document::MediaDescriptor - for more information on values for <var>aArgs</var>. + @see XStorable::store + @see XStorable::storeToURL + @see MediaDescriptor */ - void storeAsURL( [in] string aURL, - [in] sequence<com::sun::star::beans::PropertyValue> aArgs ) - raises( com::sun::star::io::IOException ); + void storeAsURL( + [in] string sURL, + [in] sequence<com::sun::star::beans::PropertyValue> lArguments ) + 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. - <p>This is the normal behavior for UI's export feature. </p> + <p>This is the normal behavior for UI's export feature.</p> - @see storeAs - @see com::sun::star::document::MediaDescriptor - for more information on values for <var>aArgs</var>. - */ - void storeToURL( [in] string aURL, - [in] sequence<com::sun::star::beans::PropertyValue> aArgs ) - raises( com::sun::star::io::IOException ); + @throws com::sun::star::io::IOException + if an IO error occured during save operation + (may the location is unknown) + @see XStorable::store + @see XStorable::storeAsURL + @see MediaDescriptor + */ + void storeToURL( + [in] string sURL, + [in] sequence<com::sun::star::beans::PropertyValue> lArguments ) + raises( com::sun::star::io::IOException ); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.6 2001/03/22 17:27:25 mi - #77161# arguments of XStorable::storeAs/To - - Revision 1.5 2001/03/16 16:41:25 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.4 2000/12/19 16:03:30 mi - documentations syntax errors fixed - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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/XSynchronousFrameLoader.idl b/offapi/com/sun/star/frame/XSynchronousFrameLoader.idl index a80599a369a8..98051838c92b 100644 --- a/offapi/com/sun/star/frame/XSynchronousFrameLoader.idl +++ b/offapi/com/sun/star/frame/XSynchronousFrameLoader.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSynchronousFrameLoader.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: arellano $ $Date: 2001-04-24 00:16:20 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,31 +78,46 @@ module com { module sun { module star { module frame { //============================================================================= - /** loads a resource into a <type>Frame</type>. <p> Unlike the <type>XFrameLoader</type> interface, this loading will be synchronous. </p> - */ + @see XFrameLoader + */ interface XSynchronousFrameLoader: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** starts the loading of the specified resource into the specified <type>Frame</type>. - <p> - Use a <type>MediaDescriptor</type> to describe the document for loading. - <TRUE/> is returned if loading is successful, otherwise <FALSE/>. - </p> + @param Descriptor + describes the ressource which should be loaded + It use a <type scope="com::sun::star::document">MediaDescriptor</type> for that. + + @param Frame + the target frame which should contain the new loaded component + + @return + <TRUE/> if loading is successfully + <br> + <FALSE/> otherwise */ - boolean load( [in] sequence< com::sun::star::beans::PropertyValue > aDescriptor , - [in] com::sun::star::frame::XFrame xFrame ); + boolean load( + [in] sequence< com::sun::star::beans::PropertyValue > Descriptor, + [in] XFrame Frame ); //------------------------------------------------------------------------- - /** cancels the loading process. + + <p> + No notifications (neither to the frame or the caller) must be notified. + Because it's a synchronous process this cancel call can be forced by + another thread the the loader thread only. Method + <member>XSynchronousFrameLoader::load()</member> must return <FALSE/> + then and caller of this method <member>XSynchronousFrameLoader::cancel()</member> + already knows the state ... + </p> */ void cancel(); }; diff --git a/offapi/com/sun/star/frame/XTask.idl b/offapi/com/sun/star/frame/XTask.idl index 84015bf1a25c..7272939a7fa8 100644 --- a/offapi/com/sun/star/frame/XTask.idl +++ b/offapi/com/sun/star/frame/XTask.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTask.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,76 +71,37 @@ 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. +/** use <type>XFrame</type> instead of this one + @deprecated */ -interface XTask: com::sun::star::frame::XFrame +interface XTask: XFrame { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XTask::close - /** tries to close all windows within the task and the task by itself. + /** use <type scope="com::sun::star::util">XClosable</type> or + <member scope="com::sun::star::lang">XComponent::dispose()</member> + at a <type>Frame</type> instead of this one + @deprecated */ boolean close(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XTask::tileWindows - /** arranges the windows within the task in tiles. + /** @deprecated */ [oneway] void tileWindows(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XTask::arrangeWindowsVertical - /** arranges the windows within the task vertically. + /** @deprecated */ [oneway] void arrangeWindowsVertical(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XTask::arrangeWindowsHorizontal - /** arranges the windows within the task horizontally. + /** @deprecated */ [oneway] void arrangeWindowsHorizontal(); - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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 index 5ce57c631c67..9ed7ab25857c 100644 --- a/offapi/com/sun/star/frame/XTasksSupplier.idl +++ b/offapi/com/sun/star/frame/XTasksSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTasksSupplier.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,65 +79,26 @@ 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. - - - - <p>Note: Not all desktop environments support tasks at all. - - </p>@see Desktop +/** use <type>XFramesSupplier</type> instead of that + @deprecated */ 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. - - <p>The service <type>Tasks</type> contained in this attribute is - a collection object of all tasks of the desktop. - - @see Tasks + /** use <member>XFramesSupplier::getFrames()</member> instead of this one + @depreacted */ 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. - - <p>Even if an active component exists, there may be no active task. + /** use <member>XFramesSupplier::getActiveFrame()</member> instead of this one + @depreacted */ - com::sun::star::frame::XTask getActiveTask(); - + XTask getActiveTask(); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:10 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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 index 0e8855e7059d..3dfdee864af6 100644 --- a/offapi/com/sun/star/frame/XTerminateListener.idl +++ b/offapi/com/sun/star/frame/XTerminateListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTerminateListener.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,53 +79,45 @@ 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 + when the master environment (e.g., desktop) is terminated. + + @see XDesktop::terminate() + @see XDesktop::addTerminateListener() + @see XDesktop::removeTerminateListener() */ 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. + + <p> + Termination can be intercepted by throwing <type>TerminationVetoException</type>. + Interceptor will be the new owner of desktop and should call <member>XDesktop::terminate()</member> + after finishing his own operations. + </p> + + @param Event + describe the source of the event (e.g., the desktop) + + @throws TerminationVetoException + listener can disagree with this query by throwing this veto exception */ - void queryTermination( [in] com::sun::star::lang::EventObject aEvent ) - raises( com::sun::star::frame::TerminationVetoException ); + void queryTermination( [in] com::sun::star::lang::EventObject Event ) + raises( 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 ); + Not veto will be accepted then. + @param Event + describe the source of the event (e.g., the desktop) + */ + void notifyTermination( [in] com::sun::star::lang::EventObject Event ); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2001/03/16 16:41:25 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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 index f6e88454776e..203379b2b8c1 100644 --- a/offapi/com/sun/star/frame/XUrlList.idl +++ b/offapi/com/sun/star/frame/XUrlList.idl @@ -2,9 +2,9 @@ * * $RCSfile: XUrlList.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,9 +71,7 @@ module com { module sun { module star { module frame { //============================================================================= -/** provides a list of URLs (i.e., to represent a selection). - - @deprecated +/** @deprecated */ interface XUrlList: com::sun::star::uno::XInterface { diff --git a/offapi/com/sun/star/frame/XWindowArranger.idl b/offapi/com/sun/star/frame/XWindowArranger.idl index 00659f4652a0..aa88b2a58d90 100644 --- a/offapi/com/sun/star/frame/XWindowArranger.idl +++ b/offapi/com/sun/star/frame/XWindowArranger.idl @@ -2,9 +2,9 @@ * * $RCSfile: XWindowArranger.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,53 +71,23 @@ 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. +/** @deprecated */ interface XWindowArranger: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::frame::XWindowArranger::hasArrangeCommand - /** @returns - <TRUE/> if the specified arrangement style is supported. - - @see WindowArrange + /** @deprecated */ boolean hasArrangeCommand( [in] short nCommand ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XWindowArranger::arrange - /** arranges the window according to the specified style.@see WindowArrange + /** @deprecated */ [oneway] void arrange( [in] short nCommand ); - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:10 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - 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 |