blob: 45001976fd0d6e2a929ef4f612989dd622a7a66e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
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: */
|
