LibreOffice
LibreOffice 25.8 SDK API Reference
Loading...
Searching...
No Matches
XSpinValue Interface Reference

gives access to the value and settings of a control which is associated with a spinnable value. More...

import "XSpinValue.idl";

Inheritance diagram for XSpinValue:
XInterface UnoControlSpinButton

Public Member Functions

void addAdjustmentListener ([in] com::sun::star::awt::XAdjustmentListener listener)
 registers an adjustment event listener.
void removeAdjustmentListener ([in] com::sun::star::awt::XAdjustmentListener listener)
 unregisters an adjustment event listener.
void setValue ([in] long value)
 sets the current value of the control
void setValues ([in] long minValue, [in] long maxValue, [in] long currentValue)
 sets the value and value range of the control
long getValue ()
 returns the current value of the control.
void setMinimum ([in] long minValue)
 sets the minimum value which can be set on the control
void setMaximum ([in] long maxValue)
 sets the maximum value which can be set on the control
long getMinimum ()
 returns the currently set minimum value of the control
long getMaximum ()
 returns the currently set maximum value of the control
void setSpinIncrement ([in] long spinIncrement)
 sets the value by which the current value of the control should be incremented or decremented upon spinning.
long getSpinIncrement ()
 returns the value by which the current value of the control should be incremented or decremented upon spinning.
void setOrientation ([in] long orientation) raises ( com::sun::star::lang::NoSupportException )
 controls the orientation of the control
long getOrientation ()
 returns the current orientation of the control
Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object.
void acquire ()
 increases the reference counter by one.
void release ()
 decreases the reference counter by one.

Detailed Description

gives access to the value and settings of a control which is associated with a spinnable value.

Member Function Documentation

◆ addAdjustmentListener()

void addAdjustmentListener ( [in] com::sun::star::awt::XAdjustmentListener listener)

registers an adjustment event listener.

◆ getMaximum()

long getMaximum ( )

returns the currently set maximum value of the control

◆ getMinimum()

long getMinimum ( )

returns the currently set minimum value of the control

◆ getOrientation()

long getOrientation ( )

returns the current orientation of the control

◆ getSpinIncrement()

long getSpinIncrement ( )

returns the value by which the current value of the control should be incremented or decremented upon spinning.

◆ getValue()

long getValue ( )

returns the current value of the control.

◆ removeAdjustmentListener()

void removeAdjustmentListener ( [in] com::sun::star::awt::XAdjustmentListener listener)

unregisters an adjustment event listener.

◆ setMaximum()

void setMaximum ( [in] long maxValue)

sets the maximum value which can be set on the control

◆ setMinimum()

void setMinimum ( [in] long minValue)

sets the minimum value which can be set on the control

◆ setOrientation()

void setOrientation ( [in] long orientation)
raises (com::sun::star::lang::NoSupportException )

controls the orientation of the control

Parameters
orientationone of the ScrollBarOrientation values specifying the orientation
Exceptions
com::sun::star::lang::NoSupportExceptionin case the given orientation is not supported

◆ setSpinIncrement()

void setSpinIncrement ( [in] long spinIncrement)

sets the value by which the current value of the control should be incremented or decremented upon spinning.

◆ setValue()

void setValue ( [in] long value)

sets the current value of the control

◆ setValues()

void setValues ( [in] long minValue,
[in] long maxValue,
[in] long currentValue )

sets the value and value range of the control

See also
setValue
setMinimum
setMaximum

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