offapi/com/sun/star/form/component/CheckBox.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
  20
  21
  22  module com {  module sun {  module star {  module form {  module component {
  23
  24
  25 /** specifies the model of a check box control
  26
  27     <p>The model supports the properties required for HTML, thus you can build up
  28     HTMLForms with it</p>
  29  */
  30 published service CheckBox
  31 {
  32     service com::sun::star::awt::UnoControlCheckBoxModel;
  33
  34     service com::sun::star::form::FormControlModel;
  35
  36     /** can be used to reset the control to its default state.
  37
  38         @see CheckBox::DefaultState
  39     */
  40     interface com::sun::star::form::XReset;
  41
  42
  43     /** contains a default value for the control.
  44
  45         <p>This value is used when the control is initially displayed, and for resetting it.</p>
  46
  47         @see com::sun::star::awt::UnoControlCheckBoxModel::State
  48         @see com::sun::star::form::XReset
  49      */
  50     [property] short DefaultState;
  51
  52
  53     /** contains a reference value which is used for submission in a HTML
  54         form
  55
  56         <p>When submitting a HTMLForm which contains a check box,
  57         which is checked, the RefValue is used for submission.
  58      */
  59     [property] string RefValue;
  60 };
  61
  62
  63 }; }; }; }; };
  64
  65 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */