offapi/com/sun/star/text/XTextFieldsSupplier.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_XTextFieldsSupplier_idl__
  20 #define __com_sun_star_text_XTextFieldsSupplier_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/container/XEnumerationAccess.idl>
  24 #include <com/sun/star/container/XNameAccess.idl>
  25
  26
  27
  28  module com {  module sun {  module star {  module text {
  29
  30 /** makes it possible to access the text fields used in this context
  31     (e.g. this document).@see com::sun::star::sheet::SpreadsheetDocument
  32         @see TextDocument
  33  */
  34 published interface XTextFieldsSupplier: com::sun::star::uno::XInterface
  35 {
  36     /** @returns
  37                 the collection of TextField instances
  38                 in this context (i.e. this document).
  39      */
  40     com::sun::star::container::XEnumerationAccess getTextFields();
  41
  42     /** @returns
  43                 the collection of TextFieldMaster instances
  44                 which are defined in this context (i.e. this document).
  45      */
  46     com::sun::star::container::XNameAccess getTextFieldMasters();
  47
  48 };
  49
  50
  51 }; }; }; };
  52
  53 #endif
  54
  55 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */