offapi/com/sun/star/drawing/modules.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: modules.idl,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  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.
  17  *
  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).
  23  *
  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.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_modules_framework_idl__
  32 #define __com_sun_star_modules_framework_idl__
  33
  34 module com { module sun { module star { module drawing {
  35
  36 /** The drawing framework is responsible for managing the resources used by
  37     the UI of the drawing applications.
  38     <p>The framework is implemented by a set of sub controllers that are
  39     responsible for its different resources: <type
  40     scope="com::sun::star::drawing::framework">XModuleController</type>,
  41     <type scope="com::sun::star::drawing::framework">XPaneController</type>,
  42     <type scope="com::sun::star::drawing::framework">XViewController</type>,
  43     <type scope="com::sun::star::drawing::framework">XToolbarController</type>,
  44     <type scope="com::sun::star::drawing::framework">XCommandController</type>.
  45     The set of active resources is represented by the <type
  46     scope="com::sun::star::drawing::framework">XConfiguration</type>.</p>
  47     <p>The <type
  48     scope="com::sun::star::drawing::framework">XControllerManager</type>
  49     interface provides access to the sub controllers.  It typically is
  50     implemented by the same class that implements the <type
  51     scope="com::sun::star::frame">XController</type> interface.</p>
  52     <p>The
  53     configuration is managed by the <type
  54     scope="com::sun::star::drawing::framework">XConfigurationController</type>.
  55     It coordinates changes to the configuration made by the other sub
  56     controllers so that
  57     <ul><li>unnecessary ui updates (flickering) is avoided and</li>
  58     <li>and the configuration is always in a valid and meaningfull
  59     state.</li></ul></p>
  60     <p>For more information please see the wiki page of the <a
  61     href="http://wiki.services.openoffice.org/wiki/Drawing_framework">drawing framework</a>.
  62 */
  63 module framework {};
  64
  65 }; }; }; };
  66
  67 #endif
  68