offapi/com/sun/star/form/XFormsSupplier2.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 form {
  22
  23
  24 /** extends the XFormsSupplier with convenience methods
  25 */
  26 interface XFormsSupplier2: XFormsSupplier
  27 {
  28     /** determines whether there are currently forms available at all
  29
  30         <p>If you need read access to the forms collection, then you might check
  31         the existence of forms using hasForms(), and if it returns
  32         `FALSE`, you can do as if XFormsSupplier::getForms() would
  33         have returned an empty container.</p>
  34
  35         <p>Semantically, hasForms() is equivalent to calling
  36         XElementAccess::hasElements() on the container returned by
  37         XFormsSupplier::getForms(). But when using the latter, the
  38         implementation is forced to create an empty container, which might be potentially
  39         expensive.</p>
  40     */
  41     boolean hasForms();
  42 };
  43
  44
  45 }; }; }; };
  46
  47 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */