offapi/com/sun/star/ui/ActionTriggerContainer.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_ActionTriggerContainer_idl__
  20 #define __com_sun_star_ui_ActionTriggerContainer_idl__
  21
  22 #include <com/sun/star/container/XIndexContainer.idl>
  23 #include <com/sun/star/lang/XMultiServiceFactory.idl>
  24 #include <com/sun/star/container/XContainer.idl>
  25 #include <com/sun/star/container/XEnumerationAccess.idl>
  26
  27 module com {  module sun {  module star {  module ui {
  28
  29
  30 /** describes a container of user actions.
  31
  32     <p>No assumption is made about any graphical representation:
  33     You could have a menu or a toolbox working with the same container
  34     describing their entries.</p>
  35
  36     <p>Possible elements of the <type>ActionTriggerContainer</type> are
  37         <ul>
  38             <li><type>ActionTrigger</type> -
  39                         represents a simply clickable menu entry</li>
  40             <li><type>ActionTriggerSeparator</type> -
  41                         represents a separator between two entries<br/>
  42                  This entry type is of interest for components rendering a an
  43                  <type>ActionTriggerContainer</type>
  44              </li>
  45             <li><type>ActionTriggerContainer</type> -
  46                 represents a sub container</li>
  47         </ul>
  48     </p>
  49 */
  50 published service ActionTriggerContainer
  51 {
  52     /** provides access to the entries of a menu. The element type
  53      is <type scope="com::sun::star::beans">XPropertySet</type>.
  54      The property set contains attributes like CommandURL, HelpURL
  55      as defined in the service <type scope="com::sun::star::ui">ActionTrigger</type>
  56      and optional a <type scope="com::sun::star::ui">ActionTriggerContainer</type>.
  57      */
  58
  59     interface ::com::sun::star::container::XIndexContainer;
  60
  61     /** creates elements to be inserted into the container.
  62         <p>Usually, the <method>XMultiServiceFactory::getSupportedServiceNames</method>
  63         gives you a <type>ActionTrigger</type> and
  64         optionally <type>ActionTriggerContainer</type> and
  65         <type>ActionTriggerSeparator</type>
  66
  67      .</p>
  68      */
  69     interface ::com::sun::star::lang::XMultiServiceFactory;
  70
  71     /** allows to enumerate the elements of the container
  72     */
  73     [optional] interface ::com::sun::star::container::XEnumerationAccess;
  74
  75     /** allows foreign components to register themselves as listener for the container
  76         structure.
  77     */
  78     [optional] interface ::com::sun::star::container::XContainer;
  79 };
  80 }; }; }; };
  81 #endif
  82
  83 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */