offapi/com/sun/star/form/runtime/FormOperations.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 form { module runtime {
  22
  23
  24 /** encapsulates operations on a database form which has a UI representation,
  25     and is interacting with the user.
  26
  27     @since OOo 2.2
  28  */
  29 service FormOperations : XFormOperations
  30 {
  31     /** creates a <code>FormOperations</code> instance which works on a com::sun::star::form::FormController
  32         instance.
  33         @throws IllegalArgumentException
  34             if the given form controller is `NULL`, or does not have a model denoting a valid
  35             com::sun::star::form::component::DataForm instance.
  36     */
  37     createWithFormController(
  38         [in] XFormController Controller
  39     )
  40     raises(
  41         ::com::sun::star::lang::IllegalArgumentException
  42     );
  43
  44     /** creates a <code>FormOperations</code> instance which works on a com::sun::star::form::component::DataForm
  45         instance.
  46
  47         @throws IllegalArgumentException
  48             if the given form is `NULL`, or does not support the com::sun::star::form::component::DataForm
  49             service.
  50     */
  51     createWithForm(
  52         [in] XForm Form
  53     )
  54     raises(
  55         ::com::sun::star::lang::IllegalArgumentException
  56     );
  57 };
  58
  59
  60 }; }; }; }; };
  61
  62
  63 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */