offapi/com/sun/star/frame/ControlEvent.idl

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