offapi/com/sun/star/text/textfield/FileName.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: FileName.idl,v $
  10  * $Revision: 1.4 $
  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_FileName_idl__
  32 #define __com_sun_star_text_textfield_FileName_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 text field that displays the file name (URL) of
  42  the document.
  43     @see com::sun::star::text::TextField
  44 */
  45 published service FileName
  46 {
  47     service  com::sun::star::text::TextField;
  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     /** determins the format the file name is displayed as specified in
  53         <type scope="com::sun::star::text">FilenameDisplayFormat</type>.
  54       */
  55     [property]short FileFormat;
  56     /** If this flag is set to <FALSE/> the content is regularly updated.
  57      */
  58     [property]boolean IsFixed;
  59 };
  60
  61 //=============================================================================
  62
  63 }; }; }; }; };
  64
  65 #endif
  66