offapi/com/sun/star/form/XFormsSupplier.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21
  22  module com {  module sun {  module star {  module form {
  23
  24
  25 /** provides the access to a collection of forms.
  26  */
  27 published interface XFormsSupplier: com::sun::star::uno::XInterface
  28 {
  29
  30     /** accesses the forms.
  31
  32         @code{.bas}
  33         REM  *****  BASIC  *****
  34
  35         Sub createColorSelectionBox
  36             ' create a new shape
  37             xShape = thisComponent.createInstance( "com.sun.star.drawing.ControlShape" )
  38             Dim aPos as new com.sun.star.awt.Point
  39             aPos.X = 200
  40             aPos.Y = 100
  41             xShape.Position = aPos
  42             Erase aPos
  43             Dim aSize as new com.sun.star.awt.Size
  44             aSize.Width = 2500
  45             aSize.Height = 5000
  46             xShape.Size = aSize
  47             Erase aSize
  48
  49             ' create a combo box model
  50             xControlModel = thisComponent.createInstance( "com.sun.star.form.component.ComboBox" )
  51             xControlModel.Name = "ColorSelection"
  52             xControlModel.Text = "red"
  53
  54             ' marry the shape and the model
  55             xShape.Control = xControlModel
  56
  57             if ( 0 = thisComponent.DrawPage.Forms.getCount() ) Then
  58                 xForm = thisComponent.createInstance( "com.sun.star.form.component.DataForm" )
  59                 xForm.Name = "SampleForm"
  60                 thisComponent.DrawPage.Forms.insertByIndex( 0, xForm )
  61             End If
  62             ' insert the control model into the first form of the forms collection of the
  63             ' draw page of the document
  64             thisComponent.DrawPage.Forms.getByIndex(0).insertByIndex( 0, xControlModel )
  65             thisComponent.DrawPage.add( xShape )
  66         End Sub
  67         @endcode
  68
  69         @returns
  70             the container of all the top-level forms belonging to the component.
  71      */
  72     com::sun::star::container::XNameContainer getForms();
  73
  74 };
  75
  76
  77 }; }; }; };
  78
  79 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */