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