offapi/com/sun/star/form/control/CommandButton.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: CommandButton.idl,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_form_control_CommandButton_idl__
  32 #define __com_sun_star_form_control_CommandButton_idl__
  33
  34 #ifndef __com_sun_star_awt_UnoControlButton_idl__
  35 #include <com/sun/star/awt/UnoControlButton.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_form_XApproveActionBroadcaster_idl__
  39 #include <com/sun/star/form/XApproveActionBroadcaster.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module form {  module control {
  45
  46 //=============================================================================
  47
  48 /** describes a button control.
  49
  50     <p>The model of the control has to support the <type scope="com::sun::star::form::component">CommandButton</type>
  51     service.</p>
  52
  53     <p>The control is clickable, the action taken upon clicking depends on the settings
  54     of the model the control belongs to.</p>
  55
  56     @see com::sun::star::awt::UnoControl
  57     @see com::sun::star::awt::UnoControlModel
  58     @see com::sun::star::form::component::CommandButton::ButtonType
  59 */
  60 published service CommandButton
  61 {
  62     service com::sun::star::awt::UnoControlButton;
  63
  64     /** allows external instances to register as veto listener for the button's actions.
  65
  66         <p>An <type scope="com::sun::star::form">XApproveActionListener</type> returning false on
  67         it's approve-method will prevent any action which would usually be triggered - this includes
  68         not only submitting or resetting forms, but also calling the
  69         <type scope="com::sun::star::awt">XActionListener</type>s of the super service<br/>
  70         This may be interesting for e.g. forms which want to provide input validation before submitting
  71         data.<br/>
  72
  73         @see com::sun::star::form::component::HTMLForm
  74         @see com::sun::star::form::XSubmit
  75         @see com::sun::star::form::XReset
  76         @see com::sun::star::awt::XButton
  77     */
  78     interface com::sun::star::form::XApproveActionBroadcaster;
  79 };
  80
  81 //=============================================================================
  82
  83 }; }; }; }; };
  84
  85 /*=============================================================================
  86
  87 =============================================================================*/
  88
  89 #endif
  90
  91