offapi/com/sun/star/ui/ActionTrigger.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_ui_ActionTrigger_idl__
  29 #define __com_sun_star_ui_ActionTrigger_idl__
  30
  31 #include <com/sun/star/awt/XBitmap.idl>
  32 #include <com/sun/star/container/XIndexContainer.idl>
  33 #include <com/sun/star/lang/XMultiServiceFactory.idl>
  34
  35 module com {  module sun {  module star {  module ui {
  36
  37 /** describes a trigger for an (user inter-)action.
  38     <p>Common examples for such triggers are menu entries or toolbar icons.</p>
  39 */
  40 published service ActionTrigger
  41 {
  42     /** contains the text of the menu entry.
  43      */
  44     [property] string Text;
  45
  46     /** contains the command URL for the menu entry.
  47      */
  48     [property] string CommandURL;
  49
  50     /** contains the a URL that points to a help text.
  51      */
  52     [optional, property] string HelpURL;
  53
  54     /** contains the menu item image.
  55     */
  56     [property] ::com::sun::star::awt::XBitmap Image;
  57
  58     /** contains a sub menu.
  59     */
  60     [property] ::com::sun::star::container::XIndexContainer SubContainer;
  61 };
  62 }; }; }; };
  63 #endif
  64
  65 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */