udkapi/com/sun/star/beans/MethodConcept.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_beans_MethodConcept_idl__
  20 #define __com_sun_star_beans_MethodConcept_idl__
  21
  22
  23
  24  module com {  module sun {  module star {  module beans {
  25
  26 /** These constants are used to specify concepts of the
  27     introspection which apply to methods.
  28
  29     <p>This list is not necessarily complete; new constants
  30     may be added.</p>
  31     @see Introspection
  32     @see XIntrospection
  33     @see XIntrospectionAccess
  34
  35 */
  36 published constants MethodConcept
  37 {
  38     /** This value is used to query for all methods, see
  39         XIntrospectionAccess::getMethod() and
  40         XIntrospectionAccess::getMethods()
  41      */
  42     const long ALL = -1;
  43
  44     /** specifies methods which can result in an unstable state
  45         (i.e. deadlock, application crash, security hole, etc.)
  46         when called directly by the user.
  47      */
  48     const long DANGEROUS = 1;
  49
  50     /** specifies methods which are used to set and get the
  51         value of properties/attributes.
  52
  53         <p>These methods have the signature <code>type get...()
  54         </code>, <code>void set...()</code> or <code>boolean is...()
  55         </code>. </p>
  56      */
  57     const long PROPERTY = 2;
  58
  59     /** specifies methods of the <em>listener concept</em>.
  60
  61         <p>These methods have the signature <code>add...Listener()
  62         </code> or <code>remove...Listener()</code>. </p>
  63      */
  64     const long LISTENER = 4;
  65
  66     /** specifies methods of the <em>enumeration concept</em>.
  67
  68         <p>These methods have the signature
  69         <code>create...Enumeration</code> and return an interface
  70         that is derived from com::sun::star::container::XEnumeration.
  71         Additionally, the method
  72         com::sun::star::container::XEnumerationAccess::getElementType()
  73         belongs to this concept.</p>
  74      */
  75     const long ENUMERATION = 8;
  76
  77     /** specifies methods of the <em>name container concept</em>.
  78
  79         <p>These methods have the signature
  80         <code>get...ByName()</code>,
  81         <code>set...ByName()</code>,
  82         <code>replace...ByName()</code>,
  83         <code>remove...ByName()</code>,
  84         <code>has...ByName()</code>, or
  85         <code>get...Names</code>.  In addition, the method
  86         com::sun::star::container::XEnumerationAccess::getElementType()
  87         belongs to this concept. </p>
  88      */
  89     const long NAMECONTAINER = 16;
  90
  91     /** specifies methods of the <em>index container concept</em>.
  92
  93         <p>These methods have the signature
  94         <code>get...ByIndex()</code>,
  95         <code>insert...ByIndex()</code>,
  96         <code>replace...ByIndex()</code>, or
  97         <code>remove...ByIndex()</code>.
  98         The method com::sun::star::container::XIndexAccess::getCount()
  99         also belongs to this concept. </p>
 100      */
 101     const long INDEXCONTAINER = 32;
 102
 103 };
 104
 105
 106 }; }; }; };
 107
 108 #endif
 109
 110 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */