offapi/com/sun/star/form/component/RadioButton.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_form_component_RadioButton_idl__
  20 #define __com_sun_star_form_component_RadioButton_idl__
  21
  22 #include <com/sun/star/awt/UnoControlRadioButtonModel.idl>
  23
  24 #include <com/sun/star/form/FormControlModel.idl>
  25
  26 #include <com/sun/star/form/XReset.idl>
  27
  28
  29
  30  module com {  module sun {  module star {  module form {  module component {
  31
  32
  33 /** specifies a component which acts as a radio button as needed in HTMLForms.
  34
  35     <p>Radio buttons are controls which can be grouped together, and in every
  36     group, only one of the controls can be check. This means if one of them
  37     is checked by a user interaction, all other controls in the same group
  38     are automatically unchecked</p>
  39
  40     <p>Like in HTML, radio buttons are grouped together if and only if they have the
  41     same name (see com::sun::star::form::FormComponent::Name).</p>
  42  */
  43 published service RadioButton
  44 {
  45     service com::sun::star::awt::UnoControlRadioButtonModel;
  46
  47     service com::sun::star::form::FormControlModel;
  48
  49     /** can be used to reset the control to its default text.
  50
  51         @see RadioButton::DefaultState
  52     */
  53     interface com::sun::star::form::XReset;
  54
  55
  56     /** contains a default value for the control.
  57
  58         <p>This value is used when the control is initially displayed, and for resetting it.</p>
  59
  60         <p> In a group of radio buttons only one button should be checked
  61         by default.</p>
  62
  63         @see com::sun::star::awt::UnoControlRadioButtonModel::State
  64         @see com::sun::star::form::XReset
  65      */
  66     [property] short DefaultState;
  67
  68
  69     /** contains a reference value which is used for submission in a HTML
  70         form.
  71
  72         <p>If the form the control belongs to is to be submitted (see
  73         com::sun::star::form::XSubmit), and the control is checked, this reference
  74         value is used for submission.</p>
  75      */
  76     [property] string RefValue;
  77
  78
  79     /** specifies a value which is to be associated with the control when it's <em>not</em>
  80         selected.
  81
  82         <p>In various situations, the #RefValue is associated with the control
  83         if and only if it is selected.<br/>
  84         #UncheckedRefValue provides a extensions of this concept: If present,
  85         the value should be associated with the control when it is <em>not</em> selected.</p>
  86     */
  87     [optional, property] string UncheckedRefValue;
  88 };
  89
  90
  91 }; }; }; }; };
  92
  93 #endif
  94
  95 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */