summaryrefslogtreecommitdiffstats
path: root/udkapi/com/sun/star/lang/XInitialization.idl
blob: 553f5169021e74accb65a87d8d17d6985c0bbb5a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_lang_XInitialization_idl__
#define __com_sun_star_lang_XInitialization_idl__

#include <com/sun/star/uno/XInterface.idl>

#include <com/sun/star/uno/Exception.idl>



module com {  module sun {  module star {  module lang {

/** initializes an object directly after its creation.

    <p>This interface works together with factories. If you want to
    initialize the object after creation, you should
    support this interface and you may support other interfaces
    which offer type-safe initialization methods.  </p>

    <p>Instead of calling XSingleComponentFactory::createInstanceWithContext()
    and later initialize(), you should call
    XSingleComponentFactory::createInstanceWithArgumentsAndContext()
    to pass the arguments to the instance. The reason is, that a component may want to
    return the same instance for the same set of parameters, and it can do so by implementing
    the factory itself.
    </p>

 */
published interface XInitialization: com::sun::star::uno::XInterface
{
    /** initializes the object.

        <p>It should be called directly after the object is created.
     */
    void initialize( [in] sequence<any> aArguments )
            raises( com::sun::star::uno::Exception );

};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */