offapi/com/sun/star/rendering/CanvasFactory.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: CanvasFactory.idl,v $
  10  * $Revision: 1.5 $
  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 #if ! defined INCLUDED_com_sun_star_rendering_CanvasFactory_idl
  32 #define INCLUDED_com_sun_star_rendering_CanvasFactory_idl
  33
  34 #include <com/sun/star/lang/XMultiComponentFactory.idl>
  35
  36
  37 module com { module sun { module star { module rendering {
  38
  39 /** The <type>CanvasFactory</type> is used to create the <type>Canvas</type>
  40     objects, evaluating the user's configuration preferences from
  41
  42     <code>/org.openoffice.VCL/Settings/Canvas/PreferredServices</code>.
  43
  44     The latter specifies a string list of service names to use.
  45
  46     <p>
  47     Instantiating this service, you can use its
  48     <type scope="com::sun::star::lang">XMultiComponentFactory</type>
  49     interface to create <type>Canvas</type> objects, passing an empty string
  50     as service specifier (default).
  51     If you want to manually override the configured service list, you can pass
  52     a service name to try first.
  53     </p>
  54
  55     @since OOo 2.0.0
  56 */
  57 service CanvasFactory : com::sun::star::lang::XMultiComponentFactory;
  58
  59 }; }; }; };
  60
  61 #endif