udkapi/com/sun/star/lang/XInitialization.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_lang_XInitialization_idl__
  28 #define __com_sun_star_lang_XInitialization_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_uno_Exception_idl__
  35 #include <com/sun/star/uno/Exception.idl>
  36 #endif
  37
  38
  39 //=============================================================================
  40
  41 module com {  module sun {  module star {  module lang {
  42
  43 //=============================================================================
  44
  45 // DocMerge from xml: interface com::sun::star::lang::XInitialization
  46 /** initializes an object directly after its creation.
  47
  48     <p>This interface works together with factories. If you want to
  49     initialize the object after creation, you should
  50     support this interface and you may support other interfaces
  51     which offer type-safe initialization methods.  </p>
  52
  53     <p>Instead of calling <member>XSingleComponentFactory::createInstanceWithContext</member>
  54     and later initialize(), you should call
  55     <member>XSingleComponentFactory::createInstanceWithArgumentsAndContext</member>
  56     to pass the arguments to the instance. The reason is, that a component may want to
  57     return the same instance for the same set of parameters, and it can do so by implementing
  58     the factory itself.
  59     </p>
  60
  61  */
  62 published interface XInitialization: com::sun::star::uno::XInterface
  63 {
  64     //-------------------------------------------------------------------------
  65
  66     // DocMerge from xml: method com::sun::star::lang::XInitialization::initialize
  67     /** initializes the object.
  68
  69         <p>It should be called directly after the object is created.
  70      */
  71     void initialize( [in] sequence<any> aArguments )
  72             raises( com::sun::star::uno::Exception );
  73
  74 };
  75
  76 //=============================================================================
  77
  78 }; }; }; };
  79
  80 /*=============================================================================
  81
  82 =============================================================================*/
  83 #endif