office-gobmx/offapi/com/sun/star/ui/ActionTriggerContainer.idl
2012-01-05 09:18:17 +00:00

92 lines
3.6 KiB
Text

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* 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_ActionTriggerContainer_idl__
#define __com_sun_star_ui_ActionTriggerContainer_idl__
#include <com/sun/star/container/XIndexContainer.idl>
#include <com/sun/star/lang/XMultiServiceFactory.idl>
#include <com/sun/star/container/XContainer.idl>
#include <com/sun/star/container/XEnumerationAccess.idl>
module com { module sun { module star { module ui {
/** describes a container of user actions.
<p>No assumption is made about any graphical representation:
You could have a menu or a toolbox working with the same container
describing their entries.</p>
<p>Possible elements of the <type>ActionTriggerContainer</type> are
<ul>
<li><type>ActionTrigger</type> -
represents a simply clickable menu entry</li>
<li><type>ActionTriggerSeparator</type> -
represents a separator between two entries<br/>
This entry type is of interest for components rendering a an
<type>ActionTriggerContainer</type>
</li>
<li><type>ActionTriggerContainer</type> -
represents a sub container</li>
</ul>
</p>
*/
published service ActionTriggerContainer
{
/** provides access to the entries of a menu. The element type
is <type scope="com::sun::star::beans">XPropertySet</type>.
The property set contains attributes like CommandURL, HelpURL
as defined in the service <type scope="com::sun::star::ui">ActionTrigger</type>
and optional a <type scope="com::sun::star::ui">ActionTriggerContainer</type>.
*/
interface ::com::sun::star::container::XIndexContainer;
/** creates elements to be inserted into the container.
<p>Usually, the <method>XMultiServiceFactory::getSupportedServiceNames</method>
gives you a <type>ActionTrigger</type> and
optionally <type>ActionTriggerContainer</type> and
<type>ActionTriggerSeparator</type>
.</p>
*/
interface ::com::sun::star::lang::XMultiServiceFactory;
/** allows to enumerate the elements of the container
*/
[optional] interface ::com::sun::star::container::XEnumerationAccess;
/** allows foreign components to register themselves as listener for the container
structure.
*/
[optional] interface ::com::sun::star::container::XContainer;
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */