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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_text_textfield_MetadataField_idl__
  21 #define __com_sun_star_text_textfield_MetadataField_idl__
  22
  23 #include <com/sun/star/container/XEnumerationAccess.idl>
  24 #include <com/sun/star/container/XChild.idl>
  25 #include <com/sun/star/text/TextField.idl>
  26 #include <com/sun/star/text/XText.idl>
  27 #include <com/sun/star/rdf/XMetadatable.idl>
  28
  29
  30
  31 module com { module sun { module star { module text { module textfield {
  32
  33 /** is a com::sun::star::text::TextField whose content
  34     is specified by RDF metadata.
  35
  36     @since OOo 3.2
  37
  38     @see com::sun::star::rdf
  39 */
  40 service MetadataField
  41 {
  42     /** None of the properties of
  43         com::sun::star::text::TextContent are supported. */
  44     service  com::sun::star::text::TextField;
  45
  46     /** The MetadataField can have RDF metadata attached. */
  47     interface com::sun::star::rdf::XMetadatable;
  48
  49     /** Allows for insertion of text content into, and creating cursors
  50         that are bound within, the MetadataField. */
  51     interface com::sun::star::text::XText;
  52
  53     /** The com::sun::star::text::TextContents that are
  54         contained in the MetadataField can be enumerated. */
  55     interface com::sun::star::container::XEnumerationAccess;
  56
  57     /** The com::sun::star::text::TextContent
  58         that is the parent of this MetadataField.
  59         @since OOo 3.3
  60      */
  61     interface com::sun::star::container::XChild;
  62
  63     /** this is the number format for this field.
  64         @see com::sun::star::util::NumberFormatter
  65     */
  66     [optional, property] long NumberFormat;
  67
  68     /** determines whether changes in language attributes at the
  69         position of the text field also change the number format
  70         as appropriate for this language.
  71      */
  72     [optional, property] boolean IsFixedLanguage;
  73 };
  74
  75
  76 }; }; }; }; };
  77
  78 #endif
  79
  80 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */