offapi/com/sun/star/text/textfield/GetReference.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: GetReference.idl,v $
  10  * $Revision: 1.7 $
  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_GetReference_idl__
  32 #define __com_sun_star_text_textfield_GetReference_idl__
  33
  34 #include <com/sun/star/text/TextField.idl>
  35
  36 //=============================================================================
  37
  38 module com { module sun { module star { module text { module textfield {
  39
  40 //=============================================================================
  41 /**     specifies service of a reference field.
  42     @see com::sun::star::text::TextField
  43 */
  44 published service GetReference
  45 {
  46     service  com::sun::star::text::TextField;
  47
  48     /** contains the current content of the text field.
  49         <p> This property is escpecially usefull for import/export purposes. </p>
  50      */
  51     [property] string CurrentPresentation;
  52     /** contains the source of the reference.
  53         @see com::sun::star::text::ReferenceFieldSource
  54      */
  55     [property] short ReferenceFieldSource;
  56     /** contains the name of the source.
  57      <p> Depending on the property ReferenceFieldSource it may be the name of
  58      a bookmark, a reference mark.</p>
  59      */
  60     [property] string SourceName;
  61     /** contains the type of the reference.
  62         @see com::sun::star::text::ReferenceFieldPart
  63      */
  64     [property] short ReferenceFieldPart;
  65     /** contains the sequence number of a set expression field that is used as sequence field
  66          or the value of the ReferenceId property of a footnote or endnote.
  67         @see com::sun::star::text::Footnote
  68      */
  69     [property] short SequenceNumber;
  70 };
  71
  72 //=============================================================================
  73
  74 }; }; }; }; };
  75
  76 #endif
  77