LibreOffice LibreOffice 25.2 SDK API Reference

XMetricField.idl
Go to the documentation of this file.
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 module com { module sun { module star { module awt {
22
23
26 interface XMetricField: com::sun::star::uno::XInterface
27{
28
31 void setValue( [in] hyper Value, [in] short FieldUnit );
32
33
36 void setUserValue( [in] hyper Value, [in] short FieldUnit );
37
38
41 hyper getValue( [in] short FieldUnit );
42
43
46 hyper getCorrectedValue( [in] short FieldUnit );
47
48
51 void setMin( [in] hyper Value, [in] short FieldUnit );
52
53
57 hyper getMin( [in] short FieldUnit );
58
59
62 void setMax( [in] hyper Value, [in] short FieldUnit );
63
64
68 hyper getMax( [in] short FieldUnit );
69
70
73 void setFirst( [in] hyper Value, [in] short FieldUnit );
74
75
78 hyper getFirst( [in] short FieldUnit );
79
80
83 void setLast( [in] hyper Value, [in] short FieldUnit );
84
85
88 hyper getLast( [in] short FieldUnit );
89
90
93 void setSpinSize( [in] hyper Value );
94
95
98 hyper getSpinSize();
99
100
103 void setDecimalDigits( [in] short nDigits );
104
105
108 short getDecimalDigits();
109
110
113 void setStrictFormat( [in] boolean bStrict );
114
115
118 boolean isStrictFormat();
119
120};
121
122
123}; }; }; };
124
125/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::awt::XMetricField
gives access to the value and formatting of a metric field.
Definition: XMetricField.idl:27
com::sun::star::awt::XMetricField::getValue
hyper getValue([in] short FieldUnit)
returns the value which is currently displayed in the metric field.
com::sun::star::awt::XMetricField::getSpinSize
hyper getSpinSize()
returns the currently set increment value for the spin button.
com::sun::star::awt::XMetricField::setValue
void setValue([in] hyper Value, [in] short FieldUnit)
sets the value which is displayed in the metric field.
com::sun::star::awt::XMetricField::setLast
void setLast([in] hyper Value, [in] short FieldUnit)
sets the last value to be set on END key.
com::sun::star::awt::XMetricField::getCorrectedValue
hyper getCorrectedValue([in] short FieldUnit)
returns the corrected value which is displayed in the metric field.
com::sun::star::awt::XMetricField::getDecimalDigits
short getDecimalDigits()
returns the currently set number of decimals.
com::sun::star::awt::XMetricField::getMax
hyper getMax([in] short FieldUnit)
returns the currently set maximum value that can be entered by the user.
com::sun::star::awt::XMetricField::setFirst
void setFirst([in] hyper Value, [in] short FieldUnit)
sets the first value to be set on POS1 key.
com::sun::star::awt::XMetricField::getMin
hyper getMin([in] short FieldUnit)
returns the currently set minimum value that can be entered by the user.
com::sun::star::awt::XMetricField::setSpinSize
void setSpinSize([in] hyper Value)
sets the increment value for the spin button.
com::sun::star::awt::XMetricField::setMax
void setMax([in] hyper Value, [in] short FieldUnit)
sets the maximum value that can be entered by the user.
com::sun::star::awt::XMetricField::getLast
hyper getLast([in] short FieldUnit)
returns the currently set last value which is set on END key.
com::sun::star::awt::XMetricField::isStrictFormat
boolean isStrictFormat()
returns whether the format is currently checked during user input.
com::sun::star::awt::XMetricField::setMin
void setMin([in] hyper Value, [in] short FieldUnit)
sets the minimum value that can be entered by the user.
com::sun::star::awt::XMetricField::setStrictFormat
void setStrictFormat([in] boolean bStrict)
determines if the format is checked during user input.
com::sun::star::awt::XMetricField::setDecimalDigits
void setDecimalDigits([in] short nDigits)
sets the number of decimals.
com::sun::star::awt::XMetricField::getFirst
hyper getFirst([in] short FieldUnit)
returns the currently set first value which is set on POS1 key.
com::sun::star::awt::XMetricField::setUserValue
void setUserValue([in] hyper Value, [in] short FieldUnit)
sets the user value which is displayed in the metric field.
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:46
com
Definition: Ambiguous.idl:20