tdf#130857 qt weld: Implement QtInstanceWidget::strip_mnemonic
[LibreOffice.git] / offapi / com / sun / star / form / component / RadioButton.idl
blob754802ac7e181b9a83e52b0a3dfc78d1f34fa547
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
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/.
9 * This file incorporates work covered by the following license notice:
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 .
22 module com { module sun { module star { module form { module component {
25 /** specifies a component which acts as a radio button as needed in HTMLForms.
27 <p>Radio buttons are controls which can be grouped together, and in every
28 group, only one of the controls can be check. This means if one of them
29 is checked by a user interaction, all other controls in the same group
30 are automatically unchecked</p>
32 <p>Like in HTML, radio buttons are grouped together if and only if they have the
33 same name (see com::sun::star::form::FormComponent::Name).</p>
35 published service RadioButton
37 service com::sun::star::awt::UnoControlRadioButtonModel;
39 service com::sun::star::form::FormControlModel;
41 /** can be used to reset the control to its default text.
43 @see RadioButton::DefaultState
45 interface com::sun::star::form::XReset;
48 /** contains a default value for the control.
50 <p>This value is used when the control is initially displayed, and for resetting it.</p>
52 <p> In a group of radio buttons only one button should be checked
53 by default.</p>
55 @see com::sun::star::awt::UnoControlRadioButtonModel::State
56 @see com::sun::star::form::XReset
58 [property] short DefaultState;
61 /** contains a reference value which is used for submission in a HTML
62 form.
64 <p>If the form the control belongs to is to be submitted (see
65 com::sun::star::form::XSubmit), and the control is checked, this reference
66 value is used for submission.</p>
68 [property] string RefValue;
71 /** specifies a value which is to be associated with the control when it's <em>not</em>
72 selected.
74 <p>In various situations, the #RefValue is associated with the control
75 if and only if it is selected.<br/>
76 #UncheckedRefValue provides an extension of this concept: If present,
77 the value should be associated with the control when it is <em>not</em> selected.</p>
79 [optional, property] string UncheckedRefValue;
83 }; }; }; }; };
85 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */