offapi/com/sun/star/accessibility/XAccessibleValue.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 module com { module sun { module star { module accessibility {
  21
  22 /** Implement this interface to give access to a single numerical value.
  23
  24     <p>The XAccessibleValue interface represents a single
  25     numerical value and should be implemented by any class that supports
  26     numerical value like scroll bars and spin boxes.  This interface lets
  27     you access the value and its upper and lower bounds.</p>
  28
  29     @since OOo 1.1.2
  30 */
  31 interface XAccessibleValue : ::com::sun::star::uno::XInterface
  32 {
  33     /** Returns the value of this object as a number.
  34
  35         <p>The exact return type is implementation dependent.  Typical types
  36         are long and double.</p>
  37
  38         @return
  39             Returns the current value represented by this object.
  40     */
  41     any getCurrentValue ();
  42
  43     /** Sets the value of this object to the given number.
  44
  45         <p>The argument is clipped to the valid interval whose upper and
  46         lower bounds are returned by the methods
  47         getMaximumValue() and getMinimumValue(), i.e. if it is lower than
  48         the minimum value the new value will be the minimum and if it is
  49         greater than the maximum then the new value will be the maximum.</p>
  50
  51         @param aNumber
  52             The new value represented by this object.  The set of admissible
  53             types for this argument is implementation dependent.
  54
  55         @return
  56             Returns `TRUE` if the new value could successfully be set and
  57             `FALSE` otherwise.
  58     */
  59     boolean setCurrentValue ([in] any aNumber);
  60
  61     /** Returns the maximum value that can be represented by this object.
  62
  63         <p>The type of the returned value is implementation dependent.  It
  64         does not have to be the same type as that returned by
  65         getCurrentValue().</p>
  66
  67         @return
  68             Returns the maximum value in an implementation dependent type.
  69             If this object has no upper bound then an empty object is
  70             returned.
  71     */
  72     any getMaximumValue ();
  73
  74     /** Returns the minimum value that can be represented by this object.
  75
  76         <p>The type of the returned value is implementation dependent.  It
  77         does not have to be the same type as that returned by
  78         getCurrentValue().</p>
  79
  80         @return
  81             Returns the minimum value in an implementation dependent type.
  82             If this object has no lower bound then an empty object is
  83             returned.
  84     */
  85     any getMinimumValue ();
  86
  87     /** Returns the minimum increment by which the value represented by this
  88         object can be adjusted.
  89
  90         <p>The type of the returned value is implementation dependent. It
  91         does not have to be the same type as that returned by
  92         getCurrentValue().</p>
  93
  94         @return
  95             Returns the minimum increment value in an implementation dependent type.
  96             If this object has no minimum increment value, then an empty object is
  97             returned.
  98
  99         @since LibreOffice 7.3
 100     */
 101     any getMinimumIncrement ();
 102 };
 103
 104 }; }; }; };
 105
 106 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */