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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_text_textfield_Author_idl__
  29 #define __com_sun_star_text_textfield_Author_idl_
  30
  31 #include <com/sun/star/text/TextField.idl>
  32
  33 //=============================================================================
  34
  35 module com { module sun { module star { module text { module textfield {
  36
  37 //=============================================================================
  38 /** specifies service of an author text field.
  39     @see com::sun::star::text::TextField
  40 */
  41 published service Author
  42 {
  43     service  com::sun::star::text::TextField;
  44
  45     /** If this flag is set to false the author
  46         will be overiden by the current author
  47         each time the document is saved.
  48      */
  49     [optional, property] boolean IsFixed;
  50
  51     /** the is the content of this field
  52     */
  53     [optional, property] string Content;
  54
  55     /** this is the display format for this field
  56         @see com::sun::star::text::AuthorDisplayFormat
  57     */
  58     [optional, property] short AuthorFormat;
  59     /** contains the current content of the text field.
  60         <p> This property is escpecially usefull for import/export purposes. </p>
  61      */
  62     [optional, property]string CurrentPresentation;
  63     /** determines whether the full name of the author is displayed rather than
  64      the initials.
  65      */
  66     [optional, property]boolean FullName;
  67 };
  68
  69 //=============================================================================
  70
  71 }; }; }; }; };
  72
  73 #endif
  74