offapi/com/sun/star/text/textfield/Author.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
  21 module com { module sun { module star { module text { module textfield {
  22
  23 /** specifies service of an author text field.
  24     @see com::sun::star::text::TextField
  25 */
  26 published service Author
  27 {
  28     service  com::sun::star::text::TextField;
  29
  30     /** If this flag is set to false the author
  31         will be overridden by the current author
  32         each time the document is saved.
  33      */
  34     [optional, property] boolean IsFixed;
  35
  36     /** the is the content of this field
  37     */
  38     [optional, property] string Content;
  39
  40     /** this is the display format for this field
  41         @see com::sun::star::text::AuthorDisplayFormat
  42     */
  43     [optional, property] short AuthorFormat;
  44     /** contains the current content of the text field.
  45         <p> This property is especially useful for import/export purposes. </p>
  46      */
  47     [optional, property]string CurrentPresentation;
  48     /** determines whether the full name of the author is displayed rather than
  49      the initials.
  50      */
  51     [optional, property]boolean FullName;
  52 };
  53
  54
  55 }; }; }; }; };
  56
  57 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */