xref: /aoo42x/main/offapi/com/sun/star/drawing/modules.idl (revision cdf0e10c)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_modules_framework_idl__
29#define __com_sun_star_modules_framework_idl__
30
31module com { module sun { module star { module drawing {
32
33/** The drawing framework is responsible for managing the resources used by
34    the UI of the drawing applications.
35    <p>The framework is implemented by a set of sub controllers that are
36    responsible for its different resources: <type
37    scope="com::sun::star::drawing::framework">XModuleController</type>,
38    <type scope="com::sun::star::drawing::framework">XPaneController</type>,
39    <type scope="com::sun::star::drawing::framework">XViewController</type>,
40    <type scope="com::sun::star::drawing::framework">XToolbarController</type>,
41    <type scope="com::sun::star::drawing::framework">XCommandController</type>.
42    The set of active resources is represented by the <type
43    scope="com::sun::star::drawing::framework">XConfiguration</type>.</p>
44    <p>The <type
45    scope="com::sun::star::drawing::framework">XControllerManager</type>
46    interface provides access to the sub controllers.  It typically is
47    implemented by the same class that implements the <type
48    scope="com::sun::star::frame">XController</type> interface.</p>
49    <p>The
50    configuration is managed by the <type
51    scope="com::sun::star::drawing::framework">XConfigurationController</type>.
52    It coordinates changes to the configuration made by the other sub
53    controllers so that
54    <ul><li>unnecessary ui updates (flickering) is avoided and</li>
55    <li>and the configuration is always in a valid and meaningfull
56    state.</li></ul></p>
57    <p>For more information please see the wiki page of the <a
58    href="http://wiki.services.openoffice.org/wiki/Drawing_framework">drawing framework</a>.
59*/
60module framework {};
61
62}; }; }; };
63
64#endif
65
66