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#ifndef __com_sun_star_form_XFormsSupplier_idl__
28#define __com_sun_star_form_XFormsSupplier_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_container_XNameContainer_idl__
35#include <com/sun/star/container/XNameContainer.idl>
36#endif
37
38
39//=============================================================================
40
41 module com {  module sun {  module star {  module form {
42
43//=============================================================================
44
45/** provides the access to a collection of forms.
46 */
47published interface XFormsSupplier: com::sun::star::uno::XInterface
48{
49	//-------------------------------------------------------------------------
50
51	/** accesses the forms.
52
53		@example StarBASIC
54		<listing>
55		REM  *****  BASIC  *****
56
57		Sub createColorSelectionBox
58			' create a new shape
59			xShape = thisComponent.createInstance( "com.sun.star.drawing.ControlShape" )
60			Dim aPos as new com.sun.star.awt.Point
61			aPos.X = 200
62			aPos.Y = 100
63			xShape.Position = aPos
64			Erase aPos
65			Dim aSize as new com.sun.star.awt.Size
66			aSize.Width = 2500
67			aSize.Height = 5000
68			xShape.Size = aSize
69			Erase aSize
70
71			' create a combo box model
72			xControlModel = thisComponent.createInstance( "com.sun.star.form.component.ComboBox" )
73			xControlModel.Name = "ColorSelection"
74			xControlModel.Text = "red"
75
76			' marry the shape and the model
77			xShape.Control = xControlModel
78
79			if ( 0 = thisComponent.DrawPage.Forms.getCount() ) Then
80				xForm = thisComponent.createInstance( "com.sun.star.form.component.DataForm" )
81				xForm.Name = "SampleForm"
82				thisComponent.DrawPage.Forms.insertByIndex( 0, xForm )
83			End If
84			' insert the control model into the first form of the forms collection of the
85			' draw page of the document
86			thisComponent.DrawPage.Forms.getByIndex(0).insertByIndex( 0, xControlModel )
87			thisComponent.DrawPage.add( xShape )
88		End Sub
89		</listing>
90
91		@returns
92			the container of all the top-level forms belonging to the component.
93	 */
94	com::sun::star::container::XNameContainer getForms();
95
96};
97
98//=============================================================================
99
100}; }; }; };
101
102/*=============================================================================
103
104=============================================================================*/
105#endif
106