offapi/com/sun/star/frame/XUIControllerRegistration.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
  21 module com { module sun { module star { module frame {
  22
  23
  24 /** is used to query, register and unregister user interface controller.
  25
  26     <p>
  27     A user interface controller can be registered for a command URL. A certain user
  28     interface controller will be created when a user interface element contains a
  29     registered command URL.
  30
  31     @see PopupMenuControllerFactory
  32     </p>
  33
  34     @since OOo 2.0
  35  */
  36
  37 published interface XUIControllerRegistration : com::sun::star::uno::XInterface
  38 {
  39     /** function to check if an user interface controller is registered
  40         for a command URL and optional module.
  41
  42         @returns
  43             true if a controller was registered for the combination of command URL
  44             and model name.
  45
  46         @param aCommandURL
  47             a command URL which specifies an action.
  48
  49         @param aModelName
  50             an optional name of an OpenOffice model service. This value can remain empty if
  51             no model service name was specified.
  52     */
  53     boolean hasController( [in] string aCommandURL, [in] string aModelName );
  54
  55     /** function to create an association between a user interface controller implementation
  56         and a command URL and optional module.
  57
  58         @param aCommandURL
  59             a command URL which specifies an action which should be associated with a user
  60             interface controller.
  61
  62         @param aModelName
  63             an optional name of an OpenOffice model service. This value can remain empty if
  64             no model service name was specified.
  65
  66         @param aControllerImplementationName
  67             a UNO implementation name that can be used to create a user interface controller
  68             with the OpenOffice service manager.
  69     */
  70     void registerController( [in] string aCommandURL, [in] string aModelName, [in] string aControllerImplementationName );
  71
  72     /** function to remove a previously defined association between a user interface controller
  73         implementation and a command URL and optional module.
  74
  75         @param aCommandURL
  76             a command URL which specifies an action which should be associated with a user
  77             interface controller.
  78
  79         @param aModelName
  80             an optional name of an OpenOffice model service. This value can remain empty if
  81             no model service name was specified.
  82     */
  83     void deregisterController( [in] string aCommandURL, [in] string aModelName );
  84 };
  85
  86 }; }; }; };
  87
  88
  89 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */