1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski#ifndef __offapi_com_sun_star_view_XFormLayerAccess_idl__ 25*b1cdbd2cSJim Jagielski#define __offapi_com_sun_star_view_XFormLayerAccess_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_view_XControlAccess_idl__ 28*b1cdbd2cSJim Jagielski#include <com/sun/star/view/XControlAccess.idl> 29*b1cdbd2cSJim Jagielski#endif 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_form_XForm_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/form/XForm.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_form_runtime_XFormController_idl__ 34*b1cdbd2cSJim Jagielski#include <com/sun/star/form/runtime/XFormController.idl> 35*b1cdbd2cSJim Jagielski#endif 36*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 37*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/IllegalArgumentException.idl> 38*b1cdbd2cSJim Jagielski#endif 39*b1cdbd2cSJim Jagielski 40*b1cdbd2cSJim Jagielski//============================================================================= 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module view { 43*b1cdbd2cSJim Jagielski 44*b1cdbd2cSJim Jagielski//============================================================================= 45*b1cdbd2cSJim Jagielski 46*b1cdbd2cSJim Jagielski/** provides access to the form layer elements in a view 47*b1cdbd2cSJim Jagielski 48*b1cdbd2cSJim Jagielski @since OpenOffice 2.3 49*b1cdbd2cSJim Jagielski */ 50*b1cdbd2cSJim Jagielskiinterface XFormLayerAccess 51*b1cdbd2cSJim Jagielski{ 52*b1cdbd2cSJim Jagielski /// provides access to form controls contained in the view 53*b1cdbd2cSJim Jagielski interface XControlAccess; 54*b1cdbd2cSJim Jagielski 55*b1cdbd2cSJim Jagielski /** returns the <type scope="com::sun::star::form">FormController</type> 56*b1cdbd2cSJim Jagielski instance which operates on a given form. 57*b1cdbd2cSJim Jagielski 58*b1cdbd2cSJim Jagielski <p>A form controller is a component which controls the user interaction 59*b1cdbd2cSJim Jagielski with the form layer, as long as the form is not in design mode.</p> 60*b1cdbd2cSJim Jagielski 61*b1cdbd2cSJim Jagielski @return 62*b1cdbd2cSJim Jagielski the requested form controller, or <NULL/> if the view's 63*b1cdbd2cSJim Jagielski form layer is currently in design mode. Note that the returned 64*b1cdbd2cSJim Jagielski instance becomes non-functional as soon as the form layer is switched 65*b1cdbd2cSJim Jagielski to design mode. 66*b1cdbd2cSJim Jagielski 67*b1cdbd2cSJim Jagielski @see isDesignMode 68*b1cdbd2cSJim Jagielski @see setDesignMode 69*b1cdbd2cSJim Jagielski @see ::com::sun::star::form::runtime::FormController 70*b1cdbd2cSJim Jagielski @see ::com::sun::star::form::runtime::FormOperations 71*b1cdbd2cSJim Jagielski */ 72*b1cdbd2cSJim Jagielski ::com::sun::star::form::runtime::XFormController 73*b1cdbd2cSJim Jagielski getFormController( 74*b1cdbd2cSJim Jagielski [in] ::com::sun::star::form::XForm Form 75*b1cdbd2cSJim Jagielski ); 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski /** determines whether the view's form layer is currently in design 78*b1cdbd2cSJim Jagielski or alive mode 79*b1cdbd2cSJim Jagielski 80*b1cdbd2cSJim Jagielski <p><em>Note</em>: This is a convenience method. In the user interface, 81*b1cdbd2cSJim Jagielski the design mode is coupled with the <code>.uno:SwitchControlDesignMode</code> 82*b1cdbd2cSJim Jagielski feature (see <type scope="com::sun::star::frame">XDispatchProvider</type>), 83*b1cdbd2cSJim Jagielski and asking for the current mode is the same as asking for the state of this 84*b1cdbd2cSJim Jagielski feature.</p> 85*b1cdbd2cSJim Jagielski */ 86*b1cdbd2cSJim Jagielski boolean isFormDesignMode(); 87*b1cdbd2cSJim Jagielski 88*b1cdbd2cSJim Jagielski /** determines whether the view's form layer is currently in design 89*b1cdbd2cSJim Jagielski or alive mode 90*b1cdbd2cSJim Jagielski 91*b1cdbd2cSJim Jagielski <p><em>Note</em>: This is a convenience method. In the user interface, 92*b1cdbd2cSJim Jagielski the design mode is coupled with the <code>.uno:SwitchControlDesignMode</code> 93*b1cdbd2cSJim Jagielski feature (see <type scope="com::sun::star::frame">XDispatchProvider</type>), 94*b1cdbd2cSJim Jagielski and changing the current mode is the same as dispatching this feature URL.</p> 95*b1cdbd2cSJim Jagielski */ 96*b1cdbd2cSJim Jagielski void setFormDesignMode( [in] boolean DesignMode ); 97*b1cdbd2cSJim Jagielski}; 98*b1cdbd2cSJim Jagielski 99*b1cdbd2cSJim Jagielski//============================================================================= 100*b1cdbd2cSJim Jagielski 101*b1cdbd2cSJim Jagielski}; }; }; }; 102*b1cdbd2cSJim Jagielski 103*b1cdbd2cSJim Jagielski//============================================================================= 104*b1cdbd2cSJim Jagielski 105*b1cdbd2cSJim Jagielski#endif 106