summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/ui/ActionTriggerContainer.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/ui/ActionTriggerContainer.idl')
-rw-r--r--offapi/com/sun/star/ui/ActionTriggerContainer.idl97
1 files changed, 97 insertions, 0 deletions
diff --git a/offapi/com/sun/star/ui/ActionTriggerContainer.idl b/offapi/com/sun/star/ui/ActionTriggerContainer.idl
new file mode 100644
index 000000000000..63ef251ec83d
--- /dev/null
+++ b/offapi/com/sun/star/ui/ActionTriggerContainer.idl
@@ -0,0 +1,97 @@
+/*************************************************************************
+ *
+ * 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__
+
+#ifndef __com_sun_star_container_XIndexContainer_idl__
+#include <com/sun/star/container/XIndexContainer.idl>
+#endif
+#ifndef __com_sun_star_lang_XMultiServiceFactory_idl__
+#include <com/sun/star/lang/XMultiServiceFactory.idl>
+#endif
+#ifndef __com_sun_star_container_XContainer_idl__
+#include <com/sun/star/container/XContainer.idl>
+#endif
+#ifndef __com_sun_star_container_XEnumerationAccess_idl__
+#include <com/sun/star/container/XEnumerationAccess.idl>
+#endif
+
+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 themself as listener for the container
+ structure.
+ */
+ [optional] interface ::com::sun::star::container::XContainer;
+};
+}; }; }; };
+#endif