summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/form/control/CommandButton.idl
diff options
context:
space:
mode:
authorMichael Hönnig <mi@openoffice.org>2002-10-03 12:11:20 +0000
committerMichael Hönnig <mi@openoffice.org>2002-10-03 12:11:20 +0000
commitcb23f6a62077022736a40d6315ee92a218f489e0 (patch)
tree713895d0de4930fd1a37b2fb7bb6ded971a2acdf /offapi/com/sun/star/form/control/CommandButton.idl
parent625aff4ec7a47d618a9da160e962fc6fb5c834c5 (diff)
#94968# IDL reviews merged
Diffstat (limited to 'offapi/com/sun/star/form/control/CommandButton.idl')
-rw-r--r--offapi/com/sun/star/form/control/CommandButton.idl46
1 files changed, 40 insertions, 6 deletions
diff --git a/offapi/com/sun/star/form/control/CommandButton.idl b/offapi/com/sun/star/form/control/CommandButton.idl
index 5378854b83fc..3ffb59286010 100644
--- a/offapi/com/sun/star/form/control/CommandButton.idl
+++ b/offapi/com/sun/star/form/control/CommandButton.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: CommandButton.idl,v $
*
- * $Revision: 1.2 $
+ * $Revision: 1.3 $
*
- * last change: $Author: fs $ $Date: 2001-04-19 10:56:41 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:05:07 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -76,19 +76,35 @@
//=============================================================================
-/** describes a radio button usually used together with a
- <type scope="com.sun.star.form.component">CommandButton</type> model.
+/** describes a button control.
+
+ <p>The model of the control has to support the <type scope="com::sun::star::form::component">CommandButton</type>
+ service.</p>
<p>The control is clickable, the action taken upon clicking depends on the settings
of the model the control belongs to.</p>
+
+ @see com::sun::star::awt::UnoControl
+ @see com::sun::star::awt::UnoControlModel
+ @see com::sun::star::form::component::CommandButton::ButtonType
*/
service CommandButton
{
- /** provides the basic functionallity of the control
- */
service com::sun::star::awt::UnoControlButton;
/** allows external instances to register as veto listener for the button's actions.
+
+ <p>An <type scope="com::sun::star::form">XApproveActionListener</type> returning false on
+ it's approve-method will prevent any action which would usually be triggered - this includes
+ not only submitting or resetting forms, but also calling the
+ <type scope="com::sun::star::awt">XActionListener</type>s of the super service<br/>
+ This may be interesting for e.g. forms which want to provide input validation before submitting
+ data.<br/>
+
+ @see com::sun::star::form::HTMLForm
+ @see com::sun::star::form::XSubmit
+ @see com::sun::star::form::XReset
+ @see com::sun::star::awt::XButton
*/
interface com::sun::star::form::XApproveActionBroadcaster;
};
@@ -100,6 +116,15 @@ service CommandButton
/*=============================================================================
$Log: not supported by cvs2svn $
+ Revision 1.2.14.2 2002/07/26 11:03:13 fs
+ IDL review form layer
+
+ Revision 1.2.14.1 2002/02/19 08:11:57 oj
+ #96946# parameter,return value and exception description
+
+ Revision 1.2 2001/04/19 10:56:41 fs
+ corrected the include protection
+
Revision 1.1 2001/04/19 08:44:50 fs
initial checkin - service description for form related controls
@@ -111,6 +136,15 @@ service CommandButton
/*************************************************************************
* history:
* $Log: not supported by cvs2svn $
+ * Revision 1.2.14.2 2002/07/26 11:03:13 fs
+ * IDL review form layer
+ *
+ * Revision 1.2.14.1 2002/02/19 08:11:57 oj
+ * #96946# parameter,return value and exception description
+ *
+ * Revision 1.2 2001/04/19 10:56:41 fs
+ * corrected the include protection
+ *
* Revision 1.1 2001/04/19 08:44:50 fs
* initial checkin - service description for form related controls
*