summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/ui/ActionTrigger.idl
blob: 0c1262b9d81b0a0647c4ca65d4545d0b2a9f3f95 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_ui_ActionTrigger_idl__
#define __com_sun_star_ui_ActionTrigger_idl__

#ifndef __com_sun_star_awt_XBitmap_idl__
#include <com/sun/star/awt/XBitmap.idl>
#endif
#ifndef __com_sun_star_container_XIndexContainer_idl__
#include <com/sun/star/container/XIndexContainer.idl>
#endif
#ifndef __com_sun_star_lang_XMultiServiceFactory_idl__
#include <com/sun/star/lang/XMultiServiceFactory.idl>
#endif

module com {  module sun {  module star {  module ui {

/** describes a trigger for an (user inter-)action.
    <p>Common examples for such triggers are menu entries or toolbar icons.</p>
*/
published service ActionTrigger
{
    /** contains the text of the menu entry.
     */
    [property] string Text;

    /** contains the command URL for the menu entry.
     */
    [property] string CommandURL;

    /** contains the a URL that points to a help text.
     */
    [optional, property] string HelpURL;

    /** contains the menu item image.
    */
    [property] ::com::sun::star::awt::XBitmap Image;

    /** contains a sub menu.
    */
    [property] ::com::sun::star::container::XIndexContainer SubContainer;
};
}; }; }; };
#endif