offapi/com/sun/star/ui/ActionTrigger.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: ActionTrigger.idl,v $
  10  * $Revision: 1.5 $
  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_ui_ActionTrigger_idl__
  31 #define __com_sun_star_ui_ActionTrigger_idl__
  32
  33 #ifndef __com_sun_star_awt_XBitmap_idl__
  34 #include <com/sun/star/awt/XBitmap.idl>
  35 #endif
  36 #ifndef __com_sun_star_container_XIndexContainer_idl__
  37 #include <com/sun/star/container/XIndexContainer.idl>
  38 #endif
  39 #ifndef __com_sun_star_lang_XMultiServiceFactory_idl__
  40 #include <com/sun/star/lang/XMultiServiceFactory.idl>
  41 #endif
  42
  43 module com {  module sun {  module star {  module ui {
  44
  45 /** describes a trigger for an (user inter-)action.
  46     <p>Common examples for such triggers are menu entries or toolbar icons.</p>
  47 */
  48 published service ActionTrigger
  49 {
  50     /** contains the text of the menu entry.
  51      */
  52     [property] string Text;
  53
  54     /** contains the command URL for the menu entry.
  55      */
  56     [property] string CommandURL;
  57
  58     /** contains the a URL that points to a help text.
  59      */
  60     [optional, property] string HelpURL;
  61
  62     /** contains the menu item image.
  63     */
  64     [property] ::com::sun::star::awt::XBitmap Image;
  65
  66     /** contains a sub menu.
  67     */
  68     [property] ::com::sun::star::container::XIndexContainer SubContainer;
  69 };
  70 }; }; }; };
  71 #endif