offapi/com/sun/star/frame/XModule.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 #ifndef __com_sun_star_frame_XModule_idl__
  21 #define __com_sun_star_frame_XModule_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/lang/IllegalArgumentException.idl>
  25 #include <com/sun/star/frame/UnknownModuleException.idl>
  26
  27
  28 module com { module sun { module star { module frame {
  29
  30 /** can be used to overrule identification of office modules.
  31
  32     <p>
  33     Normally an office module will be identified by its service name
  34     in combination with a set of configuration data.
  35     But sometimes whole existing office modules will be used as black box components
  36     to implement a different office module on top of it. Patching a service name
  37     is not possible. So this optional interface can be used to overwrite identification
  38     of a module.
  39     </p>
  40
  41     @see XModuleManager
  42
  43     @since OOo 2.3
  44  */
  45 interface XModule : com::sun::star::uno::XInterface
  46 {
  47     /** @param  Identifier
  48                 a new "name" for this module.
  49      */
  50     void setIdentifier([in] string Identifier);
  51
  52     /** @return the module identifier.
  53      */
  54     string getIdentifier();
  55 };
  56
  57 }; }; }; };
  58
  59 #endif
  60
  61 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */