LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XMetricField Interface Reference

gives access to the value and formatting of a metric field. More...

import"XMetricField.idl";

Inheritance diagram for XMetricField:
XInterface

Public Member Functions

void setValue ([in] hyper Value, [in] short FieldUnit)
 sets the value which is displayed in the metric field. More...
 
void setUserValue ([in] hyper Value, [in] short FieldUnit)
 sets the user value which is displayed in the metric field. More...
 
hyper getValue ([in] short FieldUnit)
 returns the value which is currently displayed in the metric field. More...
 
hyper getCorrectedValue ([in] short FieldUnit)
 returns the corrected value which is displayed in the metric field. More...
 
void setMin ([in] hyper Value, [in] short FieldUnit)
 sets the minimum value that can be entered by the user. More...
 
hyper getMin ([in] short FieldUnit)
 returns the currently set minimum value that can be entered by the user. More...
 
void setMax ([in] hyper Value, [in] short FieldUnit)
 sets the maximum value that can be entered by the user. More...
 
hyper getMax ([in] short FieldUnit)
 returns the currently set maximum value that can be entered by the user. More...
 
void setFirst ([in] hyper Value, [in] short FieldUnit)
 sets the first value to be set on POS1 key. More...
 
hyper getFirst ([in] short FieldUnit)
 returns the currently set first value which is set on POS1 key. More...
 
void setLast ([in] hyper Value, [in] short FieldUnit)
 sets the last value to be set on END key. More...
 
hyper getLast ([in] short FieldUnit)
 returns the currently set last value which is set on END key. More...
 
void setSpinSize ([in] hyper Value)
 sets the increment value for the spin button. More...
 
hyper getSpinSize ()
 returns the currently set increment value for the spin button. More...
 
void setDecimalDigits ([in] short nDigits)
 sets the number of decimals. More...
 
short getDecimalDigits ()
 returns the currently set number of decimals. More...
 
void setStrictFormat ([in] boolean bStrict)
 determines if the format is checked during user input. More...
 
boolean isStrictFormat ()
 returns whether the format is currently checked during user input. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

gives access to the value and formatting of a metric field.

Member Function Documentation

hyper getCorrectedValue ( [in] short  FieldUnit)

returns the corrected value which is displayed in the metric field.

short getDecimalDigits ( )

returns the currently set number of decimals.

hyper getFirst ( [in] short  FieldUnit)

returns the currently set first value which is set on POS1 key.

hyper getLast ( [in] short  FieldUnit)

returns the currently set last value which is set on END key.

hyper getMax ( [in] short  FieldUnit)

returns the currently set maximum value that can be entered by the user.

hyper getMin ( [in] short  FieldUnit)

returns the currently set minimum value that can be entered by the user.

hyper getSpinSize ( )

returns the currently set increment value for the spin button.

hyper getValue ( [in] short  FieldUnit)

returns the value which is currently displayed in the metric field.

boolean isStrictFormat ( )

returns whether the format is currently checked during user input.

void setDecimalDigits ( [in] short  nDigits)

sets the number of decimals.

void setFirst ( [in] hyper  Value,
[in] short  FieldUnit 
)

sets the first value to be set on POS1 key.

void setLast ( [in] hyper  Value,
[in] short  FieldUnit 
)

sets the last value to be set on END key.

void setMax ( [in] hyper  Value,
[in] short  FieldUnit 
)

sets the maximum value that can be entered by the user.

void setMin ( [in] hyper  Value,
[in] short  FieldUnit 
)

sets the minimum value that can be entered by the user.

void setSpinSize ( [in] hyper  Value)

sets the increment value for the spin button.

void setStrictFormat ( [in] boolean  bStrict)

determines if the format is checked during user input.

void setUserValue ( [in] hyper  Value,
[in] short  FieldUnit 
)

sets the user value which is displayed in the metric field.

void setValue ( [in] hyper  Value,
[in] short  FieldUnit 
)

sets the value which is displayed in the metric field.


The documentation for this interface was generated from the following file: