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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /**
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_ui_ActionTrigger_idl__
  20 #define __com_sun_star_ui_ActionTrigger_idl__
  21
  22 #include <com/sun/star/awt/XBitmap.idl>
  23 #include <com/sun/star/container/XIndexContainer.idl>
  24 #include <com/sun/star/lang/XMultiServiceFactory.idl>
  25
  26 module com {  module sun {  module star {  module ui {
  27
  28 /** describes a trigger for an (user inter-)action.
  29     <p>Common examples for such triggers are menu entries or toolbar icons.</p>
  30 */
  31 published service ActionTrigger
  32 {
  33     /** contains the text of the menu entry.
  34      */
  35     [property] string Text;
  36
  37     /** contains the command URL for the menu entry.
  38      */
  39     [property] string CommandURL;
  40
  41     /** contains the a URL that points to a help text.
  42      */
  43     [optional, property] string HelpURL;
  44
  45     /** contains the menu item image.
  46     */
  47     [property] ::com::sun::star::awt::XBitmap Image;
  48
  49     /** contains a sub menu.
  50     */
  51     [property] ::com::sun::star::container::XIndexContainer SubContainer;
  52 };
  53 }; }; }; };
  54 #endif
  55
  56 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */