offapi/com/sun/star/frame/XUIControllerFactory.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 module com { module sun { module star { module frame {
  21
  22 /** a factory to create User Interface controllers.
  23
  24     <p>
  25     A user interface controller can be registered for a command URL. A certain user
  26     interface controller will be created when a user interface element contains a
  27     registered command URL.
  28
  29     @see PopupMenuControllerFactory
  30     @see StatusbarControllerFactory
  31     @see ToolbarControllerFactory
  32     </p>
  33
  34     @since LibreOffice 4.1
  35  */
  36 interface XUIControllerFactory
  37 {
  38     /** this interface provides functions to create new instances of a registered UI controller.
  39
  40         <p>
  41         Use com::sun::star::lang::XMultiComponentFactory::createInstanceWithArgumentsAndContext() to create
  42         a new UI controller instance. Use the CommandURL as the service specifier.
  43
  44         This call supports the following arguments provided as com::sun::star::beans::PropertyValue:
  45         <ul>
  46             <li>
  47                 <b>Frame</b><br>specifies the com::sun::star::frame::XFrame
  48                 instance to which the UI controller belongs to. This property must be provided to
  49                 the UI controller, otherwise it cannot dispatch its internal commands.
  50              </li>
  51             <li>
  52                 <b>ModuleIdentifier</b><br>optional string that specifies in which module context the UI
  53                 controller should be created.<br>The module identifier can be retrieved using the
  54                 ModuleManager.
  55             </li>
  56         </ul>
  57         </p>
  58      */
  59     interface com::sun::star::lang::XMultiComponentFactory;
  60
  61     /** provides functions to query for, register and deregister a popup menu controller.
  62      */
  63     interface XUIControllerRegistration;
  64 };
  65
  66 }; }; }; };
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */