offapi/com/sun/star/text/TextFieldMaster.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 #ifndef __com_sun_star_text_TextFieldMaster_idl__
  20 #define __com_sun_star_text_TextFieldMaster_idl__
  21
  22 #include <com/sun/star/beans/XPropertySet.idl>
  23 #include <com/sun/star/text/XDependentTextField.idl>
  24
  25
  26  module com {  module sun {  module star {  module text {
  27
  28
  29 /** A TextFieldMaster specifies important data for its
  30     DependentTextFields.
  31  */
  32 published service TextFieldMaster
  33 {
  34     /** This optional interface makes it possible to access properties of
  35                 this field master, if any.
  36      */
  37     [optional] interface com::sun::star::beans::XPropertySet;
  38     /** determines the name of the field master. The name is void as long as the
  39      instance is not member of the document structure. When the value is being set
  40      the instance is inserted into the document and the name cannot be changed afterwards.
  41      That does not apply to the Database text field master.
  42      */
  43     [optional, property]  string Name;
  44     /** contains a sequence of all fields that depend on this master.
  45      */
  46     [readonly, property]  sequence< XDependentTextField> DependentTextFields;
  47     /** contains the instance name as it is used in the
  48         ::com::sun::star::text::XTextFieldsSupplier.
  49      */
  50     [readonly, property]  string InstanceName;
  51 };
  52
  53
  54 }; }; }; };
  55
  56 #endif
  57
  58 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */