1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27#ifndef __com_sun_star_awt_XSpinValue_idl__ 28#define __com_sun_star_awt_XSpinValue_idl__ 29 30#ifndef __com_sun_star_uno_XInterface_idl__ 31#include <com/sun/star/uno/XInterface.idl> 32#endif 33 34#ifndef __com_sun_star_awt_XAdjustmentListener_idl__ 35#include <com/sun/star/awt/XAdjustmentListener.idl> 36#endif 37 38#ifndef __com_sun_star_lang_NoSupportException_idl__ 39#include <com/sun/star/lang/NoSupportException.idl> 40#endif 41 42//============================================================================= 43 44 module com { module sun { module star { module awt { 45 46//============================================================================= 47 48/** gives access to the value and settings of a control which is associated with 49 a spinnable value. 50 */ 51interface XSpinValue : com::sun::star::uno::XInterface 52{ 53 //------------------------------------------------------------------------- 54 55 /** registers an adjustment event listener. 56 */ 57 [oneway] void addAdjustmentListener( [in] com::sun::star::awt::XAdjustmentListener listener ); 58 59 //------------------------------------------------------------------------- 60 61 /** unregisters an adjustment event listener. 62 */ 63 [oneway] void removeAdjustmentListener( [in] com::sun::star::awt::XAdjustmentListener listener ); 64 65 //------------------------------------------------------------------------- 66 67 /** sets the current value of the control 68 */ 69 [oneway] void setValue( [in] long value ); 70 71 //------------------------------------------------------------------------- 72 73 /** sets the value and value range of the control 74 75 @see setValue 76 @see setMinimum 77 @see setMaximum 78 */ 79 [oneway] void setValues( [in] long minValue, [in] long maxValue, [in] long currentValue ); 80 81 //------------------------------------------------------------------------- 82 83 /** returns the current value of the control. 84 */ 85 long getValue(); 86 87 //------------------------------------------------------------------------- 88 89 /** sets the minimum value which can be set on the control 90 */ 91 [oneway] void setMinimum( [in] long minValue ); 92 93 //------------------------------------------------------------------------- 94 95 /** sets the maximum value which can be set on the control 96 */ 97 [oneway] void setMaximum( [in] long maxValue ); 98 99 //------------------------------------------------------------------------- 100 101 /** returns the currently set minimum value of the control 102 */ 103 long getMinimum(); 104 105 //------------------------------------------------------------------------- 106 107 /** returns the currently set maximum value of the control 108 */ 109 long getMaximum(); 110 111 //------------------------------------------------------------------------- 112 113 /** sets the value by which the current value of the control 114 should be incremented or decremented upon spinning. 115 */ 116 [oneway] void setSpinIncrement( [in] long spinIncrement ); 117 118 //------------------------------------------------------------------------- 119 120 /** returns the value by which the current value of the control 121 should be incremented or decremented upon spinning. 122 */ 123 long getSpinIncrement(); 124 125 //------------------------------------------------------------------------- 126 127 /** controls the orientation of the control 128 @param orientation 129 one of the <type>ScrollBarOrientation</type> values specifying the orientation 130 @throws com::sun::star::lang::NoSupportException 131 in case the given orientation is not supported 132 */ 133 void setOrientation( [in] long orientation ) 134 raises( com::sun::star::lang::NoSupportException ); 135 136 //------------------------------------------------------------------------- 137 138 /** returns the current orientation of the control 139 */ 140 long getOrientation(); 141 142}; 143 144//============================================================================= 145 146}; }; }; }; 147 148#endif 149