offapi/com/sun/star/awt/XSpinField.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XSpinField.idl,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_awt_XSpinField_idl__
  31 #define __com_sun_star_awt_XSpinField_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_awt_XSpinListener_idl__
  38 #include <com/sun/star/awt/XSpinListener.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module awt {
  45
  46 //=============================================================================
  47
  48 /** gives access to the value of a spin field and makes it possible to
  49     register for spin events.
  50  */
  51 published interface XSpinField: com::sun::star::uno::XInterface
  52 {
  53     //-------------------------------------------------------------------------
  54
  55     /** registers a listener for spin events.
  56      */
  57     [oneway] void addSpinListener( [in] com::sun::star::awt::XSpinListener l );
  58
  59     //-------------------------------------------------------------------------
  60
  61     /** unregisters a listener for spin events.
  62      */
  63     [oneway] void removeSpinListener( [in] com::sun::star::awt::XSpinListener l );
  64
  65     //-------------------------------------------------------------------------
  66
  67     /** increases the value by one step.
  68      */
  69     [oneway] void up();
  70
  71     //-------------------------------------------------------------------------
  72
  73     /** decreases the value by one step.
  74      */
  75     [oneway] void down();
  76
  77     //-------------------------------------------------------------------------
  78
  79     /** sets the value to the previously set lower value.
  80      */
  81     [oneway] void first();
  82
  83     //-------------------------------------------------------------------------
  84
  85     /** sets the value to the previously set upper value.
  86      */
  87     [oneway] void last();
  88
  89     //-------------------------------------------------------------------------
  90
  91     /** enables/disables automatic repeat mode.
  92      */
  93     [oneway] void enableRepeat( [in] boolean bRepeat );
  94
  95 };
  96
  97 //=============================================================================
  98
  99 }; }; }; };
 100
 101 #endif