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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ActionTriggerContainer.idl,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_ui_ActionTriggerContainer_idl__
  31 #define __com_sun_star_ui_ActionTriggerContainer_idl__
  32
  33 #ifndef __com_sun_star_container_XIndexContainer_idl__
  34 #include <com/sun/star/container/XIndexContainer.idl>
  35 #endif
  36 #ifndef __com_sun_star_lang_XMultiServiceFactory_idl__
  37 #include <com/sun/star/lang/XMultiServiceFactory.idl>
  38 #endif
  39 #ifndef __com_sun_star_container_XContainer_idl__
  40 #include <com/sun/star/container/XContainer.idl>
  41 #endif
  42 #ifndef __com_sun_star_container_XEnumerationAccess_idl__
  43 #include <com/sun/star/container/XEnumerationAccess.idl>
  44 #endif
  45
  46 module com {  module sun {  module star {  module ui {
  47
  48
  49 /** describes a container of user actions.
  50
  51     <p>No assumption is made about any graphical representation:
  52     You could have a menu or a toolbox working with the same container
  53     describing their entries.</p>
  54
  55     <p>Possible elements of the <type>ActionTriggerContainer</type> are
  56         <ul>
  57             <li><type>ActionTrigger</type> -
  58                         represents a simply clickable menu entry</li>
  59             <li><type>ActionTriggerSeparator</type> -
  60                         represents a separator between two entries<br/>
  61                  This entry type is of interest for components rendering a an
  62                  <type>ActionTriggerContainer</type>
  63              </li>
  64             <li><type>ActionTriggerContainer</type> -
  65                 represents a sub container</li>
  66         </ul>
  67     </p>
  68 */
  69 published service ActionTriggerContainer
  70 {
  71     /** provides access to the entries of a menu. The element type
  72      is <type scope="com::sun::star::beans">XPropertySet</type>.
  73      The property set contains attributes like CommandURL, HelpURL
  74      as defined in the service <type scope="com::sun::star::ui">ActionTrigger</type>
  75      and optional a <type scope="com::sun::star::ui">ActionTriggerContainer</type>.
  76      */
  77
  78     interface ::com::sun::star::container::XIndexContainer;
  79
  80     /** creates elements to be inserted into the container.
  81         <p>Usually, the <method>XMultiServiceFactory::getSupportedServiceNames</method>
  82         gives you a <type>ActionTrigger</type> and
  83         optionally <type>ActionTriggerContainer</type> and
  84         <type>ActionTriggerSeparator</type>
  85
  86      .</p>
  87      */
  88     interface ::com::sun::star::lang::XMultiServiceFactory;
  89
  90     /** allows to enumerate the elements of the container
  91     */
  92     [optional] interface ::com::sun::star::container::XEnumerationAccess;
  93
  94     /** allows foreign components to register themself as listener for the container
  95         structure.
  96     */
  97     [optional] interface ::com::sun::star::container::XContainer;
  98 };
  99 }; }; }; };
 100 #endif