diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
commit | ed5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch) | |
tree | 7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /offapi/com/sun/star/accessibility/XAccessibleValue.idl | |
parent | Initial commit. (diff) | |
download | libreoffice-upstream.tar.xz libreoffice-upstream.zip |
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | offapi/com/sun/star/accessibility/XAccessibleValue.idl | 114 |
1 files changed, 114 insertions, 0 deletions
diff --git a/offapi/com/sun/star/accessibility/XAccessibleValue.idl b/offapi/com/sun/star/accessibility/XAccessibleValue.idl new file mode 100644 index 000000000..45001976f --- /dev/null +++ b/offapi/com/sun/star/accessibility/XAccessibleValue.idl @@ -0,0 +1,114 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ + +#ifndef __com_sun_star_accessibility_XAccessibleValue_idl__ +#define __com_sun_star_accessibility_XAccessibleValue_idl__ + +#include <com/sun/star/uno/XInterface.idl> + +module com { module sun { module star { module accessibility { + +/** Implement this interface to give access to a single numerical value. + + <p>The XAccessibleValue interface represents a single + numerical value and should be implemented by any class that supports + numerical value like scroll bars and spin boxes. This interface lets + you access the value and its upper and lower bounds.</p> + + @since OOo 1.1.2 +*/ +interface XAccessibleValue : ::com::sun::star::uno::XInterface +{ + /** Returns the value of this object as a number. + + <p>The exact return type is implementation dependent. Typical types + are long and double.</p> + + @return + Returns the current value represented by this object. + */ + any getCurrentValue (); + + /** Sets the value of this object to the given number. + + <p>The argument is clipped to the valid interval whose upper and + lower bounds are returned by the methods + getMaximumAccessibleValue() and + getMinimumAccessibleValue(), i.e. if it is lower than + the minimum value the new value will be the minimum and if it is + greater than the maximum then the new value will be the maximum.</p> + + @param aNumber + The new value represented by this object. The set of admissible + types for this argument is implementation dependent. + + @return + Returns `TRUE` if the new value could successfully be set and + `FALSE` otherwise. + */ + boolean setCurrentValue ([in] any aNumber); + + /** Returns the maximal value that can be represented by this object. + + <p>The type of the returned value is implementation dependent. It + does not have to be the same type as that returned by + getCurrentAccessibleValue().</p> + + @return + Returns the maximal value in an implementation dependent type. + If this object has no upper bound then an empty object is + returned. + */ + any getMaximumValue (); + + /** Returns the minimal value that can be represented by this object. + + <p>The type of the returned value is implementation dependent. It + does not have to be the same type as that returned by + getCurrentAccessibleValue().</p> + + @return + Returns the minimal value in an implementation dependent type. + If this object has no lower bound then an empty object is + returned. + */ + any getMinimumValue (); + + /** Returns the minimal increment by which the value represented by this + object can be adjusted. + + <p>The type of the returned value is implementation dependent. It + does not have to be the same type as that returned by + getCurrentAccessibleValue().</p> + + @return + Returns the minimal increment value in an implementation dependent type. + If this object has no minimum increment value, then an empty object is + returned. + + @since LibreOffice 7.3 + */ + any getMinimumIncrement (); +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |