AOO410/main/offapi/com/sun/star/form/component/Form.idl

/**************************************************************
 * 
 * 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_Form_idl__
#define __com_sun_star_form_component_Form_idl__

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

#ifndef __com_sun_star_form_FormComponents_idl__
#include <com/sun/star/form/FormComponents.idl>
#endif

#ifndef __com_sun_star_form_XForm_idl__
#include <com/sun/star/form/XForm.idl>
#endif

#ifndef __com_sun_star_awt_XTabControllerModel_idl__
#include <com/sun/star/awt/XTabControllerModel.idl>
#endif

#ifndef __com_sun_star_script_XEventAttacherManager_idl__
#include <com/sun/star/script/XEventAttacherManager.idl>
#endif


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

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

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

/** This service specifies a form which is a group of FormComponents.

	<p>A form fulfills several tasks, like storing the structure of its
	form components, storing the information concerning tab ordering
	and control grouping, and last but not least, it provides the
	event environment for its contained elements.</p>

	<p>A form acts on the one hand like a container of FormComponents
	and on the other hand like a FormComponent. This generic
	construction allows the definition of hierarchies of forms and their
	dependent subforms.</p>

	@see com::sun::star::form::FormControlModel
 */
published service Form
{
	service com::sun::star::form::FormComponent;

	service com::sun::star::form::FormComponents;

	/** identifies a component as form.
	 */
	interface com::sun::star::form::XForm;


	/** This interface has to be implemented to supply the information for tab ordering and component grouping.

		@see com::sun::star::form::FormControlModel::TabIndex
	 */
	interface com::sun::star::awt::XTabControllerModel;
};

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

}; }; }; }; };

#endif