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