offapi/com/sun/star/frame/XModuleManager.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 identify office modules.
  24
  25     @since OOo 2.0
  26  */
  27 interface XModuleManager : com::sun::star::uno::XInterface
  28 {
  29     /**
  30        @short  identifies the given module.
  31
  32        @details This identifier can then be used at the service ModuleManager
  33                to get more information about this module.
  34
  35                For identification the interface com::sun::star::lang::XServiceInfo
  36                is requested on the given module. Because all module service registrations must be unique
  37                this value can be queried and checked against the configuration.
  38
  39                Since OOo 2.3.0 also the optional interface XModule will be used.
  40                If it exists it will be preferred.
  41
  42        @param  Module
  43                Possible objects for this parameter can be the following one:
  44                <ul>
  45                    <li>
  46                        <b>com::sun::star::frame::XFrame</b><br>
  47                        A frame contains (against a component window) a controller.
  48                        Such controller represent the module (in case no model exists).
  49                    </li>
  50                    <li>
  51                        <b>com::sun::star::frame::XController</b><br>
  52                        A controller can be bound to a model. Then the model represent the module.
  53                        If no model exists - the controller is used for identification.
  54                    </li>
  55                    <li>
  56                        <b>com::sun::star::frame::XModel</b><br>
  57                        A model represent a module every time and can be used for
  58                        identification directly.
  59                    </li>
  60                </ul>
  61
  62        @throws com::sun::star::lang::IllegalArgumentException
  63                if the parameter Module is:
  64                <ul>
  65                    <li>an empty one</li>
  66                    <li>or does not provide one of the needed interface
  67                        XFrame, XController, XModel</li>
  68                    <li>or does not provide the needed interface XServiceInfo.</li>
  69                </ul>
  70
  71        @throws UnknownModuleException
  72                if the given module could not be identified.
  73                Note: If the module represent a XFrame instance with does not contain
  74                a document, this exception is thrown too!
  75
  76        @return An identifier for the given module.
  77                Note: This value varies every time. Error will be transported
  78                by thrown exceptions!
  79      */
  80     string identify( [in] ::com::sun::star::uno::XInterface Module )
  81         raises(::com::sun::star::lang::IllegalArgumentException,
  82                                        UnknownModuleException  );
  83
  84
  85 };
  86
  87 }; }; }; };
  88
  89 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */