offapi/com/sun/star/awt/XCheckBox.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: XCheckBox.idl,v $
  10  * $Revision: 1.8 $
  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_XCheckBox_idl__
  31 #define __com_sun_star_awt_XCheckBox_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_XItemListener_idl__
  38 #include <com/sun/star/awt/XItemListener.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module awt {
  45
  46 //=============================================================================
  47
  48 /** gives access to the state of a check box and makes it possible
  49     to register for events.
  50  */
  51 published interface XCheckBox: com::sun::star::uno::XInterface
  52 {
  53     //-------------------------------------------------------------------------
  54
  55     /** registers a listener for item events.
  56      */
  57     [oneway] void addItemListener( [in] com::sun::star::awt::XItemListener l );
  58
  59     //-------------------------------------------------------------------------
  60
  61     /** unregisters a listener for item events.
  62      */
  63     [oneway] void removeItemListener( [in] com::sun::star::awt::XItemListener l );
  64
  65     //-------------------------------------------------------------------------
  66
  67     /** returns the state of the check box.
  68      */
  69     short getState();
  70
  71     //-------------------------------------------------------------------------
  72
  73     /** sets the state of the check box.
  74      */
  75     [oneway] void setState( [in] short n );
  76
  77     //-------------------------------------------------------------------------
  78
  79     /** sets the label of the check box.
  80      */
  81     [oneway] void setLabel( [in] string Label );
  82
  83     //-------------------------------------------------------------------------
  84
  85     /** enables or disables the tri state mode.
  86      */
  87     [oneway] void enableTriState( [in] boolean b );
  88
  89 };
  90
  91 //=============================================================================
  92
  93 }; }; }; };
  94
  95 #endif