/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 */



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


/** provides the access to a collection of forms.
 */
published interface XFormsSupplier: com::sun::star::uno::XInterface
{

    /** accesses the forms.

        @code{.bas}
        REM  *****  BASIC  *****

        Sub createColorSelectionBox
            ' create a new shape
            xShape = thisComponent.createInstance( "com.sun.star.drawing.ControlShape" )
            Dim aPos as new com.sun.star.awt.Point
            aPos.X = 200
            aPos.Y = 100
            xShape.Position = aPos
            Erase aPos
            Dim aSize as new com.sun.star.awt.Size
            aSize.Width = 2500
            aSize.Height = 5000
            xShape.Size = aSize
            Erase aSize

            ' create a combo box model
            xControlModel = thisComponent.createInstance( "com.sun.star.form.component.ComboBox" )
            xControlModel.Name = "ColorSelection"
            xControlModel.Text = "red"

            ' marry the shape and the model
            xShape.Control = xControlModel

            if ( 0 = thisComponent.DrawPage.Forms.getCount() ) Then
                xForm = thisComponent.createInstance( "com.sun.star.form.component.DataForm" )
                xForm.Name = "SampleForm"
                thisComponent.DrawPage.Forms.insertByIndex( 0, xForm )
            End If
            ' insert the control model into the first form of the forms collection of the
            ' draw page of the document
            thisComponent.DrawPage.Forms.getByIndex(0).insertByIndex( 0, xControlModel )
            thisComponent.DrawPage.add( xShape )
        End Sub
        @endcode

        @returns
            the container of all the top-level forms belonging to the component.
     */
    com::sun::star::container::XNameContainer getForms();

};


}; }; }; };

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
