offapi/com/sun/star/form/component/CheckBox.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: CheckBox.idl,v $
  10  * $Revision: 1.12 $
  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_form_component_CheckBox_idl__
  31 #define __com_sun_star_form_component_CheckBox_idl__
  32
  33 #ifndef __com_sun_star_form_FormControlModel_idl__
  34 #include <com/sun/star/form/FormControlModel.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_awt_UnoControlCheckBoxModel_idl__
  38 #include <com/sun/star/awt/UnoControlCheckBoxModel.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_form_XReset_idl__
  42 #include <com/sun/star/form/XReset.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48  module com {  module sun {  module star {  module form {  module component {
  49
  50 //=============================================================================
  51
  52 /** specifies the model of a check box control
  53
  54     <p>The model supports the properties required for HTML, thus you can build up
  55     <type>HTMLForm</type>s with it</p>
  56  */
  57 published service CheckBox
  58 {
  59     service com::sun::star::awt::UnoControlCheckBoxModel;
  60
  61     service com::sun::star::form::FormControlModel;
  62
  63     /** can be used to reset the control to it's default state.
  64
  65         @see CheckBox::DefaultState
  66     */
  67     interface com::sun::star::form::XReset;
  68
  69     //-------------------------------------------------------------------------
  70
  71     /** contains a default value for the control.
  72
  73         <p>This value is used when the control is initially displayed, and for resetting it.</p>
  74
  75         @see com::sun::star::awt::UnoControlCheckBoxModel::State
  76         @see com::sun::star::form::XReset
  77      */
  78     [property] short DefaultState;
  79
  80     //-------------------------------------------------------------------------
  81
  82     /** contains a reference value which is used for submission in a HTML
  83         form
  84
  85         <p>When submitting a <type>HTMLForm</type> which contains a check box,
  86         which is checked, the RefValue is used for submission.
  87      */
  88     [property] string RefValue;
  89 };
  90
  91 //=============================================================================
  92
  93 }; }; }; }; };
  94
  95 #endif