xref: /aoo42x/main/offapi/com/sun/star/awt/ActionEvent.idl (revision cdf0e10c)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_awt_ActionEvent_idl__
28#define __com_sun_star_awt_ActionEvent_idl__
29
30#ifndef __com_sun_star_lang_EventObject_idl__
31#include <com/sun/star/lang/EventObject.idl>
32#endif
33
34
35//=============================================================================
36
37 module com {  module sun {  module star {  module awt {
38
39//=============================================================================
40
41/** a semantic event which indicates that a component-defined action occurred.
42
43	<p>This high-level event is generated by a component (such as a Button)
44	when the component-specific action occurs (such as being pressed).
45	The event is passed to every <type>XActionListener</type> object
46	that registered to receive such events using the component's
47	<code>addActionListener</code> method.</p>
48
49	<p>The object that implements the <type>XActionListener</type> interface
50	gets this ActionEvent when the event occurs. The listener is therefore
51	spared the details of processing individual mouse movements and mouse
52	clicks, and can instead process a "meaningful" (semantic) event like
53	"button pressed".</p>
54 */
55published struct ActionEvent: com::sun::star::lang::EventObject
56{
57	//-------------------------------------------------------------------------
58
59	/** contains the command string associated with this action.
60	 */
61	string ActionCommand;
62
63};
64
65//=============================================================================
66
67}; }; }; };
68
69#endif
70