summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/lang/XInitialization.idl
blob: 23a0c4f8f04118fadfeaa8cf85782bb36845441a (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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
/*************************************************************************
 *
 *  $RCSfile: XInitialization.idl,v $
 *
 *  $Revision: 1.8 $
 *
 *  last change: $Author: jbu $ $Date: 2002-01-18 13:39:36 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (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.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_lang_XInitialization_idl__
#define __com_sun_star_lang_XInitialization_idl__

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

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


//=============================================================================

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

//=============================================================================

// DocMerge from xml: interface com::sun::star::lang::XInitialization
/** 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 <member>XSingleComponentFactory::createInstanceWithContext</member>
    and later initialize(), you should call
    <member>XSingleComponentFactory::createInstanceWithArgumentsAndContext</member>
    to pass the arguments to the instance. The reason is, that a component may want
    return the same instance for the same set of parameters, and it can do so by implementing
    the factory itself.
    </p>

 */
interface XInitialization: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::lang::XInitialization::initialize
    /** 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 );

};

//=============================================================================

}; }; }; };

/*=============================================================================

    $Log: not supported by cvs2svn $
    Revision 1.7  2001/11/16 14:57:39  mi
    proofing by Richard Holt

    Revision 1.6  2001/03/16 15:10:37  jsc
    remove interfaceheader with uik and remove [const] in method definitions

    Revision 1.5  2000/12/13 15:47:01  mi
    symtactical documentation and minor semantic documentation flaws fixed

    Revision 1.4  2000/11/08 12:28:41  mi
    moved from api

    Revision 1.1.1.1  2000/09/18 23:35:25  hjs
    initial import

    Revision 1.3  2000/09/11 11:52:33  mi
    documentation merged from XML

    Revision 1.1.1.1  1999/11/11 09:48:43  jsc
    new


=============================================================================*/
#endif