udkapi/com/sun/star/reflection/XIdlField2.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 reflection {
  23
  24
  25 /** Reflects an IDL interface attribute, enum or compound type
  26     (i.e. struct/exception) member.
  27 */
  28 published interface XIdlField2: com::sun::star::reflection::XIdlMember
  29 {
  30     /** Returns the type of the field.
  31
  32         @return
  33                 type of the field
  34     */
  35     com::sun::star::reflection::XIdlClass getType();
  36
  37     /** Returns the access mode of the field, i.e. read-write, read-only or
  38         write-only (access mode "const" is deprecated).
  39
  40         @return
  41                 access mode of the field
  42     */
  43     com::sun::star::reflection::FieldAccessMode getAccessMode();
  44
  45     /** Gets the value of the reflected field from the given object,
  46         i.e. an interface, enum or compound type (struct/exception).
  47         For enums, the given object is ignored; the returned value
  48         reflects the constant enum 32-bit value.
  49
  50         <p>When setting an interface attribute raises a
  51         non com::sun::star::uno::RuntimeException, it is
  52         wrapped in a com::sun::star::lang::WrappedTargetRuntimeException.</p>
  53
  54         @param obj
  55                object instance having member of reflected type
  56         @return
  57                 value of field
  58
  59         @throws IllegalAccessException
  60         A com::sun::star::lang::IllegalAccessException
  61         is thrown if the given object is no interface, enum or compound type;
  62         or the given object does not have the reflected field.
  63     */
  64     any get(
  65         [in] any obj )
  66         raises( com::sun::star::lang::IllegalArgumentException );
  67
  68     /** Sets the value of the reflected field of the given object,
  69         i.e. an interface or compound type (struct/exception).
  70
  71         <p>When setting an interface attribute raises a
  72         non com::sun::star::uno::RuntimeException, it is
  73         wrapped in a com::sun::star::lang::WrappedTargetRuntimeException.</p>
  74
  75         @param obj
  76                object instance having member of reflected type
  77         @param value
  78                value to be set
  79
  80         @throws IllegalAccessException
  81         A com::sun::star::lang::IllegalAccessException
  82         is thrown if the given object is no interface or compound type;
  83         or the given object does not have the reflected field.
  84     */
  85     void set(
  86         [inout] any obj,
  87         [in] any value )
  88         raises( com::sun::star::lang::IllegalArgumentException,
  89                 com::sun::star::lang::IllegalAccessException );
  90 };
  91
  92
  93 }; }; }; };
  94
  95 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */