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