summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/form/component/CheckBox.idl
blob: b793bc4f0f018b09594b7388cc4ce5c31ecc82c5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_form_component_CheckBox_idl__
#define __com_sun_star_form_component_CheckBox_idl__

#include <com/sun/star/form/FormControlModel.idl>
#include <com/sun/star/awt/UnoControlCheckBoxModel.idl>
#include <com/sun/star/form/XReset.idl>



 module com {  module sun {  module star {  module form {  module component {


/** specifies the model of a check box control

    <p>The model supports the properties required for HTML, thus you can build up
    HTMLForms with it</p>
 */
published service CheckBox
{
    service com::sun::star::awt::UnoControlCheckBoxModel;

    service com::sun::star::form::FormControlModel;

    /** can be used to reset the control to its default state.

        @see CheckBox::DefaultState
    */
    interface com::sun::star::form::XReset;


    /** contains a default value for the control.

        <p>This value is used when the control is initially displayed, and for resetting it.</p>

        @see com::sun::star::awt::UnoControlCheckBoxModel::State
        @see com::sun::star::form::XReset
     */
    [property] short DefaultState;


    /** contains a reference value which is used for submission in a HTML
        form

        <p>When submitting a HTMLForm which contains a check box,
        which is checked, the RefValue is used for submission.
     */
    [property] string RefValue;
};


}; }; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */