xref: /aoo41x/main/autodoc/inc/ary/idl/i_param.hxx (revision cdf0e10c)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef ARY_IDL_I_PARAM_HXX
29*cdf0e10cSrcweir #define ARY_IDL_I_PARAM_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir // BASE CLASSES
32*cdf0e10cSrcweir #include <ary/idl/i_types4idl.hxx>
33*cdf0e10cSrcweir 
34*cdf0e10cSrcweir 
35*cdf0e10cSrcweir 
36*cdf0e10cSrcweir 
37*cdf0e10cSrcweir namespace ary
38*cdf0e10cSrcweir {
39*cdf0e10cSrcweir namespace idl
40*cdf0e10cSrcweir {
41*cdf0e10cSrcweir 
42*cdf0e10cSrcweir 
43*cdf0e10cSrcweir /** Represents a parameter in an IDL function.
44*cdf0e10cSrcweir */
45*cdf0e10cSrcweir class Parameter
46*cdf0e10cSrcweir {
47*cdf0e10cSrcweir   public:
48*cdf0e10cSrcweir     // LIFECYCLE
49*cdf0e10cSrcweir                         Parameter(
50*cdf0e10cSrcweir                             const String &      i_sName,
51*cdf0e10cSrcweir                             Type_id             i_nType,
52*cdf0e10cSrcweir                             E_ParameterDirection
53*cdf0e10cSrcweir                                                 i_eDirection );
54*cdf0e10cSrcweir                         ~Parameter();
55*cdf0e10cSrcweir 
56*cdf0e10cSrcweir     // INQUIRY
57*cdf0e10cSrcweir     const String &      Name() const            { return sName; }
58*cdf0e10cSrcweir     Type_id             Type() const            { return nType; }
59*cdf0e10cSrcweir     E_ParameterDirection
60*cdf0e10cSrcweir                         Direction() const       { return eDirection; }
61*cdf0e10cSrcweir 
62*cdf0e10cSrcweir   private:
63*cdf0e10cSrcweir     // DATA
64*cdf0e10cSrcweir     String              sName;
65*cdf0e10cSrcweir     Type_id             nType;
66*cdf0e10cSrcweir     E_ParameterDirection
67*cdf0e10cSrcweir                         eDirection;
68*cdf0e10cSrcweir };
69*cdf0e10cSrcweir 
70*cdf0e10cSrcweir 
71*cdf0e10cSrcweir 
72*cdf0e10cSrcweir 
73*cdf0e10cSrcweir }   // namespace idl
74*cdf0e10cSrcweir }   // namespace ary
75*cdf0e10cSrcweir #endif
76