1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir#ifndef __com_sun_star_form_control_CommandButton_idl__ 25cdf0e10cSrcweir#define __com_sun_star_form_control_CommandButton_idl__ 26cdf0e10cSrcweir 27cdf0e10cSrcweir#ifndef __com_sun_star_awt_UnoControlButton_idl__ 28cdf0e10cSrcweir#include <com/sun/star/awt/UnoControlButton.idl> 29cdf0e10cSrcweir#endif 30cdf0e10cSrcweir 31cdf0e10cSrcweir#ifndef __com_sun_star_form_XApproveActionBroadcaster_idl__ 32cdf0e10cSrcweir#include <com/sun/star/form/XApproveActionBroadcaster.idl> 33cdf0e10cSrcweir#endif 34cdf0e10cSrcweir 35cdf0e10cSrcweir//============================================================================= 36cdf0e10cSrcweir 37cdf0e10cSrcweir module com { module sun { module star { module form { module control { 38cdf0e10cSrcweir 39cdf0e10cSrcweir//============================================================================= 40cdf0e10cSrcweir 41cdf0e10cSrcweir/** describes a button control. 42cdf0e10cSrcweir 43cdf0e10cSrcweir <p>The model of the control has to support the <type scope="com::sun::star::form::component">CommandButton</type> 44cdf0e10cSrcweir service.</p> 45cdf0e10cSrcweir 46cdf0e10cSrcweir <p>The control is clickable, the action taken upon clicking depends on the settings 47cdf0e10cSrcweir of the model the control belongs to.</p> 48cdf0e10cSrcweir 49cdf0e10cSrcweir @see com::sun::star::awt::UnoControl 50cdf0e10cSrcweir @see com::sun::star::awt::UnoControlModel 51cdf0e10cSrcweir @see com::sun::star::form::component::CommandButton::ButtonType 52cdf0e10cSrcweir*/ 53cdf0e10cSrcweirpublished service CommandButton 54cdf0e10cSrcweir{ 55cdf0e10cSrcweir service com::sun::star::awt::UnoControlButton; 56cdf0e10cSrcweir 57cdf0e10cSrcweir /** allows external instances to register as veto listener for the button's actions. 58cdf0e10cSrcweir 59cdf0e10cSrcweir <p>An <type scope="com::sun::star::form">XApproveActionListener</type> returning false on 60cdf0e10cSrcweir it's approve-method will prevent any action which would usually be triggered - this includes 61cdf0e10cSrcweir not only submitting or resetting forms, but also calling the 62cdf0e10cSrcweir <type scope="com::sun::star::awt">XActionListener</type>s of the super service<br/> 63cdf0e10cSrcweir This may be interesting for e.g. forms which want to provide input validation before submitting 64cdf0e10cSrcweir data.<br/> 65cdf0e10cSrcweir 66cdf0e10cSrcweir @see com::sun::star::form::component::HTMLForm 67cdf0e10cSrcweir @see com::sun::star::form::XSubmit 68cdf0e10cSrcweir @see com::sun::star::form::XReset 69cdf0e10cSrcweir @see com::sun::star::awt::XButton 70cdf0e10cSrcweir */ 71cdf0e10cSrcweir interface com::sun::star::form::XApproveActionBroadcaster; 72cdf0e10cSrcweir}; 73cdf0e10cSrcweir 74cdf0e10cSrcweir//============================================================================= 75cdf0e10cSrcweir 76cdf0e10cSrcweir}; }; }; }; }; 77cdf0e10cSrcweir 78cdf0e10cSrcweir/*============================================================================= 79cdf0e10cSrcweir 80cdf0e10cSrcweir=============================================================================*/ 81cdf0e10cSrcweir 82cdf0e10cSrcweir#endif 83cdf0e10cSrcweir 84cdf0e10cSrcweir 85