offapi/com/sun/star/view/XFormLayerAccess.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 module com { module sun { module star { module view {
  22
  23
  24 /** provides access to the form layer elements in a view
  25
  26     @since OOo 2.3
  27  */
  28 interface XFormLayerAccess
  29 {
  30     /// provides access to form controls contained in the view
  31     interface XControlAccess;
  32
  33     /** returns the com::sun::star::form::FormController
  34         instance which operates on a given form.
  35
  36         <p>A form controller is a component which controls the user interaction
  37         with the form layer, as long as the form is not in design mode.</p>
  38
  39         @return
  40             the requested form controller, or `NULL` if the view's
  41             form layer is currently in design mode. Note that the returned
  42             instance becomes non-functional as soon as the form layer is switched
  43             to design mode.
  44
  45         @see isDesignMode
  46         @see setDesignMode
  47         @see ::com::sun::star::form::runtime::FormController
  48         @see ::com::sun::star::form::runtime::FormOperations
  49     */
  50     ::com::sun::star::form::runtime::XFormController
  51         getFormController(
  52             [in] ::com::sun::star::form::XForm Form
  53         );
  54
  55     /** determines whether the view's form layer is currently in design
  56         or alive mode
  57
  58         <p><em>Note</em>: This is a convenience method. In the user interface,
  59         the design mode is coupled with the <code>.uno:SwitchControlDesignMode</code>
  60         feature (see com::sun::star::frame::XDispatchProvider),
  61         and asking for the current mode is the same as asking for the state of this
  62         feature.</p>
  63     */
  64     boolean isFormDesignMode();
  65
  66     /** determines whether the view's form layer is currently in design
  67         or alive mode
  68
  69         <p><em>Note</em>: This is a convenience method. In the user interface,
  70         the design mode is coupled with the <code>.uno:SwitchControlDesignMode</code>
  71         feature (see com::sun::star::frame::XDispatchProvider),
  72         and changing the current mode is the same as dispatching this feature URL.</p>
  73     */
  74     void    setFormDesignMode( [in] boolean DesignMode );
  75 };
  76
  77
  78 }; }; }; };
  79
  80
  81 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */