xref: /AOO41X/main/udkapi/com/sun/star/beans/MethodConcept.idl (revision 408a4873fc8bcc602c90ea4598886bb71abf0675)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_beans_MethodConcept_idl__
24#define __com_sun_star_beans_MethodConcept_idl__
25
26
27//=============================================================================
28
29 module com {  module sun {  module star {  module beans {
30
31//=============================================================================
32/** These constants are used to specify concepts of the
33    introspection which apply to methods.
34
35    <p>This list is not necessarily complete; new constants
36    may be added.</p>
37    @see Introspection
38    @see XIntrospection
39    @see XIntrospectionAccess
40
41*/
42published constants MethodConcept
43{
44    //-------------------------------------------------------------------------
45    /** This value is used to query for all methods, see
46        <member>XIntrospectionAccess::getMethod()</member> and
47        <member>XIntrospectionAccess::getMethods()</member>
48     */
49    const long ALL = -1;
50
51    //-------------------------------------------------------------------------
52    /** specifies methods which can result in an unstable state
53        (i.e. deadlock, application crash, security hole, etc.)
54        when called directly by the user.
55     */
56    const long DANGEROUS = 1;
57
58    //-------------------------------------------------------------------------
59    /** specifies methods which are used to set and get the
60        value of properties/attributes.
61
62        <p>These methods have the signature <code>type get...()
63        </code>, <code>void set...()</code> or <code>boolean is...()
64        </code>. </p>
65     */
66    const long PROPERTY = 2;
67
68    //-------------------------------------------------------------------------
69    /** specifies methods of the <em>listener concept</em>.
70
71        <p>These methods have the signature <code>add...Listener()
72        </code> or <code>remove...Listener()</code>. </p>
73     */
74    const long LISTENER = 4;
75
76    //-------------------------------------------------------------------------
77    /** specifies methods of the <em>enumeration concept</em>.
78
79        <p>These methods have the signature
80        <code>create...Enumeration</code> and return an interface
81        that is derived from <type scope="com::sun::star::container">
82        XEnumeration</type> Additionally, the method
83        <method scope="com::sun::star::container">XEnumerationAccess::getElementType</method>
84        belongs to this concept.</p>
85     */
86    const long ENUMERATION = 8;
87
88    //-------------------------------------------------------------------------
89    /** specifies methods of the <em>name container concept</em>.
90
91        <p>These methods have the signature
92        <code>get...ByName()</code>,
93        <code>set...ByName()</code>,
94        <code>replace...ByName()</code>,
95        <code>remove...ByName()</code>,
96        <code>has...ByName()</code>, or
97        <code>get...Names</code>.  In addition, the method
98        <method scope="com::sun::star::container">XEnumerationAccess::getElementType</method>
99        belongs to this concept. </p>
100     */
101    const long NAMECONTAINER = 16;
102
103    //-------------------------------------------------------------------------
104    /** specifies methods of the <em>index container concept</em>.
105
106        <p>These methods have the signature
107        <code>get...ByIndex()</code>,
108        <code>insert...ByIndex()</code>,
109        <code>replace...ByIndex()</code>, or
110        <code>remove...ByIndex()</code>.
111        The method <member scope="com::sun::star::container">
112        XIndexAccess::getCount()</member>
113        also belongs to this concept. </p>
114     */
115    const long INDEXCONTAINER = 32;
116
117};
118
119//=============================================================================
120
121}; }; }; };
122
123#endif
124