diff options
author | Kurt Zenker <kz@openoffice.org> | 2008-04-03 14:36:33 +0000 |
---|---|---|
committer | Kurt Zenker <kz@openoffice.org> | 2008-04-03 14:36:33 +0000 |
commit | 27c59a5da40548e3017bf03324960b6eb7bff7d0 (patch) | |
tree | 936062080bee007ea38b57fa69c54c81b21dc582 /offapi/com/sun/star/drawing/framework | |
parent | e3eaa121f8086771003a1ffc2c74be49ef47c80f (diff) |
INTEGRATION: CWS presenterview (1.2.24); FILE MERGED
2007/06/11 09:21:41 af 1.2.24.1: #i18486# Removed unnecessary interfaces.
Diffstat (limited to 'offapi/com/sun/star/drawing/framework')
11 files changed, 187 insertions, 185 deletions
diff --git a/offapi/com/sun/star/drawing/framework/BasicPaneFactory.idl b/offapi/com/sun/star/drawing/framework/BasicPaneFactory.idl index 62265b3eba9f..68c16db1912d 100644 --- a/offapi/com/sun/star/drawing/framework/BasicPaneFactory.idl +++ b/offapi/com/sun/star/drawing/framework/BasicPaneFactory.idl @@ -4,9 +4,9 @@ * * $RCSfile: BasicPaneFactory.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: rt $ $Date: 2007-04-03 16:40:57 $ + * last change: $Author: kz $ $Date: 2008-04-03 15:30:10 $ * * The Contents of this file are made available subject to * the terms of GNU Lesser General Public License Version 2.1. @@ -36,13 +36,16 @@ #ifndef __com_sun_star_drawing_framework_BasicPaneFactory_idl__ #define __com_sun_star_drawing_framework_BasicPaneFactory_idl__ +#ifndef __com_sun_star_frame_XController_idl__ +#include <com/sun/star/frame/XController.idl> +#endif #ifndef _COM_SUN_STAR_DRAWING_FRAMEWORK_XPANEFACTORY_IDL_ -#include <com/sun/star/drawing/framework/XPaneFactory.idl> +#include <com/sun/star/drawing/framework/XResourceFactory.idl> #endif module com { module sun { module star { module drawing { module framework { -/** The <type>BasicPaneFactory</pane> is a pane factory that provides the +/** The <type>BasicPaneFactory</pane> is a resource factory that provides the panes used by the Draw and Impress applications. <p>This factory provides the center, left, and right pane. For the left pane there are two URLS, <code>private:resource/floater/LeftImpressPane</code> @@ -50,9 +53,16 @@ module com { module sun { module star { module drawing { module framework { the other for Draw. The center pane and the right pane have the URLs <code>private:resource/floater/CenterPane</code> and <code>private:resource/floater/RightPane</code> respectively.</p> + <p>This factory is typically created indirectly by registering it in the + configuration and have the <type>XModuleController</type> create it on + demand.</p> */ -service BasicPaneFactory : com::sun::star::drawing::framework::XPaneFactory +service BasicPaneFactory : XResourceFactory { + /** Give the controller to new instances so that they have access to the + drawing framework controllers. + */ + create ([in] ::com::sun::star::frame::XController xController); }; }; }; }; }; }; // ::com::sun::star::drawing::framework diff --git a/offapi/com/sun/star/drawing/framework/BasicToolBarFactory.idl b/offapi/com/sun/star/drawing/framework/BasicToolBarFactory.idl index dad8b929d290..3afef370cd0a 100644 --- a/offapi/com/sun/star/drawing/framework/BasicToolBarFactory.idl +++ b/offapi/com/sun/star/drawing/framework/BasicToolBarFactory.idl @@ -4,9 +4,9 @@ * * $RCSfile: BasicToolBarFactory.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: rt $ $Date: 2007-04-03 16:41:23 $ + * last change: $Author: kz $ $Date: 2008-04-03 15:30:23 $ * * The Contents of this file are made available subject to * the terms of GNU Lesser General Public License Version 2.1. @@ -36,20 +36,36 @@ #ifndef __com_sun_star_drawing_framework_BasicToolBarFactory_idl__ #define __com_sun_star_drawing_framework_BasicToolBarFactory_idl__ -module com { module sun { module star { module drawing { module framework { +#ifndef __com_sun_star_frame_XController_idl__ +#include <com/sun/star/frame/XController.idl> +#endif +#ifndef _COM_SUN_STAR_DRAWING_FRAMEWORK_XPANEFACTORY_IDL_ +#include <com/sun/star/drawing/framework/XResourceFactory.idl> +#endif -interface XToolBarFactory; +module com { module sun { module star { module drawing { module framework { -/** The <type>BasicToolBarFactory</type> is a factory that provides the - tool bars used by the Draw and Impress applications. +/** The <type>BasicToolBarFactory</type> is a resource factory that provides + (some of) the tool bars used by the Draw and Impress applications. <p>The factory recognizes the following URLs:<ul> <li><code>private:resource/toolbar/ViewTabBar</code> for the tab bar that allows the switching between views.</li> - </ul></p> + </ul> + This short list marks the implementation of this service clearly as + being in transition. + </p> + + <p>This factory is typically created indirectly by registering it in the + configuration and have the <type>XModuleController</type> create it on + demand.</p> */ -service BasicToolBarFactory : com::sun::star::drawing::framework::XToolBarFactory +service BasicToolBarFactory : XResourceFactory { + /** Give the controller to new instances so that they have access to the + drawing framework controllers. + */ + create ([in] ::com::sun::star::frame::XController xController); }; }; }; }; }; }; // ::com::sun::star::drawing::framework diff --git a/offapi/com/sun/star/drawing/framework/BasicViewFactory.idl b/offapi/com/sun/star/drawing/framework/BasicViewFactory.idl index a46ed5c93ac1..7a678e4691cf 100644 --- a/offapi/com/sun/star/drawing/framework/BasicViewFactory.idl +++ b/offapi/com/sun/star/drawing/framework/BasicViewFactory.idl @@ -4,9 +4,9 @@ * * $RCSfile: BasicViewFactory.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: rt $ $Date: 2007-04-03 16:41:35 $ + * last change: $Author: kz $ $Date: 2008-04-03 15:30:37 $ * * The Contents of this file are made available subject to * the terms of GNU Lesser General Public License Version 2.1. @@ -36,13 +36,16 @@ #ifndef __com_sun_star_drawing_framework_BasicViewFactory_idl__ #define __com_sun_star_drawing_framework_BasicViewFactory_idl__ -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> +#ifndef __com_sun_star_frame_XController_idl__ +#include <com/sun/star/frame/XController.idl> +#endif +#ifndef __com_sun_star_drawing_framework_XResourceFactory_idl__ +#include <com/sun/star/drawing/framework/XResourceFactory.idl> #endif module com { module sun { module star { module drawing { module framework { -/** The <type>BasicViewFactory</pane> is a view factory that provides the +/** The <type>BasicViewFactory</type> is a view factory that provides the panes used by the Draw and Impress applications. <p>The factory recognizes the following URLs:<ul> @@ -59,8 +62,12 @@ module com { module sun { module star { module drawing { module framework { <li><code>private:resource/view/TaskPane</code> for the task pane.</li> </ul></p> */ -service BasicViewFactory : com::sun::star::uno::XInterface +service BasicViewFactory : XResourceFactory { + /** Give the controller to new instances so that they have access to the + drawing framework controllers. + */ + create ([in] ::com::sun::star::frame::XController xController); }; }; }; }; }; }; // ::com::sun::star::drawing::framework diff --git a/offapi/com/sun/star/drawing/framework/XConfigurationChangeRequest.idl b/offapi/com/sun/star/drawing/framework/XConfigurationChangeRequest.idl index ae36bb720ae2..da0a325f2bde 100644 --- a/offapi/com/sun/star/drawing/framework/XConfigurationChangeRequest.idl +++ b/offapi/com/sun/star/drawing/framework/XConfigurationChangeRequest.idl @@ -4,9 +4,9 @@ * * $RCSfile: XConfigurationChangeRequest.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: rt $ $Date: 2007-04-03 16:44:12 $ + * last change: $Author: kz $ $Date: 2008-04-03 15:31:56 $ * * The Contents of this file are made available subject to * the terms of GNU Lesser General Public License Version 2.1. @@ -49,23 +49,19 @@ interface XConfiguration; /** A single explicit request for a configuration change. - <p>The one explicitly represented change request may lead to other, - implicit, configuration changes when executed. For example, when the - deactivation of a pane is requested, then the view displayed in it has - also to be deactivated.</p> <p>The requested change is committed to a configuration only when the <member>execute()</member> method is called. Configuration change requests are executed asynchronously. This is done to avoid reentrance problems with objects that are registered as <type>XConfigurationChangeListener</type> and at the same time make configuration change requests. When the requests were executed - synchronously then they would be notified of the changes while their - request call has not yet returned.</p> - @see XConfiguration - @see XConfigurationController + synchronously then the listeners would be notified of the changes while + their request call has not yet returned.</p> + + <p>This interface is typically used internally by the + <type>XConfigurationController</type></p> @see XConfigurationController */ interface XConfigurationChangeRequest - : ::com::sun::star::uno::XInterface { /** Commit the configuration change request represented by the called object to the given configuration. diff --git a/offapi/com/sun/star/drawing/framework/XConfigurationController.idl b/offapi/com/sun/star/drawing/framework/XConfigurationController.idl index 5336eaed393f..9ebec50eb3a3 100644 --- a/offapi/com/sun/star/drawing/framework/XConfigurationController.idl +++ b/offapi/com/sun/star/drawing/framework/XConfigurationController.idl @@ -4,9 +4,9 @@ * * $RCSfile: XConfigurationController.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: rt $ $Date: 2007-04-03 16:44:22 $ + * last change: $Author: kz $ $Date: 2008-04-03 15:32:18 $ * * The Contents of this file are made available subject to * the terms of GNU Lesser General Public License Version 2.1. @@ -36,9 +36,6 @@ #ifndef __com_sun_star_drawing_framework_XConfigurationController_idl__ #define __com_sun_star_drawing_framework_XConfigurationController_idl__ -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif #ifndef __com_sun_star_drawing_framework_ConfigurationChangeEvent_idl__ #include <com/sun/star/drawing/framework/ConfigurationChangeEvent.idl> #endif @@ -48,6 +45,9 @@ #ifndef __com_sun_star_drawing_framework_XConfigurationControllerRequestQueue_idl__ #include <com/sun/star/drawing/framework/XConfigurationControllerRequestQueue.idl> #endif +#ifndef __com_sun_star_drawing_framework_XResourceFactoryManager_idl__ +#include <com/sun/star/drawing/framework/XResourceFactoryManager.idl> +#endif #ifndef __com_sun_star_drawing_framework_ResourceActivationMode_idl__ #include <com/sun/star/drawing/framework/ResourceActivationMode.idl> #endif @@ -56,23 +56,24 @@ module com { module sun { module star { module drawing { module framework { interface XConfigurationChangeListener; interface XConfigurationChangeRequest; +interface XResourceId; +interface XResource; -/** The configuration controller is responsible for the synchronization of - other controllers for the management of resources like panes, views, - tool bars, and command groups. +/** The configuration controller is responsible for the management of the + set of active resources. <p>There are two configurations of resources:<ul> - <li>The current configuration describes the state of resources as - it is.</li> - <li>The requested configuration describes how it should be. The - requested configuration is changed usually by calling + <li>The current configuration contains the set of currently active + resources.</li> + <li>The requested configuration describes what the current configuration + should be. The requested configuration is changed usually by calling <member>requestResourceActivation()</member> and - <member>requestResourceDeactivation()</member>. Other sub controllers - may offer other methods for requesting configuration changes.</li> + <member>requestResourceDeactivation()</member>.</li> </ul></p> - <p>When the two differ then the current configuration is updated eventually - to reflect the requested one + <p>When the two configurations differ then the current configuration is + updated eventually to reflect the requested configuration. An update + takes place when the following three conditions are fullfilled. <ol> <li>when the last pending request for configuration changes has been processed,</li> @@ -84,28 +85,36 @@ interface XConfigurationChangeRequest; <p>Requests for configuration changes are handled in a two step process: <ol> <li>First the requested configuration is updated iteratively: Every - request that is being made by e.g. calling + request that is being made by calling <member>requestResourceActivation()</member> or <member>requestResourceDeactivation()</member> results in one or more function objects, that each implement the - <type>XConfigurationChangeRequest</type> interface, being inserted - into a queue. The request objects in the queue are processed one at a - time in the order in which they are inserted. Only when one request - object is processed a change to the requested configuration is made. - These changes are broadcasted. Listeners may decide to add more request - objects to the queue. For example when the view in the center pane is - replaced by another view, some listeners may want to turn some side - panes on or off, or show other views in the side panes.</p> + <type>XConfigurationChangeRequest</type> interface. These are inserted + into a queue. The request objects in the queue are processed + asynchronously one at a time in the order in which they are inserted. + Only when one request object is processed a change to the requested + configuration is made. These changes are broadcasted to registered + <type>XConfigurationChangeListener</type> objects. Listeners may + decide to make requests that then are added to the queue. For example + when the view in the center pane is replaced by another view, some + listeners may want to turn some side panes on or off, or show other + views in the side panes.</p> <p>This process goes on until the queue of request objects becomes empty. Until this point only the requested configuration has been modified. No resources have been activated or deactivated.</p></li> + <li><p>The second update step activates or deactivates resources so that the current configuration (the one that comprises the actually active resources) reflects the requested configuration.</p> + <p>The order in which resources are activated or deactivated depends on + the dependency between the resources. For example a view depends on the + pane it is displayed in. Resources that other resources depend on are + activated first and deactivated last. The order is undefined for + unrelated resources.</p> <p>Note that the second update step may not be able to activate (or even to deactivate) all the requested resources. Either because they are temporarily or permanently unavailable. For example, during the - start-up of a new Impress application frame the side panes are displayed + start-up of a new Impress application the side panes are displayed with a visible delay because they are not provided sooner by the underlying framework. Such anavailable resources are not forgotten but remain in the requested configuration. Every time the configuration @@ -117,12 +126,12 @@ interface XConfigurationChangeRequest; <li><const>ResourceActivationRequested</const> is sent when the activation of a resource has been requested and the resource is not yet active in the requested configuration. The event is sent when the - configuration change request is executed that is created when for - example <member>requestResourceActivation()</member> is called.</p> - <p>The <member>ResourceId</member> member is set to the requested - resource. The <member>ResourceObject</member> member is not not + configuration change request is executed, not when the + <member>requestResourceActivation()</member> call is made.</p> + <p>The <member scope="ConfigurationChangeEvent">ResourceId</member> member is set to the requested + resource. The <member>ResourceObject</member> member is not set.</p></li> - <li><const>ResourceDeactivationRequest</const> is sent when the + <li><const>ResourceDeactivationRequested</const> is sent when the deactivation of a resource has been requested and the resource is active in the requested configuration. The event is sent when the configuration change request is executed that is created when for @@ -131,35 +140,28 @@ interface XConfigurationChangeRequest; resource. The <member>ResourceObject</member> member is not set.</p></li> <li><const>ConfigurationUpdateStart</const> is sent before the update of - the current configuration is started.</p> - <p>The requested configuration is available in the <type - scope="ConfigurationChangeEvent">Configuration</type> member. The + the current configuration starts.</p> + <p>The requested configuration is available in the <member + scope="ConfigurationChangeEvent">Configuration</member> member. The <member>ResourceId</member> and <member>ResourceObject</member> members are not set.</p></li> - <li><const>ConfigurationUpdateEnd</const> is sent before the update of - the current configuration is started.</p> + <li><const>ConfigurationUpdateEnd</const> is sent after the update of + the current configuration ends.</p> <p>The requested configuration is - available in the <type scope="ConfigurationChangeEvent" - >Configuration</type> member. The <member>ResourceId</member> and + available in the <member scope="ConfigurationChangeEvent" + >Configuration</member> member. The <member>ResourceId</member> and <member>ResourceObject</member> members are not set.</p></li> - </ul></p> - - <p>The sub controllers that manage individual resources (like - <type>XPaneController</type>, <type>XViewController</type>, - <type>XToolbarController</type>, and <type>XCommandController</type>) - send the following events: - <ul> <li><const>ResourceActivation</const> is sent when a resource is activated, i.e. when a new object of a resource is created (or taken from a cash).</p> <p>The <member>ResourceId</member> and <member>ResourceObject</member> - members are set to the <type>ResourceId</type> and object reference of + members are set to the <type>XResourceId</type> and object reference of the activated resource.</p></li> <li><const>ResourceDeactivation</const> is sent when a resource is deactivated, i.e. when an object that previously was part of the configuration is removed from the configuration.</p> <p>The <member>ResourceId</member> and <member>ResourceObject</member> - members are set to <type>ResourceId</type> and object reference of the + members are set to <type>XResourceId</type> and object reference of the deactivated resource.</p></li> </ul></p> */ @@ -167,6 +169,7 @@ interface XConfigurationController { interface XConfigurationControllerRequestQueue; interface XConfigurationControllerBroadcaster; + interface XResourceFactoryManager; /** Request the activation of a resource. <p>The request is processed asynchronously. Notifications about @@ -198,9 +201,22 @@ interface XConfigurationController void requestResourceDeactivation ( [in] XResourceId xResourceId); + + /** Return the active resource specified by the given resource id. + @param xResourceId + A valid resource id. This should, but does not have to be, the + resource id of an active resource. + @return + When the given resource id specifies an active resource then + that resource is returned. Otherwise an empty reference is + returned. + */ + XResource getResource ( + [in] XResourceId xResourceId); + /** Lock the processing of configuration change requests. <p>This is only necessary when more than one change request is being - made. It prevents an update being made (with all the visible UI + made in a row. It prevents an update being made (with all the visible UI changes) before all change requests are being made.</p> <p>Recursive <member>lock()</member> calls are recognized: the configuration controller is locked while <member>lock()</member> was @@ -208,7 +224,7 @@ interface XConfigurationController */ void lock (); - /** Unlock the processing of configuration changes requests. + /** Unlock the processing of configuration change requests. <p>When <member>unlock()</member> is called as many times as <member>lock()</member> and the queue of configuration change requests is not empty the configuration controller continues the @@ -226,25 +242,35 @@ interface XConfigurationController void update (); /** Return a copy of the requested configuration. - <p>The returned requested configuration reflects the current - configuration (more or less, there may be requested but anavailable - resources) after the last <member>update()</member> call and when no further - change requests have been made. + <p>Modifications to the returned configuration have no effect on the + drawing framework.</p> + */ + XConfiguration getRequestedConfiguration (); + + /** Return a copy of the current configuration. + <p>Modifications to the returned configuration have no effect on the + drawing framework.</p> */ - XConfiguration getConfiguration (); - - /** Replace the requested configuraion with the given configuration and - update the current configuration accordingly. - <p>Together with the <member>getConfiguration()<member> method this - allows the saving and restoring of configurations.</p> - <p>The given configuration is treated like a bunch of change - requests made by calling the - <member>requestResourceActivation()</member> and - <member>requestResourceDeactivation()</member> methods. - Requested configuration changes are notified so that listeners can react.</p> + XConfiguration getCurrentConfiguration (); + + /** Replace the requested configuration with the given configuration and + schedule an update of the current configuration. + <p>Together with the <member>getCurrentConfiguration()</member> and + <member>getRequestedConfiguration()</member> methods this + allows the saving and restoring of configurations. However, the + given configuration can have other origins then these methods.</p> + <p>The given configuration is transformed into a list of of change + requests so that the resulting reqeusted configuration equals the + given configuration. This has the advantage that not only the + resource activations and deactivations but all configuration + changes are properly broadcasted.</p> + <p>Note that because of the configuration change notifications + listeners can make more configuratio change requests, so that the + resulting requested configuration can be different from the given + configuration.</p> @param xConfiguration This typically is a configuration that was obtained with an - earlier <member>getConfiguration()</member> call. + earlier <member>getRequestedConfiguration()</member> call. */ void restoreConfiguration ([in] XConfiguration xConfiguration); }; diff --git a/offapi/com/sun/star/drawing/framework/XConfigurationControllerRequestQueue.idl b/offapi/com/sun/star/drawing/framework/XConfigurationControllerRequestQueue.idl index 49547de3b431..0cc6ab8218b5 100644 --- a/offapi/com/sun/star/drawing/framework/XConfigurationControllerRequestQueue.idl +++ b/offapi/com/sun/star/drawing/framework/XConfigurationControllerRequestQueue.idl @@ -4,9 +4,9 @@ * * $RCSfile: XConfigurationControllerRequestQueue.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: rt $ $Date: 2007-04-03 16:44:43 $ + * last change: $Author: kz $ $Date: 2008-04-03 15:32:30 $ * * The Contents of this file are made available subject to * the terms of GNU Lesser General Public License Version 2.1. @@ -48,16 +48,11 @@ interface XConfigurationChangeRequest; changes to the current configuration. <p>This interface allows callers to add requests to the back of the - queue and to determine wheter the queue is empty.</p> - - <p>This interface is typically called only by (resource) controllers of - the drawing framework. Other code should call the - <member>XConfigurationController::requestResourceActivation()</member> and - <member>XConfigurationController::requestResourceDeactivation()</member> - functions instead.</p> + queue and to determine wheter the queue is empty. Using this interace + should normally not be necessary for anyone else than the + <type>XConfigurationController</type>. It may be removed in the future.</p> */ interface XConfigurationControllerRequestQueue - { /** Return whether there are pending requests for configuration changes. @return diff --git a/offapi/com/sun/star/drawing/framework/XControllerManager.idl b/offapi/com/sun/star/drawing/framework/XControllerManager.idl index 66cb85e8db09..8dcb32737d36 100644 --- a/offapi/com/sun/star/drawing/framework/XControllerManager.idl +++ b/offapi/com/sun/star/drawing/framework/XControllerManager.idl @@ -4,9 +4,9 @@ * * $RCSfile: XControllerManager.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: rt $ $Date: 2007-04-03 16:44:53 $ + * last change: $Author: kz $ $Date: 2008-04-03 15:32:43 $ * * The Contents of this file are made available subject to * the terms of GNU Lesser General Public License Version 2.1. @@ -42,68 +42,28 @@ module com { module sun { module star { module drawing { module framework { -interface XCommandController; interface XConfigurationController; interface XModuleController; -interface XPaneController; -interface XResourceController; -interface XToolBarController; -interface XViewController; -/** The XControllerManager gives access to the sub controllers that provide - the different aspects of the drawing framework. - <p><strong>This interface is not yet in its final form and will probably change - considerably.</strong></p> +/** The XControllerManager gives access to the controllers of the drawing + framework. <p>The <type>XControllerManager</type> interface is typically implemented by the same object that implements <type scope="com::sun::star::frame">XController</type>.</p> - <p>The sub controllers that this interface gives access to come from - different sources: - <ul><li>The core sub controllers are created by instantiating a service - from a predefined set of services. These are <type>CommandController</type>, - <type>ConfigurationController</type>, <type>ModuleController</type>, - <type>PaneController</type>, <type>ToolbarController</type>, and - <type>ViewController</type>. There explicit access methods for all of - these services.</li> - <li>Optional sub controllers that are created by instantiating - services can be added and removed with the - <member>registerController()</member> and - <member>removeController()</member> methods.</li> - <li>Optional sub controllers who are added as living objects. There are - not methods for this yet.</li> - </ul> - One motivation for optional sub controllers that can be added at runtime - is to allow the slide sorter register a sub controller that exports its - (multi) selection. This selection is used for example by controls in - the task pane. A sub controller is one way of providing a central - access point to the selection of the slide sorter which may be shown - either in the center pane or the left pane or not at all.</p> */ -interface XControllerManager : - ::com::sun::star::uno::XInterface +interface XControllerManager { - void registerResourceController ( - [in] string sServiceName, - [in] XResourceController xController); - - void removeResourceController ( - [in] XResourceController xController); - - sequence<XResourceController> getResourceControllers (); - - /** Return an instance of a sub controller that implements the specified - service. + /** Return the <type>XConfigurationController</type> object. + @return + The returned reference is never empty. */ - ::com::sun::star::uno::XInterface getController ( [in] string sServiceName); - - XCommandController getCommandController (); XConfigurationController getConfigurationController (); - XModuleController getModuleController (); - XPaneController getPaneController (); - XToolBarController getToolBarController (); - XViewController getViewController (); - void releaseController ( [in] ::com::sun::star::uno::XInterface xController); + /** Return the <type>XModuleController</type> object. + @return + The returned reference is never empty. + */ + XModuleController getModuleController (); }; }; }; }; }; }; // ::com::sun::star::drawing::framework diff --git a/offapi/com/sun/star/drawing/framework/XModuleController.idl b/offapi/com/sun/star/drawing/framework/XModuleController.idl index 53280426b39d..4fdf2fcbed3e 100644 --- a/offapi/com/sun/star/drawing/framework/XModuleController.idl +++ b/offapi/com/sun/star/drawing/framework/XModuleController.idl @@ -4,9 +4,9 @@ * * $RCSfile: XModuleController.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: rt $ $Date: 2007-04-03 16:45:20 $ + * last change: $Author: kz $ $Date: 2008-04-03 15:32:56 $ * * The Contents of this file are made available subject to * the terms of GNU Lesser General Public License Version 2.1. @@ -63,7 +63,6 @@ interface XView; Impress.xcu file.</p> */ interface XModuleController - : ::com::sun::star::uno::XInterface { /** When the specified resource is requested for the first time then create a new instance of the associated factory service. diff --git a/offapi/com/sun/star/drawing/framework/XPane.idl b/offapi/com/sun/star/drawing/framework/XPane.idl index f771efe182a5..1b563d3c6256 100644 --- a/offapi/com/sun/star/drawing/framework/XPane.idl +++ b/offapi/com/sun/star/drawing/framework/XPane.idl @@ -4,9 +4,9 @@ * * $RCSfile: XPane.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: rt $ $Date: 2007-04-03 16:45:30 $ + * last change: $Author: kz $ $Date: 2008-04-03 15:33:10 $ * * The Contents of this file are made available subject to * the terms of GNU Lesser General Public License Version 2.1. @@ -36,9 +36,6 @@ #ifndef __com_sun_star_drawing_framework_XPane_idl__ #define __com_sun_star_drawing_framework_XPane_idl__ -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif #ifndef __com_sun_star_awt_XWindow_idl__ #include <com/sun/star/awt/XWindow.idl> #endif @@ -48,27 +45,24 @@ #ifndef __com_sun_star_drawing_framework_XResource_idl__ #include <com/sun/star/drawing/framework/XResource.idl> #endif +#ifndef __com_sun_star_drawing_framework_XRelocatableResource_idl__ +#include <com/sun/star/drawing/framework/XRelocatableResource.idl> +#endif module com { module sun { module star { module drawing { module framework { /** A pane is an abstraction of a window and is one of the resources managed by the drawing framework. - <p>Apart from the area that displays the view a pane usually contains other + <p>Apart from the area that displays a view a pane may contain other parts like title, menu, closer button.</p> <p>The URL prefix of panes is <code>private:resource/floater</code></p> - <p>Implementations of <type>XPane</type> may implement - <type>XTabBar</type> as well.</p> - @see XPaneController - @see XPaneFactory - @see XTabBar */ interface XPane - : ::com::sun::star::drawing::framework::XResource { + interface XResource; + /** Return the <type scope="com::sun::star::awt">XWindow</type> of the pane that is used to display a view. - <p>This window usually is part of a small hierarchy of windows - rooted in the outer window of the pane.</p> */ ::com::sun::star::awt::XWindow getWindow (); diff --git a/offapi/com/sun/star/drawing/framework/XRelocatableResource.idl b/offapi/com/sun/star/drawing/framework/XRelocatableResource.idl index 72bd7780aecc..83ce01b8ac37 100644 --- a/offapi/com/sun/star/drawing/framework/XRelocatableResource.idl +++ b/offapi/com/sun/star/drawing/framework/XRelocatableResource.idl @@ -4,9 +4,9 @@ * * $RCSfile: XRelocatableResource.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: rt $ $Date: 2007-04-03 16:46:01 $ + * last change: $Author: kz $ $Date: 2008-04-03 15:34:03 $ * * The Contents of this file are made available subject to * the terms of GNU Lesser General Public License Version 2.1. @@ -33,8 +33,8 @@ * ************************************************************************/ -#ifndef __com_sun_star_drawing_framework_XResource_idl__ -#define __com_sun_star_drawing_framework_XResource_idl__ +#ifndef __com_sun_star_drawing_framework_XRelocatableResource_idl__ +#define __com_sun_star_drawing_framework_XRelocatableResource_idl__ #ifndef __com_sun_star_uno_XInterface_idl__ #include <com/sun/star/uno/XInterface.idl> @@ -48,7 +48,6 @@ interface XResource; relocatable to different anchors. */ interface XRelocatableResource - : ::com::sun::star::uno::XInterface { /** Replace the current anchor of the called resource with the given one. diff --git a/offapi/com/sun/star/drawing/framework/XView.idl b/offapi/com/sun/star/drawing/framework/XView.idl index a078490ead82..2d43d7277ffd 100644 --- a/offapi/com/sun/star/drawing/framework/XView.idl +++ b/offapi/com/sun/star/drawing/framework/XView.idl @@ -4,9 +4,9 @@ * * $RCSfile: XView.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: rt $ $Date: 2007-04-03 16:47:25 $ + * last change: $Author: kz $ $Date: 2008-04-03 15:36:33 $ * * The Contents of this file are made available subject to * the terms of GNU Lesser General Public License Version 2.1. @@ -50,15 +50,15 @@ module com { module sun { module star { module drawing { module framework { representation of a document. But the task pane, which is primarily a container of dialogs, is a view as well.</p> <p>Luckily the drawing framework does not need to know much about what a - view is. It just needs a way for typesafe referencing view objects and - for identifying them.</p> + view is. It just needs to identify view objects and a typesafe way to + reference them.</p> <p>The URL prefix of views is <code>private:resource/view</code></p> @see XViewController @see XViewFactory */ interface XView - : ::com::sun::star::drawing::framework::XResource { + interface XResource; }; }; }; }; }; }; // ::com::sun::star::drawing::framework |