offapi/com/sun/star/text/TextFieldMaster.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: TextFieldMaster.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_text_TextFieldMaster_idl__
  31 #define __com_sun_star_text_TextFieldMaster_idl__
  32
  33 #ifndef __com_sun_star_beans_XPropertySet_idl__
  34 #include <com/sun/star/beans/XPropertySet.idl>
  35 #endif
  36 #ifndef __com_sun_star_text_XDependentTextField_idl__
  37 #include <com/sun/star/text/XDependentTextField.idl>
  38 #endif
  39
  40 //=============================================================================
  41
  42  module com {  module sun {  module star {  module text {
  43
  44 //=============================================================================
  45
  46 /** A <type>TextFieldMaster</type> specifies important data for its
  47     <type>DependentTextField</type>s.
  48  */
  49 published service TextFieldMaster
  50 {
  51     /** This optional interface makes it possible to access properties of
  52                 this field master, if any.
  53      */
  54     [optional] interface com::sun::star::beans::XPropertySet;
  55     //------------------------------------------------------------------------
  56     /** determins the name of the field master. The name is void as long as the
  57      instance is not member of the document structure. When the value is being set
  58      the instance is inserted into the document and the name cannot be changed afterwards.
  59      That does not apply to the Database text field master.
  60      */
  61     [optional, property]  string Name;
  62         //------------------------------------------------------------------------
  63     /** contains a sequence of all fields that depend on this master.
  64      */
  65     [readonly, property]  sequence< XDependentTextField> DependentTextFields;
  66     //------------------------------------------------------------------------
  67     /** contains the instance name as it is used in the <type scope="::com::sun::star::text">
  68         XTextFieldsSupplier</type>.
  69      */
  70     [readonly, property]  string InstanceName;
  71 };
  72
  73 //=============================================================================
  74
  75 }; }; }; };
  76
  77 #endif