offapi/com/sun/star/form/FormControlModel.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: FormControlModel.idl,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_form_FormControlModel_idl__
  31 #define __com_sun_star_form_FormControlModel_idl__
  32
  33 #ifndef __com_sun_star_awt_UnoControlModel_idl__
  34 #include <com/sun/star/awt/UnoControlModel.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_form_FormComponent_idl__
  38 #include <com/sun/star/form/FormComponent.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_beans_XFastPropertySet_idl__
  42 #include <com/sun/star/beans/XFastPropertySet.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_beans_XPropertyState_idl__
  46 #include <com/sun/star/beans/XPropertyState.idl>
  47 #endif
  48
  49
  50 //=============================================================================
  51
  52  module com {  module sun {  module star {  module form {
  53
  54 //=============================================================================
  55
  56 /** specifies a control model within a form.
  57
  58     <p>Note that the model-view-paradigm is used for form controls, too.</p>
  59  */
  60 published service FormControlModel
  61 {
  62     service com::sun::star::awt::UnoControlModel;
  63
  64     service com::sun::star::form::FormComponent;
  65
  66     /** This optional interface gives an efficient access to all
  67                 properties at once or an ability to set more than one property at once.
  68      */
  69     [optional] interface com::sun::star::beans::XFastPropertySet;
  70
  71
  72     /** This optional interface gives access to the state of the
  73                 properties, e.g. whether a default value
  74                 is to be used or not for a certain property.
  75      */
  76     [optional] interface com::sun::star::beans::XPropertyState;
  77
  78     //-------------------------------------------------------------------------
  79
  80     /** specifies the ID for classification of the component.
  81         @see FormComponentType
  82      */
  83     [readonly, property] short ClassId;
  84
  85     //-------------------------------------------------------------------------
  86
  87     /** determines the relative taborder of the control associated with the model.
  88
  89         <p>The default -1 is used to indicate that the tab-order of this control should be
  90         determined automatically.</p>
  91
  92         <p>Each component which supports a tabstop must provide a
  93         <member>FormControlModel::TabIndex</member> property.</p>
  94
  95         <p>Normally, a <type>FormController</type> instance is evaluating this property.</p>
  96      */
  97     [optional, property] short TabIndex;
  98
  99     //-------------------------------------------------------------------------
 100
 101     /** used for additional information.
 102         <p>No semantics is given for this property, it will usually be used by the creator of a document
 103         containing form controls.</p>
 104      */
 105     [property] string Tag;
 106
 107 };
 108
 109 //=============================================================================
 110
 111 }; }; }; };
 112
 113 #endif