Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: awt ::

unpublished interface XMetricField
Usage Restrictions
not published
Description
gives access to the value and formatting of a metric field.

Methods' Summary
setValue sets the value which is displayed in the metric field.  
setUserValue sets the user value which is displayed in the metric field.  
getValue returns the value which is currently displayed in the metric field.  
getCorrectedValue returns the corrected value which is displayed in the metric field.  
setMin sets the minimum value that can be entered by the user.  
getMin returns the currently set minimum value that can be entered by the user.  
setMax sets the maximum value that can be entered by the user.  
getMax returns the currently set maximum value that can be entered by the user.  
setFirst sets the first value to be set on POS1 key.  
getFirst returns the currently set first value which is set on POS1 key.  
setLast sets the last value to be set on END key.  
getLast returns the currently set last value which is set on END key.  
setSpinSize sets the increment value for the spin button.  
getSpinSize returns the currently set increment value for the spin button.  
setDecimalDigits sets the number of decimals.  
getDecimalDigits returns the currently set number of decimals.  
setStrictFormat determines if the format is checked during user input.  
isStrictFormat returns whether the format is currently checked during user input.  
Methods' Details
setValue
void
setValue( [in] hyper  Value,
[in] short  FieldUnit );

Description
sets the value which is displayed in the metric field.
setUserValue
void
setUserValue( [in] hyper  Value,
[in] short  FieldUnit );

Description
sets the user value which is displayed in the metric field.
getValue
hyper
getValue( [in] short  FieldUnit );

Description
returns the value which is currently displayed in the metric field.
getCorrectedValue
hyper
getCorrectedValue( [in] short  FieldUnit );

Description
returns the corrected value which is displayed in the metric field.
setMin
void
setMin( [in] hyper  Value,
[in] short  FieldUnit );

Description
sets the minimum value that can be entered by the user.
getMin
hyper
getMin( [in] short  FieldUnit );

Description
returns the currently set minimum value that can be entered by the user.
setMax
void
setMax( [in] hyper  Value,
[in] short  FieldUnit );

Description
sets the maximum value that can be entered by the user.
getMax
hyper
getMax( [in] short  FieldUnit );

Description
returns the currently set maximum value that can be entered by the user.
setFirst
void
setFirst( [in] hyper  Value,
[in] short  FieldUnit );

Description
sets the first value to be set on POS1 key.
getFirst
hyper
getFirst( [in] short  FieldUnit );

Description
returns the currently set first value which is set on POS1 key.
setLast
void
setLast( [in] hyper  Value,
[in] short  FieldUnit );

Description
sets the last value to be set on END key.
getLast
hyper
getLast( [in] short  FieldUnit );

Description
returns the currently set last value which is set on END key.
setSpinSize
void
setSpinSize( [in] hyper  Value );

Description
sets the increment value for the spin button.
getSpinSize
hyper
getSpinSize();

Description
returns the currently set increment value for the spin button.
setDecimalDigits
void
setDecimalDigits( [in] short  nDigits );

Description
sets the number of decimals.
getDecimalDigits
short
getDecimalDigits();

Description
returns the currently set number of decimals.
setStrictFormat
void
setStrictFormat( [in] boolean  bStrict );

Description
determines if the format is checked during user input.
isStrictFormat
boolean
isStrictFormat();

Description
returns whether the format is currently checked during user input.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.