Update ooo320-m1
[ooovba.git] / offapi / com / sun / star / drawing / framework / BasicPaneFactory.idl
blob4948ba9490aa3f431ca30e28dbece22dc14431e2
1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2008 by Sun Microsystems, Inc.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * $RCSfile: BasicPaneFactory.idl,v $
10 * $Revision: 1.4 $
12 * This file is part of OpenOffice.org.
14 * OpenOffice.org is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU Lesser General Public License version 3
16 * only, as published by the Free Software Foundation.
18 * OpenOffice.org is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU Lesser General Public License version 3 for more details
22 * (a copy is included in the LICENSE file that accompanied this code).
24 * You should have received a copy of the GNU Lesser General Public License
25 * version 3 along with OpenOffice.org. If not, see
26 * <http://www.openoffice.org/license.html>
27 * for a copy of the LGPLv3 License.
29 ************************************************************************/
31 #ifndef __com_sun_star_drawing_framework_BasicPaneFactory_idl__
32 #define __com_sun_star_drawing_framework_BasicPaneFactory_idl__
34 #ifndef __com_sun_star_frame_XController_idl__
35 #include <com/sun/star/frame/XController.idl>
36 #endif
37 #ifndef _COM_SUN_STAR_DRAWING_FRAMEWORK_XPANEFACTORY_IDL_
38 #include <com/sun/star/drawing/framework/XResourceFactory.idl>
39 #endif
41 module com { module sun { module star { module drawing { module framework {
43 /** The <type>BasicPaneFactory</pane> is a resource factory that provides the
44 panes used by the Draw and Impress applications.
45 <p>This factory provides the center, left, and right pane. For the left
46 pane there are two URLS, <code>private:resource/floater/LeftImpressPane</code>
47 and <code>private:resource/floater/LeftDrawPane</code>, one for Impress,
48 the other for Draw. The center pane and the right pane have the URLs
49 <code>private:resource/floater/CenterPane</code> and
50 <code>private:resource/floater/RightPane</code> respectively.</p>
51 <p>This factory is typically created indirectly by registering it in the
52 configuration and have the <type>XModuleController</type> create it on
53 demand.</p>
55 service BasicPaneFactory : XResourceFactory
57 /** Give the controller to new instances so that they have access to the
58 drawing framework controllers.
60 create ([in] ::com::sun::star::frame::XController xController);
63 }; }; }; }; }; // ::com::sun::star::drawing::framework
65 #endif