offapi/com/sun/star/view/XFormLayerAccess.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: XFormLayerAccess.idl,v $
  10  * $Revision: 1.3 $
  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
  31 #ifndef __offapi_com_sun_star_view_XFormLayerAccess_idl__
  32 #define __offapi_com_sun_star_view_XFormLayerAccess_idl__
  33
  34 #ifndef __com_sun_star_view_XControlAccess_idl__
  35 #include <com/sun/star/view/XControlAccess.idl>
  36 #endif
  37 #ifndef __com_sun_star_form_XForm_idl__
  38 #include <com/sun/star/form/XForm.idl>
  39 #endif
  40 #ifndef __com_sun_star_form_XFormController_idl__
  41 #include <com/sun/star/form/XFormController.idl>
  42 #endif
  43 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  44 #include <com/sun/star/lang/IllegalArgumentException.idl>
  45 #endif
  46
  47 //=============================================================================
  48
  49 module com { module sun { module star { module view {
  50
  51 //=============================================================================
  52
  53 /** provides access to the form layer elements in a view
  54
  55     @since OOo 2.3
  56  */
  57 interface XFormLayerAccess
  58 {
  59     /// provides access to form controls contained in the view
  60     interface XControlAccess;
  61
  62     /** returns the <type scope="com::sun::star::form">FormController</type>
  63         instance which operates on a given form.
  64
  65         <p>A form controller is a component which controls the user interaction
  66         with the form layer, as long as the form is not in design mode.</p>
  67
  68         @return
  69             the requested form controller, or <NULL/> if the view's
  70             form layer is currently in design mode. Note that the returned
  71             instance becomes non-functional as soon as the form layer is switched
  72             to design mode.
  73
  74         @see isDesignMode
  75         @see setDesignMode
  76         @see ::com::sun::star::form::FormController
  77         @see ::com::sun::star::form::runtime::FormOperations
  78     */
  79     ::com::sun::star::form::XFormController
  80         getFormController(
  81             [in] ::com::sun::star::form::XForm Form
  82         );
  83
  84     /** determines whether the view's form layer is currently in design
  85         or alive mode
  86
  87         <p><em>Note</em>: This is a convenience method. In the user interface,
  88         the design mode is coupled with the <code>.uno:SwitchControlDesignMode</code>
  89         feature (see <type scope="com::sun::star::frame">XDispatchProvider</type>),
  90         and asking for the current mode is the same as asking for the state of this
  91         feature.</p>
  92     */
  93     boolean isFormDesignMode();
  94
  95     /** determines whether the view's form layer is currently in design
  96         or alive mode
  97
  98         <p><em>Note</em>: This is a convenience method. In the user interface,
  99         the design mode is coupled with the <code>.uno:SwitchControlDesignMode</code>
 100         feature (see <type scope="com::sun::star::frame">XDispatchProvider</type>),
 101         and changing the current mode is the same as dispatching this feature URL.</p>
 102     */
 103     void    setFormDesignMode( [in] boolean DesignMode );
 104 };
 105
 106 //=============================================================================
 107
 108 }; }; }; };
 109
 110 //=============================================================================
 111
 112 #endif