offapi/com/sun/star/form/FormControlModel.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 {
  23
  24
  25 /** specifies a control model within a form.
  26
  27     <p>Note that the model-view-paradigm is used for form controls, too.</p>
  28  */
  29 published service FormControlModel
  30 {
  31     service com::sun::star::awt::UnoControlModel;
  32
  33     service com::sun::star::form::FormComponent;
  34
  35     /** This optional interface gives an efficient access to all
  36                 properties at once or an ability to set more than one property at once.
  37      */
  38     [optional] interface com::sun::star::beans::XFastPropertySet;
  39
  40
  41     /** This optional interface gives access to the state of the
  42                 properties, e.g. whether a default value
  43                 is to be used or not for a certain property.
  44      */
  45     [optional] interface com::sun::star::beans::XPropertyState;
  46
  47
  48     /** specifies the ID for classification of the component.
  49         @see FormComponentType
  50      */
  51     [readonly, property] short ClassId;
  52
  53
  54     /** determines the relative taborder of the control associated with the model.
  55
  56         <p>The default -1 is used to indicate that the tab-order of this control should be
  57         determined automatically.</p>
  58
  59         <p>Each component which supports a tabstop must provide a
  60         FormControlModel::TabIndex property.</p>
  61
  62         <p>Normally, a FormController instance is evaluating this property.</p>
  63      */
  64     [optional, property] short TabIndex;
  65
  66
  67     /** used for additional information.
  68         <p>No semantics is given for this property, it will usually be used by the creator of a document
  69         containing form controls.</p>
  70      */
  71     [property] string Tag;
  72
  73 };
  74
  75
  76 }; }; }; };
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */