offapi/com/sun/star/frame/StatusbarControllerFactory.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: StatusbarControllerFactory.idl,v $
  10  * $Revision: 1.6 $
  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_frame_StatusbarControllerFactory_idl__
  32 #define __com_sun_star_frame_StatusbarControllerFactory_idl__
  33
  34 #ifndef __com_sun_star_lang_XMultiComponentFactory_idl__
  35 #include <com/sun/star/lang/XMultiComponentFactory.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_frame_XUIControllerRegistration_idl__
  39 #include <com/sun/star/frame/XUIControllerRegistration.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com { module sun { module star { module frame {
  45
  46 //=============================================================================
  47
  48 /** specifies a factory that creates instances of registered status bar
  49     controller.
  50
  51     <p>
  52     A status bar controller can be registered for a command URL and a model
  53     service name. A status bar will automatically create a status bar controller
  54     if it contains a registered command URL.
  55     </p>
  56
  57     @since OOo 2.0.0
  58 */
  59
  60 service StatusbarControllerFactory
  61 {
  62     /** this interface provides functions to create new instances of a registered
  63         status bar controller.
  64
  65         <p>
  66         Use <member scope="com.sun.star.lang">XMultiComponentFactory::createInstanceWithArguments()</member>
  67         to create a new status bar controller instance. Use the CommandURL as the
  68         service specifier.
  69
  70         This call supports the following arguments provided as
  71         <type scope="com::sun::star::beans">PropertyValue</type>:
  72         <ul>
  73             <li><b>Frame</b><br>specifies the <type scope="com::sun::star::frame">XFrame</type>
  74                    instance to which the status bar controller belongs to. This
  75                    property must be provided to the status bar controller, otherwise it
  76                    cannot dispatch its internal commands.</li>
  77             <li><b>ModuleIdentifier</b><br>optional string that specifies in which module
  78                    context the status bar controller should be created.</li>
  79         </ul>
  80         </p>
  81      */
  82     interface com::sun::star::lang::XMultiComponentFactory;
  83
  84     /** provides functions to query for, register and deregister a status bar
  85         controller.
  86      */
  87     interface com::sun::star::frame::XUIControllerRegistration;
  88 };
  89
  90 }; }; }; };
  91
  92 //=============================================================================
  93
  94 #endif