offapi/com/sun/star/form/component/HiddenControl.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 /** This service specifies the model of a hidden control.
  26
  27     <p>The only sense of a hidden control is to store data in the form which is
  28     not visible to the user.</p>
  29
  30     <p>Usually, hidden controls are used in com::sun::star::form::component::HTMLForms,
  31     where they contain data which is to be submitted.<br/>
  32     Nevertheless, you can use them in your own forms for storing any data, for instance
  33     to evaluate it in some scripting macro.</p>
  34  */
  35 published service HiddenControl
  36 {
  37     service com::sun::star::form::FormComponent;
  38
  39     /** specifies the value of the component.
  40      */
  41     [property] string HiddenValue;
  42
  43 };
  44
  45
  46 }; }; }; }; };
  47
  48 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */