udkapi/com/sun/star/reflection/XDump.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
   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
  10 module com {  module sun {  module star {  module reflection {
  11
  12 /** Dump any UNOIDL value as a string.
  13
  14     Mainly useful for logging and debugging purposes.
  15
  16     @since LibreOffice 7.6
  17 */
  18 interface XDump {
  19     /** Dump a UNOIDL value as a string.
  20
  21         This just dumps the value itself, without any further decoration.
  22
  23         @param value  any UNOIDL value
  24
  25         @returns a string representation of the given value
  26      */
  27     string dumpValue([in] any value);
  28
  29     /** Dump the value of a UNOIDL ANY as a string.
  30
  31         This dumps the type and value of the given ANY.
  32
  33         @param value  any UNOIDL ANY
  34
  35         @returns a string representation of the given ANY
  36      */
  37     string dumpAny([in] any value);
  38
  39     /** Dump a numeric UNOIDL value, interpreted relative to a UNOIDL constants group, as a string.
  40
  41         @param constantsGroup  the name (in dotted notation, as supported by
  42         /singletons/theTypeDescriptionManager) of a UNOIDL constants group
  43
  44         @param value  a UNOIDL value of type BOOLEAN, BYTE, SHORT, UNSIGNED SHORT, LONG, UNSIGNED
  45         LONG, HYPER, UNSIGNED HYPER, FLOAT, or DOUBLE
  46
  47         @returns a string representation of the given numeric value
  48
  49         @throws com::sun::star::lang::IllegalArgumentException  if the constantsGroup argument does
  50         not represent a UNOIDL constants group or the value argument is of wrong type
  51      */
  52     string dumpConstant([in] string constantsGroup, [in] any value)
  53         raises (com::sun::star::lang::IllegalArgumentException);
  54 };
  55
  56 }; }; }; };
  57
  58 /* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */