diff options
| author | Michael Hönnig <mi@openoffice.org> | 2001-11-01 09:29:29 +0000 |
|---|---|---|
| committer | Michael Hönnig <mi@openoffice.org> | 2001-11-01 09:29:29 +0000 |
| commit | d6f3783f90b84f49e8465ca259fa24dedf6059fc (patch) | |
| tree | 643bd7de1c32eb10b90be885a2115c5cbfd2d4c5 | |
| parent | 28e84a43c1fa5f3b82f5bde048db5ab9c6136efc (diff) | |
proofreading and corrections from Richard Holt
33 files changed, 267 insertions, 257 deletions
diff --git a/offapi/com/sun/star/frame/Components.idl b/offapi/com/sun/star/frame/Components.idl index 7a055783f..4b363702f 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-21 08:35:10 $ + * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,10 +76,10 @@ /** 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>@see com::sun::star::lang::XComponent - @see XDesktop + <type>Desktop</type> object via the <type>XDesktop</type> interface. </p> + @see com::sun::star::lang::XComponent + @see XDesktop */ service Components { @@ -95,6 +95,9 @@ service Components /*============================================================================= $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 diff --git a/offapi/com/sun/star/frame/Desktop.idl b/offapi/com/sun/star/frame/Desktop.idl index 49b64711d..0a65afcd4 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.5 $ + * $Revision: 1.6 $ * - * last change: $Author: as $ $Date: 2001-09-26 09:57:05 $ + * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -84,7 +84,7 @@ interface XTasksSupplier; //============================================================================= // DocMerge from xml: service com::sun::star::frame::Desktop -/** is the environment for components which can instanciate within frames. +/** 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> @@ -111,6 +111,9 @@ service Desktop /*============================================================================= $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 diff --git a/offapi/com/sun/star/frame/DocumentTemplates.idl b/offapi/com/sun/star/frame/DocumentTemplates.idl index c7dec9557..b32fd5653 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.1 $ + * $Revision: 1.2 $ * - * last change: $Author: dv $ $Date: 2001-07-27 12:34:51 $ + * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,7 +71,7 @@ module com { module sun { module star { module frame { //============================================================================= -/** is an abstract service for a accessing the document templates of the office +/** is an abstract service for accessing the document templates of the office and manipulate them ( add or rename or remove templates ) */ @@ -88,6 +88,9 @@ service DocumentTemplates /*============================================================================= $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 diff --git a/offapi/com/sun/star/frame/FeatureStateEvent.idl b/offapi/com/sun/star/frame/FeatureStateEvent.idl index 6b269e702..d6c1d5dfd 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.6 $ + * $Revision: 1.7 $ * - * last change: $Author: arellano $ $Date: 2001-04-13 20:49:34 $ + * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,7 +78,7 @@ // 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 + the feature changes. @see XController @see XStatusListener */ struct FeatureStateEvent: com::sun::star::lang::EventObject @@ -116,8 +116,6 @@ struct FeatureStateEvent: com::sun::star::lang::EventObject // 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 underline on/off. Some simple types like <code>string</code> or <atom>boolean</atom> are useful here for generic UI elements, like @@ -136,6 +134,9 @@ struct FeatureStateEvent: com::sun::star::lang::EventObject /*============================================================================= $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 diff --git a/offapi/com/sun/star/frame/Frame.idl b/offapi/com/sun/star/frame/Frame.idl index ea64d5bd7..5c3181d34 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.5 $ + * $Revision: 1.6 $ * - * last change: $Author: fs $ $Date: 2001-05-11 12:09:47 $ + * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -92,7 +92,7 @@ service Frame // DocMerge from xml: service com::sun::star::frame::Frame: interface com::sun::star::frame::XFrame - /** allows the component to be load and accessed + /** allows the component to be loaded and accessed within the frame; it is the main connection to the environment of the component. */ @@ -101,26 +101,22 @@ service Frame /** provides access to dispatchers for the frame. <p>What kind of URLs a frame accepts in the calls to <method>XDispatchProvider::queryDispatch</method>, - and how the returned dispatcher handles dispatches is completely implementation dependent (though of course - the restrictions of <type>XDispatchProvider</type> must be met).</p> + 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, require special frame search - flags (see <type>FrameSearchFlag</type>), or, in opposite, limit the set of allowed flags.<br/> - Common special targets include:<br/> + <p>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> - <br/> <li><b>_self</b> forces the frame to dispatch the URL into itself.</li> - <br/> <li><b>_parent</b> dispatches the URL into the parent frame.</li> - <br/> - <li><b>_top</b> dispatches the URL into the top level frame the frame where this is invoked belongs to.</li> - <br/> + <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> - <br/> </ul> </p> @@ -151,6 +147,9 @@ service Frame /*============================================================================= $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 diff --git a/offapi/com/sun/star/frame/FrameAction.idl b/offapi/com/sun/star/frame/FrameAction.idl index f770a74df..be0366e66 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.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:14 $ + * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,9 +80,7 @@ enum FrameAction /** An event of this kind is broadcast whenever a component is attached to a frame. - - - <p>This is almost the same as the instanciation 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 */ @@ -93,14 +91,11 @@ enum FrameAction // 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 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. - + moment it won't. </p> */ COMPONENT_DETACHING, @@ -111,8 +106,6 @@ enum FrameAction /** 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> */ @@ -124,8 +117,6 @@ enum FrameAction /** 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>@see XFrame::activated */ @@ -137,27 +128,21 @@ enum FrameAction /** An event of this kind is broadcasted immediately before the component is deactivated. - - <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::contextChanged */ FRAME_DEACTIVATING, //------------------------------------------------------------------------- // DocMerge from xml: value com::sun::star::frame::FrameAction::CONTEXT_CHANGED - /** An event of this kind is broadcast whenever a component changed - its internal context (i.e. the selection). - - + /** 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 a context change too. - </p> */ CONTEXT_CHANGED, @@ -187,6 +172,9 @@ enum FrameAction /*============================================================================= $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 diff --git a/offapi/com/sun/star/frame/FrameActionEvent.idl b/offapi/com/sun/star/frame/FrameActionEvent.idl index b1874e92d..7f4657750 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-21 08:35:10 $ + * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -82,7 +82,7 @@ // 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 + components within frames. @see XFrameActionListener */ struct FrameActionEvent: com::sun::star::lang::EventObject { @@ -109,6 +109,9 @@ struct FrameActionEvent: com::sun::star::lang::EventObject /*============================================================================= $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 diff --git a/offapi/com/sun/star/frame/FrameControl.idl b/offapi/com/sun/star/frame/FrameControl.idl index 4f83bdba8..1f796fde3 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.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:14 $ + * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,8 +79,6 @@ // 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> */ @@ -102,7 +100,7 @@ service FrameControl //------------------------------------------------------------------------- // DocMerge from xml: property com::sun::star::frame::FrameControl::ComponentUrl - /** contains the type of the component which is loaded into the frame + /** contains the type of the component which is loaded into the frame, or the document which implicitly specifies the type. */ [property] string ComponentUrl; @@ -124,6 +122,9 @@ service FrameControl /*============================================================================= $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 diff --git a/offapi/com/sun/star/frame/FrameLoader.idl b/offapi/com/sun/star/frame/FrameLoader.idl index 03a90313a..f51e3e2a3 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: arellano $ $Date: 2001-04-24 00:07:05 $ + * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,9 +75,7 @@ /** 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> @@ -95,6 +93,9 @@ service FrameLoader /*============================================================================= $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 diff --git a/offapi/com/sun/star/frame/FrameLoaderFactory.idl b/offapi/com/sun/star/frame/FrameLoaderFactory.idl index b631c2e54..7748c4c92 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.1 $ + * $Revision: 1.2 $ * - * last change: $Author: as $ $Date: 2000-11-20 10:06:11 $ + * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,33 +80,32 @@ module com { module sun { module star { module frame { service FrameLoaderFactory { //------------------------------------------------------------------------- - /** interface to create the loader - + /**interface to create the loader <p> - After a <type>TypeDetection</type> you can use these interface to create the right loader to load - the document into a frame. Give us an internal type name and we create a suitable <type>XSynchronousFrameLoader</type> - or< type>XFrameLoader</type> and return it at calling XMultiServiceFactory::createInstance...() + 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! @attention Method XMultiServiceFactory::getAvailableServiceNames() isn't supported! - Please use XNameAcces of these service for access on loader configuration. + Please use XNameAcces of these service for access on loader configuration. </p> */ interface com::sun::star::lang::XMultiServiceFactory; //------------------------------------------------------------------------- - /** readonly access to loader configuration + /**readonly access to 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! - - Supported properties are: - name of property 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 - </p> - */ + 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> */ interface com::sun::star::container::XNameAccess; }; diff --git a/offapi/com/sun/star/frame/FramesContainer.idl b/offapi/com/sun/star/frame/FramesContainer.idl index 83e7b6daf..ad2745f78 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-21 08:35:10 $ + * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,10 +79,7 @@ // 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. - </p>@see Frame */ service FramesContainer @@ -102,6 +99,9 @@ service FramesContainer /*============================================================================= $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 diff --git a/offapi/com/sun/star/frame/MediaTypeDetectionHelper.idl b/offapi/com/sun/star/frame/MediaTypeDetectionHelper.idl index 2cca8c5e3..d0539df16 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.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:14 $ + * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,8 +73,8 @@ // DocMerge from xml: service com::sun::star::frame::MediaTypeDetectionHelper -/** provides a mapping for a given sequence of ContentIdentifierStrings to - a sequence of belonging MediaType's +/** provides for mapping a given sequence of ContentIdentifierStrings + to a sequence of respective MediaTypes. */ service MediaTypeDetectionHelper { @@ -94,6 +94,9 @@ 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 diff --git a/offapi/com/sun/star/frame/SynchronousFrameLoader.idl b/offapi/com/sun/star/frame/SynchronousFrameLoader.idl index 9c312275e..728b56bbf 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.1 $ + * $Revision: 1.2 $ * - * last change: $Author: as $ $Date: 2000-11-20 10:06:11 $ + * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,24 +83,21 @@ /** 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> */ service FrameLoader { //------------------------------------------------------------------------- - /** support synchron loading + /**support synchron loading */ interface com::sun::star::frame::XSynchronousFrameLoader; //------------------------------------------------------------------------- - /** support initialization of loader with his own configuration! - + /** support initialization of loader with its own configuration! <p> - A loader can support a readonly access to his own configuration. + 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>. @@ -109,18 +106,20 @@ service FrameLoader [optional] interface com::sun::star::lang::XInitialization; //------------------------------------------------------------------------- - /** readonly(!) access to loader configuration - + /**readonly(!) access to loader configuration <p> - These interface support a readonly access to our internal configuration of THESE loader. - The loader himself get his configuration about <type>XInitialization</type> at creation by using + 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> */ [optional] interface com::sun::star::beans::XPropertySet; - [optional, property, readonly] sequence< string > Types ; /// loader is registered for these types - [optional, property, readonly] string UIName ; /// localized name of loader to show it at UI elements + /// 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 ; }; //============================================================================= @@ -130,6 +129,9 @@ service FrameLoader /*============================================================================= $Log: not supported by cvs2svn $ + 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 diff --git a/offapi/com/sun/star/frame/TemplateAccess.idl b/offapi/com/sun/star/frame/TemplateAccess.idl index 73ec32e22..770640bc1 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.2 $ + * $Revision: 1.3 $ * - * last change: $Author: dv $ $Date: 2001-03-09 15:11:33 $ + * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,12 +77,11 @@ module com { module sun { module star { module frame { //============================================================================= // DocMerge from xml: service com::sun::star::frame::TemplateAccess -/** specifies a collection of TemplateAccess. - - +/**specifies a collection of TemplateAccess. <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 + <type>Desktop</type> object via the <type>XDesktop</type> interface. </p> + @see com::sun::star::lang::XComponent @see XDesktop */ service TemplateAccess diff --git a/offapi/com/sun/star/frame/TerminationVetoException.idl b/offapi/com/sun/star/frame/TerminationVetoException.idl index 3eafe485f..1b5b59ccb 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.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:14 $ + * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,7 +73,7 @@ //============================================================================= // DocMerge from xml: exception com::sun::star::frame::TerminationVetoException -/** This exception can be thrown to prevent the environment (e.g. desktop) +/** This exception can be thrown to prevent the environment (e.g., desktop) from terminating. */ exception TerminationVetoException: com::sun::star::uno::Exception @@ -87,6 +87,9 @@ 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 diff --git a/offapi/com/sun/star/frame/XComponentLoader.idl b/offapi/com/sun/star/frame/XComponentLoader.idl index fae271120..168815c21 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.9 $ + * $Revision: 1.10 $ * - * last change: $Author: mi $ $Date: 2001-03-22 17:25:56 $ + * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -90,7 +90,8 @@ module com { module sun { module star { module frame { // DocMerge from xml: interface com::sun::star::frame::XComponentLoader /** This is a simple interface to load components by an URL into a - frame environment.@see Desktop + frame environment. + @see Desktop @see Frame @see XFrame */ @@ -104,7 +105,7 @@ interface XComponentLoader: com::sun::star::uno::XInterface @param aURL specifies the URL of the document to load. To create new documents, - use "private:factory/scalc", "private:factory/swriter" etc. + use "private:factory/scalc", "private:factory/swriter", etc. @param aTargetFrameName specifies the name of the frame to view the document in. If a frame @@ -114,15 +115,15 @@ interface XComponentLoader: com::sun::star::uno::XInterface @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>. + how to find the specified <var>aTargetFrameName</var>. + Normally, simply use <code>0</code>. @param aArgs - these arguments specify component or filter specific behaviour. - For example "ReadOnly" with a boolean value specifies, whether - the document is opened read-only; "FilterName" specifies the - component type to create and filter to use (for example: - "scalc: Text - csv"). For more information see + these arguments specify component or filter specific behavior. + 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 <type scope="com::sun::star::document">MediaDescriptor</type>. */ com::sun::star::lang::XComponent loadComponentFromURL( [in] string aURL, @@ -141,6 +142,9 @@ interface XComponentLoader: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + 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 diff --git a/offapi/com/sun/star/frame/XComponentRegistry.idl b/offapi/com/sun/star/frame/XComponentRegistry.idl index 7d2ed4acd..b25615826 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.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-03-22 17:26:29 $ + * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,7 +77,7 @@ //============================================================================= // DocMerge from xml: interface com::sun::star::frame::XComponentRegistry -/** makes it possible to instanciate desktop components. +/** makes it possible to instantiate desktop components. @deprecated @see XFrame @@ -99,6 +99,9 @@ interface XComponentRegistry: com::sun::star::uno::XInterface /*============================================================================= $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 diff --git a/offapi/com/sun/star/frame/XConfigManager.idl b/offapi/com/sun/star/frame/XConfigManager.idl index 4e3236d6f..f06b1f085 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -84,15 +84,11 @@ 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" - - - <p> - If "sKeyName" a group of keys, the listener become one notify for every subkey!</p> - */ + + <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 ) ; //------------------------------------------------------------------------- diff --git a/offapi/com/sun/star/frame/XController.idl b/offapi/com/sun/star/frame/XController.idl index c0a12d4f5..e3fc83dd0 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.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,8 +76,8 @@ 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 + events (by supplying dispatches). @see XModel + @see XFrame @see com::sun::star::awt::XWindow */ interface XController: com::sun::star::lang::XComponent @@ -114,13 +114,8 @@ interface XController: com::sun::star::lang::XComponent //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::frame::XController::restoreViewData - /** restores the view status using the data gotten from a previous call to - - - - - - . + /** restores the view status using the data gotten from a previous call to + <member>XController::getViewData</member>. */ void restoreViewData( [in] any Data ); @@ -149,6 +144,9 @@ interface XController: com::sun::star::lang::XComponent /*============================================================================= $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 diff --git a/offapi/com/sun/star/frame/XDesktop.idl b/offapi/com/sun/star/frame/XDesktop.idl index f2ee4eb62..e8d3fc9ba 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.6 $ + * $Revision: 1.7 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -91,8 +91,6 @@ // 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 frames. Frames are like frames in HTML framesets. This does not imply that a desktop can handle framesets; the frames may be top frames @@ -107,9 +105,7 @@ 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 + <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. @@ -122,7 +118,7 @@ interface XDesktop: com::sun::star::uno::XInterface // 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 + when the desktop is queried to terminate, and when it really terminates. */ [oneway] void addTerminateListener( [in] com::sun::star::frame::XTerminateListener xListener ); @@ -131,12 +127,7 @@ interface XDesktop: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::frame::XDesktop::removeTerminateListener /** unregisters an event listener which was registered with - - - - - - . + <member>XDesktop::addTerminateListener</member>. */ [oneway] void removeTerminateListener( [in] com::sun::star::frame::XTerminateListener xListener ); @@ -146,8 +137,8 @@ interface XDesktop: com::sun::star::uno::XInterface /** @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 + <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. <p>The service, <type>Components</type>, which is available from this @@ -165,7 +156,7 @@ interface XDesktop: com::sun::star::uno::XInterface 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 existsm it is the active controller + active component. If no model exists it is the active controller (view) itself. */ com::sun::star::lang::XComponent getCurrentComponent(); @@ -188,6 +179,9 @@ interface XDesktop: com::sun::star::uno::XInterface /*============================================================================= $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 diff --git a/offapi/com/sun/star/frame/XDispatch.idl b/offapi/com/sun/star/frame/XDispatch.idl index 20fd48024..7f903eeff 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.6 $ + * $Revision: 1.7 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -86,7 +86,7 @@ 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). + controllers (e.g., toolbox controllers). <p>Each state change is to be broadcast to all registered status listeners. The first notification should be performed @@ -95,10 +95,10 @@ module com { module sun { module star { module frame { synchronous notification.</p> <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 reget the value - for the URL to which it is connected. Additionally a context-switch-event - is to be broadcast whenever the object may be out of scope + 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> @see StatusEvent @@ -112,12 +112,10 @@ 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 you get this - <type>XDispatch</type>. Additional arguments "'#..." or "?...") are - allowed.</p> - - @example + <p>It is only allowed to dispatch URLs for which this <type>XDispatch</type> + was explicitely queried. Additional arguments "'#..." or "?...") are allowed.</p> + @example <listing> // some code for a click-handler of a hyperlink in a view XFrame xTargetFrame = m_xFrame-&gt;findFrame( @@ -137,8 +135,8 @@ interface XDispatch: com::sun::star::uno::XInterface /** 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 you got this - <type>XDispatch</type>. 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.</p> @see XDispatch::removeStatusListener */ @@ -164,6 +162,9 @@ interface XDispatch: com::sun::star::uno::XInterface /*============================================================================= $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 diff --git a/offapi/com/sun/star/frame/XDispatchProvider.idl b/offapi/com/sun/star/frame/XDispatchProvider.idl index ffc420fe2..2eca8c91d 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.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -105,7 +105,7 @@ interface XDispatchProvider: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::frame::XDispatchProvider::queryDispatches /** @returns - multiple dispatch interfaces for the specified descriptors at once. + multiple dispatch interfaces for the specified descriptors at once. <p>Actually this method is redundant to <member>XDispatchProvider::queryDispatch</member> to avoid multiple @@ -123,6 +123,9 @@ interface XDispatchProvider: com::sun::star::uno::XInterface /*============================================================================= $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 diff --git a/offapi/com/sun/star/frame/XDispatchProviderInterceptor.idl b/offapi/com/sun/star/frame/XDispatchProviderInterceptor.idl index 75ca9ca7c..c0e4d5154 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.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -91,12 +91,7 @@ interface XDispatchProviderInterceptor: com::sun::star::frame::XDispatchProvider // DocMerge from xml: method com::sun::star::frame::XDispatchProviderInterceptor::setSlaveDispatchProvider /** sets the slave <type>XDispatchProvider</type> to which calls to - - - - - - can be forwarded + <member>XDispatchProvider::queryDispatch</member> can be forwarded under control of this dispatch provider. */ void setSlaveDispatchProvider( [in] com::sun::star::frame::XDispatchProvider xNewDispatchProvider ); @@ -115,12 +110,7 @@ interface XDispatchProviderInterceptor: com::sun::star::frame::XDispatchProvider // DocMerge from xml: method com::sun::star::frame::XDispatchProviderInterceptor::setMasterDispatchProvider /** sets the master <type>XDispatchProvider</type>, which may forward - calls to its - - - - - + calls to its <member>XDispatchProvider::queryDispatch</member> to this dispatch provider. */ void setMasterDispatchProvider( [in] com::sun::star::frame::XDispatchProvider xNewSupplier ); @@ -134,6 +124,9 @@ 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 diff --git a/offapi/com/sun/star/frame/XDocumentTemplates.idl b/offapi/com/sun/star/frame/XDocumentTemplates.idl index 0e7502d79..462f7e29c 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.3 $ + * $Revision: 1.4 $ * - * last change: $Author: dv $ $Date: 2001-03-23 14:45:09 $ + * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -87,7 +87,7 @@ interface XDocumentTemplates: com::sun::star::uno::XInterface */ com::sun::star::ucb::XContent getContent(); - /** creates the tempate with the given name in the given group using the + /** creates the template with the given name in the given group using the data from the storable. */ boolean storeTemplate( [in] string GroupName, [in] string TemplateName, @@ -135,6 +135,9 @@ interface XDocumentTemplates: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2001/03/23 14:45:09 dv + added renameTemplate and renameGroup + Revision 1.2 2001/03/16 16:41:25 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/frame/XExtendedFilterDetection.idl b/offapi/com/sun/star/frame/XExtendedFilterDetection.idl index 69d8a959c..7ae414de5 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -97,7 +97,7 @@ interface XExtendedFilterDetection: com::sun::star::uno::XInterface <p> Implement it as an extra service for your frameloader to give information about - your responsibility for given URL. If you can handle these document return + 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> */ string detect( [in] string sURL, [in] sequence< com::sun::star::beans::PropertyValue > aArgumentlist ); diff --git a/offapi/com/sun/star/frame/XFrame.idl b/offapi/com/sun/star/frame/XFrame.idl index 55886ba76..84add640a 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.6 $ + * $Revision: 1.7 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -98,8 +98,6 @@ interface XFrame: com::sun::star::lang::XComponent // 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 controller window. </p> @@ -152,9 +150,7 @@ interface XFrame: com::sun::star::lang::XComponent // 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> @@ -162,9 +158,10 @@ interface XFrame: com::sun::star::lang::XComponent "_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 - itself is compared with the desired one, then ( again if allowed ) + itself is compared with the desired one, and then ( again if allowed ) the method - + + @@ -178,7 +175,7 @@ interface XFrame: com::sun::star::lang::XComponent for the parent frame (if allowed).</p> <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>. + created; if this is not suppressed by a special <type>FrameSearchFlag</type>. The new frame also gets the desired name.</p> */ com::sun::star::frame::XFrame findFrame( [in] string aTargetFrameName, @@ -189,16 +186,9 @@ interface XFrame: com::sun::star::lang::XComponent // 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 - - - - - + <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> */ @@ -209,12 +199,10 @@ interface XFrame: com::sun::star::lang::XComponent // 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? --> , @@ -226,7 +214,7 @@ interface XFrame: com::sun::star::lang::XComponent </p> <p>Finally, most frames may grab the focus to one of its windows or forward the activation to a sub-frame.</p> - */ +*/ [oneway] void activate(); //------------------------------------------------------------------------- @@ -281,13 +269,13 @@ interface XFrame: com::sun::star::lang::XComponent // 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? --> @@ -311,7 +299,7 @@ interface XFrame: com::sun::star::lang::XComponent - <p>E.g. it is possible to determine instantiation/destruction and + <p>E.g., it is possible to determine instantiation/destruction and activation/deactivation of components.</p> */ [oneway] void addFrameActionListener( [in]XFrameActionListener xListener ); @@ -333,6 +321,9 @@ interface XFrame: com::sun::star::lang::XComponent /*============================================================================= $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 diff --git a/offapi/com/sun/star/frame/XFrameActionListener.idl b/offapi/com/sun/star/frame/XFrameActionListener.idl index 0921dcd52..f4d545682 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,7 +80,7 @@ /** has to be provided if an object wants to receive events when several things happen to components within frames of the desktop. - <p>E.g. you can receive events of instanciation/destruction and + <p>E.g., you can receive events of instantiation/destruction and activation/deactivation of components. @see XDesktop::addFrameActionListener @@ -104,6 +104,9 @@ interface XFrameActionListener: com::sun::star::lang::XEventListener /*============================================================================= $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 diff --git a/offapi/com/sun/star/frame/XFrameLoaderQuery.idl b/offapi/com/sun/star/frame/XFrameLoaderQuery.idl index b00a4da16..939203398 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -85,7 +85,7 @@ // DocMerge from xml: interface com::sun::star::frame::XFrameLoaderQuery /** Use this interface together with a XMultiServiceFactory to implement a frame - loader. You can support detailed informations about supported with XFrameLoaderQuery + loader. You can support detailed information about supported properties with XFrameLoaderQuery and create matching loader with XMultiServiceFactory. @@ -113,7 +113,7 @@ interface XFrameLoaderQuery: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::frame::XFrameLoaderQuery::getLoaderProperties - /** return extended informations about all supported properties of an frame loader + /** 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 @@ -128,11 +128,11 @@ interface XFrameLoaderQuery: com::sun::star::uno::XInterface /** search a filter for given parameter <p> - If you don't know a filter name of a loader call these method to search anyone - which support given parameter. Use returned name to get further informations + 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 search for right loader again. + for faster creation! Otherwise, we must search for right loader again. (We look for FilterName first!)</p> */ string searchFilter( [in] string sURL, [in] sequence< com::sun::star::beans::PropertyValue > seqArguments ); diff --git a/offapi/com/sun/star/frame/XFramesSupplier.idl b/offapi/com/sun/star/frame/XFramesSupplier.idl index 16f5f67ef..752f23012 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -138,7 +138,8 @@ interface XFramesSupplier: XFrame 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 ); }; @@ -150,6 +151,9 @@ interface XFramesSupplier: XFrame /*============================================================================= $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 diff --git a/offapi/com/sun/star/frame/XInterceptorInfo.idl b/offapi/com/sun/star/frame/XInterceptorInfo.idl index b550ca810..a19e366d9 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.5 $ + * $Revision: 1.6 $ * - * last change: $Author: arellano $ $Date: 2001-04-24 00:10:37 $ + * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,7 +77,7 @@ <!-- Dennis: What is the "zB"? --> <!-- Dennis: What "gets" the URL lists? --> -*/ +<!-- JRH: Something still seems to be missing from here? -->*/ interface XInterceptorInfo: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- @@ -95,6 +95,9 @@ interface XInterceptorInfo: com::sun::star::uno::XInterface /*============================================================================= $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 diff --git a/offapi/com/sun/star/frame/XStorable.idl b/offapi/com/sun/star/frame/XStorable.idl index 642647d2a..236e21ad0 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.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-03-22 17:27:25 $ + * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -81,7 +81,7 @@ //============================================================================= // DocMerge from xml: interface com::sun::star::frame::XStorable -/** offers a simple way to store a component to a URL. +/** offers a simple way to store a component to an URL. @@ -167,7 +167,7 @@ interface XStorable: com::sun::star::uno::XInterface <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 + They describe how the data is to be stored. (E.g., the field delimitors for text database formats or the character set.) @@ -220,6 +220,9 @@ interface XStorable: com::sun::star::uno::XInterface /*============================================================================= $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 diff --git a/offapi/com/sun/star/frame/XTerminateListener.idl b/offapi/com/sun/star/frame/XTerminateListener.idl index d4ce7121a..c1a1d8fab 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -82,7 +82,7 @@ // 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 + when the master environment (e.g., desktop) is terminated.@see XDesktop::addTerminateListener @see XDesktop::removeTerminateListener */ interface XTerminateListener: com::sun::star::lang::XEventListener @@ -90,7 +90,7 @@ 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. + /** is called when the master environment (e.g., desktop) is about to terminate. */ void queryTermination( [in] com::sun::star::lang::EventObject aEvent ) raises( com::sun::star::frame::TerminationVetoException ); @@ -111,6 +111,9 @@ interface XTerminateListener: com::sun::star::lang::XEventListener /*============================================================================= $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 diff --git a/offapi/com/sun/star/frame/XUrlList.idl b/offapi/com/sun/star/frame/XUrlList.idl index 109cea666..311bf1b63 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,7 +71,7 @@ module com { module sun { module star { module frame { //============================================================================= -/** povides a list of URLs (i.e. to represent a selection). +/** provides a list of URLs (i.e., to represent a selection). @deprecated */ |