offapi/com/sun/star/awt/ActionEvent.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: ActionEvent.idl,v $
  10  * $Revision: 1.11 $
  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 #ifndef __com_sun_star_awt_ActionEvent_idl__
  31 #define __com_sun_star_awt_ActionEvent_idl__
  32
  33 #ifndef __com_sun_star_lang_EventObject_idl__
  34 #include <com/sun/star/lang/EventObject.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40  module com {  module sun {  module star {  module awt {
  41
  42 //=============================================================================
  43
  44 /** a semantic event which indicates that a component-defined action occurred.
  45
  46     <p>This high-level event is generated by a component (such as a Button)
  47     when the component-specific action occurs (such as being pressed).
  48     The event is passed to every <type>XActionListener</type> object
  49     that registered to receive such events using the component's
  50     <code>addActionListener</code> method.</p>
  51
  52     <p>The object that implements the <type>XActionListener</type> interface
  53     gets this ActionEvent when the event occurs. The listener is therefore
  54     spared the details of processing individual mouse movements and mouse
  55     clicks, and can instead process a "meaningful" (semantic) event like
  56     "button pressed".</p>
  57  */
  58 published struct ActionEvent: com::sun::star::lang::EventObject
  59 {
  60     //-------------------------------------------------------------------------
  61
  62     /** contains the command string associated with this action.
  63      */
  64     string ActionCommand;
  65
  66 };
  67
  68 //=============================================================================
  69
  70 }; }; }; };
  71
  72 #endif