office-gobmx/offapi/com/sun/star/form/XFormsSupplier.idl
Oliver Bolte d212dabdcd INTEGRATION: CWS sb18 (1.6.328); FILE MERGED
2004/05/21 14:58:36 sb 1.6.328.1: #i21150# Added published flag.
2004-06-03 18:42:25 +00:00

139 lines
5 KiB
Text

/*************************************************************************
*
* $RCSfile: XFormsSupplier.idl,v $
*
* $Revision: 1.7 $
*
* last change: $Author: obo $ $Date: 2004-06-03 19:41:55 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (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.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef __com_sun_star_form_XFormsSupplier_idl__
#define __com_sun_star_form_XFormsSupplier_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_container_XNameContainer_idl__
#include <com/sun/star/container/XNameContainer.idl>
#endif
//=============================================================================
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.
@example StarBASIC
<listing>
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
</listing>
@returns
the container of all the top-level forms belonging to the component.
*/
com::sun::star::container::XNameContainer getForms();
};
//=============================================================================
}; }; }; };
/*=============================================================================
=============================================================================*/
#endif