offapi/com/sun/star/form/XFormsSupplier2.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XFormsSupplier2.idl,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_form_XFormsSupplier2_idl__
  32 #define __com_sun_star_form_XFormsSupplier2_idl__
  33
  34 #ifndef __com_sun_star_form_XFormsSupplier_idl__
  35 #include <com/sun/star/form/XFormsSupplier.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com {  module sun {  module star {  module form {
  41
  42 //=============================================================================
  43
  44 /** extends the <type>XFormsSupplier</type> with convenience methods
  45 */
  46 interface XFormsSupplier2: XFormsSupplier
  47 {
  48     /** determines whether there are currently forms available at all
  49
  50         <p>If you need read access to the forms collection, then you might check
  51         the existence of forms using <member>hasForms</member>, and if it returns
  52         <FALSE/>, you can do as if <member>XFormsSupplier::getForms</member> would
  53         have returned an empty container.</p>
  54
  55         <p>Semantically, <member>hasForms</member> is equivalent to calling
  56         <member>XElementAccess::hasElements</member> on the container returned by
  57         <member>XFormsSupplier::getForms</member>. But when using the latter, the
  58         implementation is forced to create a empty container, which might be potentially
  59         expensive.</p>
  60     */
  61     boolean hasForms();
  62 };
  63
  64 //=============================================================================
  65
  66 }; }; }; };
  67
  68 /*=============================================================================
  69
  70 =============================================================================*/
  71 #endif