summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/ui/UIElement.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/ui/UIElement.idl')
-rw-r--r--offapi/com/sun/star/ui/UIElement.idl89
1 files changed, 89 insertions, 0 deletions
diff --git a/offapi/com/sun/star/ui/UIElement.idl b/offapi/com/sun/star/ui/UIElement.idl
new file mode 100644
index 000000000..9ebceb714
--- /dev/null
+++ b/offapi/com/sun/star/ui/UIElement.idl
@@ -0,0 +1,89 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#ifndef __com_sun_star_ui_UIElement_idl__
+#define __com_sun_star_ui_UIElement_idl__
+
+#include <com/sun/star/ui/XUIElement.idl>
+#include <com/sun/star/beans/XPropertySet.idl>
+#include <com/sun/star/lang/XInitialization.idl>
+#include <com/sun/star/lang/XComponent.idl>
+#include <com/sun/star/util/XUpdatable.idl>
+
+
+module com { module sun { module star { module ui {
+
+
+/** specifies a user interface element.
+
+ <p>
+ A user interface element consists of a unique identifier and a type specifier. It
+ provides an interface to retrieve a special purpose interface which depends on
+ the specific user interface element type. Every user interface must be initialized
+ before it can be used.
+ </p>
+
+ @since OOo 2.0
+*/
+
+service UIElement
+{
+ /** provides a function to retrieve a special purpose interface which depends on
+ the specific user interface element type.
+ */
+ interface ::com::sun::star::ui::XUIElement;
+
+ /** interface to initialize a user interface element instance.
+
+ A user interface element must be initialized using
+ com::sun::star::lang::XInitialization::initialize() before
+ it can be used. The following property must be provided:
+ <ul>
+ <li><b>ResourceURL</b>specifies a string property which is the unique identifier of
+ the user interface element.</li>
+ </ul>
+
+ A user interface element factory creates and initializes every user interface element
+ correctly.
+
+ @see com::sun::star::ui::UIElementFactoryManager;
+ @see com::sun::star::ui::UIElementFactory
+ */
+ [optional] interface ::com::sun::star::lang::XInitialization;
+
+ /** used to notify an implementation that it needs to update its visual representation.
+
+ <p>
+ A user interface element implementation should check if it has to update its visual
+ representation. It is up to the implementation if it ignores notifications.
+ </p>
+ */
+ [optional] interface com::sun::star::util::XUpdatable;
+
+ /** controls the life-time of the object.
+ */
+ interface ::com::sun::star::lang::XComponent;
+};
+
+}; }; }; };
+
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */