xref: /aoo41x/main/offapi/com/sun/star/drawing/modules.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_modules_framework_idl__
#define __com_sun_star_modules_framework_idl__

module com { module sun { module star { module drawing {

/** The drawing framework is responsible for managing the resources used by
    the UI of the drawing applications.
    <p>The framework is implemented by a set of sub controllers that are
    responsible for its different resources: <type
    scope="com::sun::star::drawing::framework">XModuleController</type>,
    <type scope="com::sun::star::drawing::framework">XPaneController</type>,
    <type scope="com::sun::star::drawing::framework">XViewController</type>,
    <type scope="com::sun::star::drawing::framework">XToolbarController</type>,
    <type scope="com::sun::star::drawing::framework">XCommandController</type>.
    The set of active resources is represented by the <type
    scope="com::sun::star::drawing::framework">XConfiguration</type>.</p>
    <p>The <type
    scope="com::sun::star::drawing::framework">XControllerManager</type>
    interface provides access to the sub controllers.  It typically is
    implemented by the same class that implements the <type
    scope="com::sun::star::frame">XController</type> interface.</p>
    <p>The
    configuration is managed by the <type
    scope="com::sun::star::drawing::framework">XConfigurationController</type>.
    It coordinates changes to the configuration made by the other sub
    controllers so that
    <ul><li>unnecessary ui updates (flickering) is avoided and</li>
    <li>and the configuration is always in a valid and meaningfull
    state.</li></ul></p>
    <p>For more information please see the wiki page of the <a
    href="http://wiki.services.openoffice.org/wiki/Drawing_framework">drawing framework</a>.
*/
module framework {};

}; }; }; };

#endif