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