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