udkapi/com/sun/star/lang/XInitialization.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 #ifndef __com_sun_star_lang_XInitialization_idl__
  20 #define __com_sun_star_lang_XInitialization_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/uno/Exception.idl>
  25
  26
  27
  28 module com {  module sun {  module star {  module lang {
  29
  30 /** initializes an object directly after its creation.
  31
  32     <p>This interface works together with factories. If you want to
  33     initialize the object after creation, you should
  34     support this interface and you may support other interfaces
  35     which offer type-safe initialization methods.  </p>
  36
  37     <p>Instead of calling XSingleComponentFactory::createInstanceWithContext()
  38     and later initialize(), you should call
  39     XSingleComponentFactory::createInstanceWithArgumentsAndContext()
  40     to pass the arguments to the instance. The reason is, that a component may want to
  41     return the same instance for the same set of parameters, and it can do so by implementing
  42     the factory itself.
  43     </p>
  44
  45  */
  46 published interface XInitialization: com::sun::star::uno::XInterface
  47 {
  48     /** initializes the object.
  49
  50         <p>It should be called directly after the object is created.
  51      */
  52     void initialize( [in] sequence<any> aArguments )
  53             raises( com::sun::star::uno::Exception );
  54
  55 };
  56
  57
  58 }; }; }; };
  59
  60 #endif
  61
  62 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */