offapi/com/sun/star/frame/ControlEvent.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: ControlEvent.idl,v $
  10  * $Revision: 1.3 $
  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_frame_ControlEvent_idl__
  31 #define __com_sun_star_frame_ControlEvent_idl__
  32
  33 #ifndef __com_sun_star_util_URL_idl__
  34 #include <com/sun/star/util/URL.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_beans_NamedValue_idl__
  38 #include <com/sun/star/beans/NamedValue.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43 module com {  module sun {  module star {  module frame {
  44
  45 //=============================================================================
  46
  47 /** describes a control event send by extended user interface
  48     controls.
  49
  50     @since OOo 2.0.3
  51  */
  52 struct ControlEvent
  53 {
  54     //-------------------------------------------------------------------------
  55     /** fully parsed URL describing the control that sends this
  56         notification.
  57     */
  58     ::com::sun::star::util::URL aURL;
  59
  60     /** specifies the event which has occured.
  61      */
  62     string Event;
  63
  64     //-------------------------------------------------------------------------
  65
  66     /** specifies a sequence of named values which are used as
  67         additional values for the event. The number and types of
  68         named values depent on the event.
  69      */
  70     sequence< com::sun::star::beans::NamedValue > aInformation;
  71 };
  72
  73 //=============================================================================
  74
  75 }; }; }; };
  76
  77 #endif