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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef __offapi_com_sun_star_view_XFormLayerAccess_idl__
  30 #define __offapi_com_sun_star_view_XFormLayerAccess_idl__
  31
  32 #include <com/sun/star/view/XControlAccess.idl>
  33 #include <com/sun/star/form/XForm.idl>
  34 #include <com/sun/star/form/runtime/XFormController.idl>
  35 #include <com/sun/star/lang/IllegalArgumentException.idl>
  36
  37 //=============================================================================
  38
  39 module com { module sun { module star { module view {
  40
  41 //=============================================================================
  42
  43 /** provides access to the form layer elements in a view
  44
  45     @since OOo 2.3
  46  */
  47 interface XFormLayerAccess
  48 {
  49     /// provides access to form controls contained in the view
  50     interface XControlAccess;
  51
  52     /** returns the <type scope="com::sun::star::form">FormController</type>
  53         instance which operates on a given form.
  54
  55         <p>A form controller is a component which controls the user interaction
  56         with the form layer, as long as the form is not in design mode.</p>
  57
  58         @return
  59             the requested form controller, or <NULL/> if the view's
  60             form layer is currently in design mode. Note that the returned
  61             instance becomes non-functional as soon as the form layer is switched
  62             to design mode.
  63
  64         @see isDesignMode
  65         @see setDesignMode
  66         @see ::com::sun::star::form::runtime::FormController
  67         @see ::com::sun::star::form::runtime::FormOperations
  68     */
  69     ::com::sun::star::form::runtime::XFormController
  70         getFormController(
  71             [in] ::com::sun::star::form::XForm Form
  72         );
  73
  74     /** determines whether the view's form layer is currently in design
  75         or alive mode
  76
  77         <p><em>Note</em>: This is a convenience method. In the user interface,
  78         the design mode is coupled with the <code>.uno:SwitchControlDesignMode</code>
  79         feature (see <type scope="com::sun::star::frame">XDispatchProvider</type>),
  80         and asking for the current mode is the same as asking for the state of this
  81         feature.</p>
  82     */
  83     boolean isFormDesignMode();
  84
  85     /** determines whether the view's form layer is currently in design
  86         or alive mode
  87
  88         <p><em>Note</em>: This is a convenience method. In the user interface,
  89         the design mode is coupled with the <code>.uno:SwitchControlDesignMode</code>
  90         feature (see <type scope="com::sun::star::frame">XDispatchProvider</type>),
  91         and changing the current mode is the same as dispatching this feature URL.</p>
  92     */
  93     void    setFormDesignMode( [in] boolean DesignMode );
  94 };
  95
  96 //=============================================================================
  97
  98 }; }; }; };
  99
 100 //=============================================================================
 101
 102 #endif
 103
 104 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */