offapi/com/sun/star/awt/ActionEvent.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_awt_ActionEvent_idl__
  20 #define __com_sun_star_awt_ActionEvent_idl__
  21
  22 #include <com/sun/star/lang/EventObject.idl>
  23
  24
  25
  26  module com {  module sun {  module star {  module awt {
  27
  28
  29 /** a semantic event which indicates that a component-defined action occurred.
  30
  31     <p>This high-level event is generated by a component (such as a Button)
  32     when the component-specific action occurs (such as being pressed).
  33     The event is passed to every XActionListener object
  34     that registered to receive such events using the component's
  35     <code>addActionListener</code> method.</p>
  36
  37     <p>The object that implements the XActionListener interface
  38     gets this ActionEvent when the event occurs. The listener is therefore
  39     spared the details of processing individual mouse movements and mouse
  40     clicks, and can instead process a "meaningful" (semantic) event like
  41     "button pressed".</p>
  42  */
  43 published struct ActionEvent: com::sun::star::lang::EventObject
  44 {
  45
  46     /** contains the command string associated with this action.
  47      */
  48     string ActionCommand;
  49
  50 };
  51
  52
  53 }; }; }; };
  54
  55 #endif
  56
  57 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */