1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_ui_ActionTriggerContainer_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_ui_ActionTriggerContainer_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_container_XIndexContainer_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/container/XIndexContainer.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_XMultiServiceFactory_idl__ 30*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/XMultiServiceFactory.idl> 31*b1cdbd2cSJim Jagielski#endif 32*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_container_XContainer_idl__ 33*b1cdbd2cSJim Jagielski#include <com/sun/star/container/XContainer.idl> 34*b1cdbd2cSJim Jagielski#endif 35*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_container_XEnumerationAccess_idl__ 36*b1cdbd2cSJim Jagielski#include <com/sun/star/container/XEnumerationAccess.idl> 37*b1cdbd2cSJim Jagielski#endif 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module ui { 40*b1cdbd2cSJim Jagielski 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski/** describes a container of user actions. 43*b1cdbd2cSJim Jagielski 44*b1cdbd2cSJim Jagielski <p>No assumption is made about any graphical representation: 45*b1cdbd2cSJim Jagielski You could have a menu or a toolbox working with the same container 46*b1cdbd2cSJim Jagielski describing their entries.</p> 47*b1cdbd2cSJim Jagielski 48*b1cdbd2cSJim Jagielski <p>Possible elements of the <type>ActionTriggerContainer</type> are 49*b1cdbd2cSJim Jagielski <ul> 50*b1cdbd2cSJim Jagielski <li><type>ActionTrigger</type> - 51*b1cdbd2cSJim Jagielski represents a simply clickable menu entry</li> 52*b1cdbd2cSJim Jagielski <li><type>ActionTriggerSeparator</type> - 53*b1cdbd2cSJim Jagielski represents a separator between two entries<br/> 54*b1cdbd2cSJim Jagielski This entry type is of interest for components rendering a an 55*b1cdbd2cSJim Jagielski <type>ActionTriggerContainer</type> 56*b1cdbd2cSJim Jagielski </li> 57*b1cdbd2cSJim Jagielski <li><type>ActionTriggerContainer</type> - 58*b1cdbd2cSJim Jagielski represents a sub container</li> 59*b1cdbd2cSJim Jagielski </ul> 60*b1cdbd2cSJim Jagielski </p> 61*b1cdbd2cSJim Jagielski*/ 62*b1cdbd2cSJim Jagielskipublished service ActionTriggerContainer 63*b1cdbd2cSJim Jagielski{ 64*b1cdbd2cSJim Jagielski /** provides access to the entries of a menu. The element type 65*b1cdbd2cSJim Jagielski is <type scope="com::sun::star::beans">XPropertySet</type>. 66*b1cdbd2cSJim Jagielski The property set contains attributes like CommandURL, HelpURL 67*b1cdbd2cSJim Jagielski as defined in the service <type scope="com::sun::star::ui">ActionTrigger</type> 68*b1cdbd2cSJim Jagielski and optional a <type scope="com::sun::star::ui">ActionTriggerContainer</type>. 69*b1cdbd2cSJim Jagielski */ 70*b1cdbd2cSJim Jagielski 71*b1cdbd2cSJim Jagielski interface ::com::sun::star::container::XIndexContainer; 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski /** creates elements to be inserted into the container. 74*b1cdbd2cSJim Jagielski <p>Usually, the <method>XMultiServiceFactory::getSupportedServiceNames</method> 75*b1cdbd2cSJim Jagielski gives you a <type>ActionTrigger</type> and 76*b1cdbd2cSJim Jagielski optionally <type>ActionTriggerContainer</type> and 77*b1cdbd2cSJim Jagielski <type>ActionTriggerSeparator</type> 78*b1cdbd2cSJim Jagielski 79*b1cdbd2cSJim Jagielski .</p> 80*b1cdbd2cSJim Jagielski */ 81*b1cdbd2cSJim Jagielski interface ::com::sun::star::lang::XMultiServiceFactory; 82*b1cdbd2cSJim Jagielski 83*b1cdbd2cSJim Jagielski /** allows to enumerate the elements of the container 84*b1cdbd2cSJim Jagielski */ 85*b1cdbd2cSJim Jagielski [optional] interface ::com::sun::star::container::XEnumerationAccess; 86*b1cdbd2cSJim Jagielski 87*b1cdbd2cSJim Jagielski /** allows foreign components to register themself as listener for the container 88*b1cdbd2cSJim Jagielski structure. 89*b1cdbd2cSJim Jagielski */ 90*b1cdbd2cSJim Jagielski [optional] interface ::com::sun::star::container::XContainer; 91*b1cdbd2cSJim Jagielski}; 92*b1cdbd2cSJim Jagielski}; }; }; }; 93*b1cdbd2cSJim Jagielski#endif 94