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