offapi/com/sun/star/form/component/RadioButton.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: RadioButton.idl,v $
  10  * $Revision: 1.11 $
  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_RadioButton_idl__
  31 #define __com_sun_star_form_component_RadioButton_idl__
  32
  33 #ifndef __com_sun_star_awt_UnoControlRadioButtonModel_idl__
  34 #include <com/sun/star/awt/UnoControlRadioButtonModel.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_form_FormControlModel_idl__
  38 #include <com/sun/star/form/FormControlModel.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 a component which acts as a radio button as needed in <type>HTMLForm</type>s.
  53
  54     <p>Radio buttons are controls which can be grouped together, and in every
  55     group, only one of the controls can be check. This means if one of them
  56     is checked by a user interaction, all other controls in the same group
  57     are automatically unchecked</p>
  58
  59     <p>Like in HTML, radio buttons are grouped together if and only if they have the
  60     same name (see <member scope="com::sun::star::form">FormComponent::Name</member>).</p>
  61  */
  62 published service RadioButton
  63 {
  64     service com::sun::star::awt::UnoControlRadioButtonModel;
  65
  66     service com::sun::star::form::FormControlModel;
  67
  68     /** can be used to reset the control to it's default text.
  69
  70         @see RadioButton::DefaultState
  71     */
  72     interface com::sun::star::form::XReset;
  73
  74     //-------------------------------------------------------------------------
  75
  76     /** contains a default value for the control.
  77
  78         <p>This value is used when the control is initially displayed, and for resetting it.</p>
  79
  80         <p> In a group of radio buttons only one button should be checked
  81         by default.</p>
  82
  83         @see com::sun::star::awt::UnoControlRadioButtonModel::State
  84         @see com::sun::star::form::XReset
  85      */
  86     [property] short DefaultState;
  87
  88     //-------------------------------------------------------------------------
  89
  90     /** contains a reference value which is used for submission in a HTML
  91         form.
  92
  93         <p>If the form the control belongs to is to be submitted (see
  94         <type scope="com::sun::star::form">XSubmit</type>), and the control is checked, this reference
  95         value is used for submission.</p>
  96      */
  97     [property] string RefValue;
  98
  99
 100     /** specifies a value which is to be associated with the control when it's <em>not</em>
 101         selected.
 102
 103         <p>In various situations, the <member>RefValue</member> is associated with the control
 104         if and only if it is selected.<br/>
 105         <member>UncheckedRefValue</member> provides a extensions of this concept: If present,
 106         the value should be associated with the control when it is <em>not</em> selected.</p>
 107     */
 108     [optional, property] string UncheckedRefValue;
 109 };
 110
 111 //=============================================================================
 112
 113 }; }; }; }; };
 114
 115 #endif