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