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