1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
3 * This file is part of the LibreOffice project.
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/.
9 * This file incorporates work covered by the following license notice:
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 .
20 module com
{ module sun
{ module star
{ module ui
{
23 /** describes a container of user actions.
25 <p>No assumption is made about any graphical representation:
26 You could have a menu or a toolbox working with the same container
27 describing their entries.</p>
29 <p>Possible elements of the ActionTriggerContainer are
32 represents a simply clickable menu entry</li>
33 <li>ActionTriggerSeparator -
34 represents a separator between two entries<br/>
35 This entry type is of interest for components rendering a an
36 ActionTriggerContainer
38 <li>ActionTriggerContainer -
39 represents a sub container</li>
43 published service ActionTriggerContainer
45 /** provides access to the entries of a menu. The element type
46 is com::sun::star::beans::XPropertySet.
47 The property set contains attributes like CommandURL, HelpURL
48 as defined in the service com::sun::star::ui::ActionTrigger
49 and optional a com::sun::star::ui::ActionTriggerContainer.
52 interface ::com
::sun
::star
::container
::XIndexContainer
;
54 /** creates elements to be inserted into the container.
55 <p>Usually, the XMultiServiceFactory::getSupportedServiceNames()
56 gives you an ActionTrigger and
57 optionally ActionTriggerContainer and
58 ActionTriggerSeparator
62 interface ::com
::sun
::star
::lang
::XMultiServiceFactory
;
64 /** allows to enumerate the elements of the container
66 [optional] interface ::com
::sun
::star
::container
::XEnumerationAccess
;
68 /** allows foreign components to register themselves as listener for the container
71 [optional] interface ::com
::sun
::star
::container
::XContainer
;
75 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */