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

/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * 
 *************************************************************/



#ifndef __com_sun_star_form_XFormsSupplier2_idl__
#define __com_sun_star_form_XFormsSupplier2_idl__

#ifndef __com_sun_star_form_XFormsSupplier_idl__
#include <com/sun/star/form/XFormsSupplier.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module form {

//=============================================================================

/** extends the <type>XFormsSupplier</type> with convenience methods
*/
interface XFormsSupplier2: XFormsSupplier
{
    /** determines whether there are currently forms available at all

        <p>If you need read access to the forms collection, then you might check
        the existence of forms using <member>hasForms</member>, and if it returns
        <FALSE/>, you can do as if <member>XFormsSupplier::getForms</member> would
        have returned an empty container.</p>

        <p>Semantically, <member>hasForms</member> is equivalent to calling
        <member>XElementAccess::hasElements</member> on the container returned by
        <member>XFormsSupplier::getForms</member>. But when using the latter, the
        implementation is forced to create a empty container, which might be potentially
        expensive.</p>
    */
    boolean hasForms();
};

//=============================================================================

}; }; }; };

/*=============================================================================

=============================================================================*/
#endif