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