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
  20
  21
  22  module com {  module sun {  module star {  module beans {
  23
  24 /** These constants are used to specify concepts of the
  25     introspection which apply to methods.
  26
  27     <p>This list is not necessarily complete; new constants
  28     may be added.</p>
  29     @see Introspection
  30     @see XIntrospection
  31     @see XIntrospectionAccess
  32
  33 */
  34 published constants MethodConcept
  35 {
  36     /** This value is used to query for all methods, see
  37         XIntrospectionAccess::getMethod() and
  38         XIntrospectionAccess::getMethods()
  39      */
  40     const long ALL = -1;
  41
  42     /** specifies methods which can result in an unstable state
  43         (i.e. deadlock, application crash, security hole, etc.)
  44         when called directly by the user.
  45      */
  46     const long DANGEROUS = 1;
  47
  48     /** specifies methods which are used to set and get the
  49         value of properties/attributes.
  50
  51         <p>These methods have the signature <code>type get...()
  52         </code>, <code>void set...()</code> or <code>boolean is...()
  53         </code>. </p>
  54      */
  55     const long PROPERTY = 2;
  56
  57     /** specifies methods of the <em>listener concept</em>.
  58
  59         <p>These methods have the signature <code>add...Listener()
  60         </code> or <code>remove...Listener()</code>. </p>
  61      */
  62     const long LISTENER = 4;
  63
  64     /** specifies methods of the <em>enumeration concept</em>.
  65
  66         <p>These methods have the signature
  67         <code>create...Enumeration</code> and return an interface
  68         that is derived from com::sun::star::container::XEnumeration.
  69         Additionally, the method
  70         com::sun::star::container::XEnumerationAccess::getElementType()
  71         belongs to this concept.</p>
  72      */
  73     const long ENUMERATION = 8;
  74
  75     /** specifies methods of the <em>name container concept</em>.
  76
  77         <p>These methods have the signature
  78         <code>get...ByName()</code>,
  79         <code>set...ByName()</code>,
  80         <code>replace...ByName()</code>,
  81         <code>remove...ByName()</code>,
  82         <code>has...ByName()</code>, or
  83         <code>get...Names</code>.  In addition, the method
  84         com::sun::star::container::XEnumerationAccess::getElementType()
  85         belongs to this concept. </p>
  86      */
  87     const long NAMECONTAINER = 16;
  88
  89     /** specifies methods of the <em>index container concept</em>.
  90
  91         <p>These methods have the signature
  92         <code>get...ByIndex()</code>,
  93         <code>insert...ByIndex()</code>,
  94         <code>replace...ByIndex()</code>, or
  95         <code>remove...ByIndex()</code>.
  96         The method com::sun::star::container::XIndexAccess::getCount()
  97         also belongs to this concept. </p>
  98      */
  99     const long INDEXCONTAINER = 32;
 100
 101 };
 102
 103
 104 }; }; }; };
 105
 106 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */