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