xref: /aoo42x/main/offapi/com/sun/star/form/component/HiddenControl.idl (revision d1766043)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_form_component_HiddenControl_idl__
#define __com_sun_star_form_component_HiddenControl_idl__

#ifndef __com_sun_star_form_FormComponent_idl__
#include <com/sun/star/form/FormComponent.idl>
#endif


//=============================================================================

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

//=============================================================================

/** This service specifies the model of a hidden control.

	<p>The only sense of a hidden control is to store data in the form which is
	not visible to the user.</p>

	<p>Usually, hidden controls are used in <type scope="com::sun::star::form::component">HTMLForm</type>s,
	where they contain data which is to be submitted.<br/>
	Nevertheless, you can use them in your own forms for storing any data, for instance
	to evaluate it in some scripting macro.</p>
 */
published service HiddenControl
{
	service com::sun::star::form::FormComponent;

	/** specifies the value of the component.
	 */
	[property] string HiddenValue;

};

//=============================================================================

}; }; }; }; };

#endif