offapi/com/sun/star/form/control/CommandButton.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 control {
  22
  23
  24 /** describes a button control.
  25
  26     <p>The model of the control has to support the com::sun::star::form::component::CommandButton
  27     service.</p>
  28
  29     <p>The control is clickable, the action taken upon clicking depends on the settings
  30     of the model the control belongs to.</p>
  31
  32     @see com::sun::star::awt::UnoControl
  33     @see com::sun::star::awt::UnoControlModel
  34     @see com::sun::star::form::component::CommandButton::ButtonType
  35 */
  36 published service CommandButton
  37 {
  38     service com::sun::star::awt::UnoControlButton;
  39
  40     /** allows external instances to register as veto listener for the button's actions.
  41
  42         <p>A com::sun::star::form::XApproveActionListener returning false on
  43         it's approve-method will prevent any action which would usually be triggered - this includes
  44         not only submitting or resetting forms, but also calling the
  45         com::sun::star::awt::XActionListeners of the super service<br/>
  46         This may be interesting for e.g. forms which want to provide input validation before submitting
  47         data.<br/>
  48
  49         @see com::sun::star::form::component::HTMLForm
  50         @see com::sun::star::form::XSubmit
  51         @see com::sun::star::form::XReset
  52         @see com::sun::star::awt::XButton
  53     */
  54     interface com::sun::star::form::XApproveActionBroadcaster;
  55 };
  56
  57
  58 }; }; }; }; };
  59
  60
  61 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */