xref: /trunk/main/offapi/com/sun/star/text/textfield/MetadataField.idl (revision 2a413f17)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef __com_sun_star_text_textfield_MetadataField_idl__
#define __com_sun_star_text_textfield_MetadataField_idl__

#ifndef __com_sun_star_container_XEnumerationAccess_idl__
#include <com/sun/star/container/XEnumerationAccess.idl>
#endif

#ifndef __com_sun_star_container_XChild_idl__
#include <com/sun/star/container/XChild.idl>
#endif

#ifndef __com_sun_star_text_TextField_idl__
#include <com/sun/star/text/TextField.idl>
#endif

#ifndef __com_sun_star_text_XText_idl__
#include <com/sun/star/text/XText.idl>
#endif

#ifndef __com_sun_star_rdf_XMetadatable_idl__
#include <com/sun/star/rdf/XMetadatable.idl>
#endif


//=============================================================================

module com { module sun { module star { module text { module textfield {

//=============================================================================
/** is a <type scope="com::sun::star::text">TextField</type> whose content
    is specified by RDF metadata.

    @since OpenOffice 3.2

    @see com::sun::star::rdf
*/
published service MetadataField
{
    //-------------------------------------------------------------------------
    /** None of the properties of
        <type scope="com::sun::star::text">TextContent</type> are supported. */
    service  com::sun::star::text::TextField;

    //-------------------------------------------------------------------------
    /** The <type>MetadataField</type> can have RDF metadata attached. */
    interface com::sun::star::rdf::XMetadatable;

    //-------------------------------------------------------------------------
    /** Allows for insertion of text content into, and creating cursors
        that are bound within, the <type>MetadataField</type>. */
    interface com::sun::star::text::XText;

    //-------------------------------------------------------------------------
    /** The <type scope="com::sun::star::text">TextContent</type>s that are
        contained in the <type>MetadataField</type> can be enumerated. */
    interface com::sun::star::container::XEnumerationAccess;

    //-------------------------------------------------------------------------
    /** The <type scope="com::sun::star::text">TextContent</type>
        that is the parent of this <type>MetadataField</type>.
        @since OpenOffice 3.3
     */
    interface com::sun::star::container::XChild;

    //-------------------------------------------------------------------------
    /** this is the number format for this field.
        @see com::sun::star::util::NumberFormatter
    */
    [optional, property] long NumberFormat;

    //-------------------------------------------------------------------------
    /** determines whether changes in language attributes at the
        position of the text field also change the number format
        as appropriate for this language.
     */
    [optional, property] boolean IsFixedLanguage;
};

//=============================================================================

}; }; }; }; };

#endif