blob: 9ebceb714e1f676fc488ce4324f189bda4eec489 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
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: */
|
