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