offapi/com/sun/star/form/component/Form.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_Form_idl__
  20 #define __com_sun_star_form_component_Form_idl__
  21
  22 #include <com/sun/star/form/FormComponent.idl>
  23 #include <com/sun/star/form/FormComponents.idl>
  24 #include <com/sun/star/form/XForm.idl>
  25 #include <com/sun/star/awt/XTabControllerModel.idl>
  26 #include <com/sun/star/script/XEventAttacherManager.idl>
  27
  28
  29
  30  module com {  module sun {  module star {  module form {  module component {
  31
  32
  33 /** This service specifies a form which is a group of FormComponents.
  34
  35     <p>A form fulfills several tasks, like storing the structure of its
  36     form components, storing the information concerning tab ordering
  37     and control grouping, and last but not least, it provides the
  38     event environment for its contained elements.</p>
  39
  40     <p>A form acts on the one hand like a container of FormComponents
  41     and on the other hand like a FormComponent. This generic
  42     construction allows the definition of hierarchies of forms and their
  43     dependent subforms.</p>
  44
  45     @see com::sun::star::form::FormControlModel
  46  */
  47 published service Form
  48 {
  49     service com::sun::star::form::FormComponent;
  50
  51     service com::sun::star::form::FormComponents;
  52
  53     /** identifies a component as form.
  54      */
  55     interface com::sun::star::form::XForm;
  56
  57
  58     /** This interface has to be implemented to supply the information for tab ordering and component grouping.
  59
  60         @see com::sun::star::form::FormControlModel::TabIndex
  61      */
  62     interface com::sun::star::awt::XTabControllerModel;
  63 };
  64
  65
  66 }; }; }; }; };
  67
  68 #endif
  69
  70 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */