offapi/com/sun/star/frame/XUIControllerRegistration.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: XUIControllerRegistration.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 #ifndef __com_sun_star_frame_XUIControllerRegistration_idl__
  32 #define __com_sun_star_frame_XUIControllerRegistration_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com { module sun { module star { module frame {
  41
  42 //=============================================================================
  43
  44 /** is used to query, register and unregister user interface controller.
  45
  46     <p>
  47     A user interface controller can be registered for a command URL. A certain user
  48     interface controller will be created when a user interface element contains a
  49     registered command URL.
  50
  51     @see PopupMenuControllerFactory
  52     </p>
  53
  54     @since OOo 2.0
  55  */
  56
  57 published interface XUIControllerRegistration : com::sun::star::uno::XInterface
  58 {
  59     /** function to check if an user interface controller is registered
  60         for a command URL and optional module.
  61
  62         @returns
  63             true if a controller was registered for the combination of command URL
  64             and model name.
  65
  66         @param aCommandURL
  67             a command URL which specifies an action.
  68
  69         @param aModelName
  70             an optional name of an OpenOffice model service. This value can remain empty if
  71             no model service name was specified.
  72     */
  73     boolean hasController( [in] string aCommandURL, [in] string aModelName );
  74
  75     /** function to create an association between a user interface controller implementation
  76         and a command URL and optional module.
  77
  78         @param aCommandURL
  79             a command URL which specifies an action which shoudl be associated with a user
  80             interface controller.
  81
  82         @param aModelName
  83             an optional name of an OpenOffice model service. This value can remain empty if
  84             no model service name was specified.
  85
  86         @param aControllerImplementationName
  87             a UNO implementation name that can be used to create a user interface controller
  88             with the OpenOffice service manager.
  89     */
  90     void registerController( [in] string aCommandURL, [in] string aModelName, [in] string aControllerImplementationName );
  91
  92     /** function to remove a previously defined association between a user interface controller
  93         implementation and a command URL and optional module.
  94
  95         @param aCommandURL
  96             a command URL which specifies an action which shoudl be associated with a user
  97             interface controller.
  98
  99         @param aModelName
 100             an optional name of an OpenOffice model service. This value can remain empty if
 101             no model service name was specified.
 102     */
 103     void deregisterController( [in] string aCommandURL, [in] string aModelName );
 104 };
 105
 106 }; }; }; };
 107
 108 //=============================================================================
 109
 110 #endif