offapi/com/sun/star/view/XFormLayerAccess.idl

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