offapi/com/sun/star/form/XFormsSupplier2.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_form_XFormsSupplier2_idl__
  29 #define __com_sun_star_form_XFormsSupplier2_idl__
  30
  31 #ifndef __com_sun_star_form_XFormsSupplier_idl__
  32 #include <com/sun/star/form/XFormsSupplier.idl>
  33 #endif
  34
  35 //=============================================================================
  36
  37 module com {  module sun {  module star {  module form {
  38
  39 //=============================================================================
  40
  41 /** extends the <type>XFormsSupplier</type> with convenience methods
  42 */
  43 interface XFormsSupplier2: XFormsSupplier
  44 {
  45     /** determines whether there are currently forms available at all
  46
  47         <p>If you need read access to the forms collection, then you might check
  48         the existence of forms using <member>hasForms</member>, and if it returns
  49         <FALSE/>, you can do as if <member>XFormsSupplier::getForms</member> would
  50         have returned an empty container.</p>
  51
  52         <p>Semantically, <member>hasForms</member> is equivalent to calling
  53         <member>XElementAccess::hasElements</member> on the container returned by
  54         <member>XFormsSupplier::getForms</member>. But when using the latter, the
  55         implementation is forced to create a empty container, which might be potentially
  56         expensive.</p>
  57     */
  58     boolean hasForms();
  59 };
  60
  61 //=============================================================================
  62
  63 }; }; }; };
  64
  65 /*=============================================================================
  66
  67 =============================================================================*/
  68 #endif