offapi/com/sun/star/text/textfield/MetadataField.idl

   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
  28 #ifndef __com_sun_star_text_textfield_MetadataField_idl__
  29 #define __com_sun_star_text_textfield_MetadataField_idl__
  30
  31 #ifndef __com_sun_star_container_XEnumerationAccess_idl__
  32 #include <com/sun/star/container/XEnumerationAccess.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_container_XChild_idl__
  36 #include <com/sun/star/container/XChild.idl>
  37 #endif
  38
  39 #ifndef __com_sun_star_text_TextField_idl__
  40 #include <com/sun/star/text/TextField.idl>
  41 #endif
  42
  43 #ifndef __com_sun_star_text_XText_idl__
  44 #include <com/sun/star/text/XText.idl>
  45 #endif
  46
  47 #ifndef __com_sun_star_rdf_XMetadatable_idl__
  48 #include <com/sun/star/rdf/XMetadatable.idl>
  49 #endif
  50
  51
  52 //=============================================================================
  53
  54 module com { module sun { module star { module text { module textfield {
  55
  56 //=============================================================================
  57 /** is a <type scope="com::sun::star::text">TextField</type> whose content
  58     is specified by RDF metadata.
  59
  60     @since OOo 3.2
  61
  62     @see com::sun::star::rdf
  63 */
  64 service MetadataField
  65 {
  66     //-------------------------------------------------------------------------
  67     /** None of the properties of
  68         <type scope="com::sun::star::text">TextContent</type> are supported. */
  69     service  com::sun::star::text::TextField;
  70
  71     //-------------------------------------------------------------------------
  72     /** The <type>MetadataField</type> can have RDF metadata attached. */
  73     interface com::sun::star::rdf::XMetadatable;
  74
  75     //-------------------------------------------------------------------------
  76     /** Allows for insertion of text content into, and creating cursors
  77         that are bound within, the <type>MetadataField</type>. */
  78     interface com::sun::star::text::XText;
  79
  80     //-------------------------------------------------------------------------
  81     /** The <type scope="com::sun::star::text">TextContent</type>s that are
  82         contained in the <type>MetadataField</type> can be enumerated. */
  83     interface com::sun::star::container::XEnumerationAccess;
  84
  85     //-------------------------------------------------------------------------
  86     /** The <type scope="com::sun::star::text">TextContent</type>
  87         that is the parent of this <type>MetadataField</type>.
  88         @since OOo 3.3
  89      */
  90     interface com::sun::star::container::XChild;
  91
  92     //-------------------------------------------------------------------------
  93     /** this is the number format for this field.
  94         @see com::sun::star::util::NumberFormatter
  95     */
  96     [optional, property] long NumberFormat;
  97
  98     //-------------------------------------------------------------------------
  99     /** determines whether changes in language attributes at the
 100         position of the text field also change the number format
 101         as appropriate for this language.
 102      */
 103     [optional, property] boolean IsFixedLanguage;
 104 };
 105
 106 //=============================================================================
 107
 108 }; }; }; }; };
 109
 110 #endif
 111