xref: /AOO41X/main/udkapi/com/sun/star/container/XNamed.idl (revision 7d1ce60b947f1ffb0e85bce1104d25cd58764da3)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_container_XNamed_idl__
24#define __com_sun_star_container_XNamed_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30//=============================================================================
31
32module com {  module sun {  module star {  module container {
33
34//=============================================================================
35
36/** specifies the name of the object.
37
38    <p>The name is generally unique in the container of the object.</p>
39 */
40published interface XNamed: com::sun::star::uno::XInterface
41{
42    //-------------------------------------------------------------------------
43
44    /** @returns
45        the programmatic name of the object.
46     */
47    string getName();
48
49    //-------------------------------------------------------------------------
50
51    /** sets the programmatic name of the object.
52     */
53    [oneway] void setName( [in] string aName );
54
55};
56
57//=============================================================================
58
59/** specifies the display name of the object.
60
61    <p>The name is generally unique in the container of the object.</p>
62 */
63published interface XNamedEx: XNamed
64{
65    //-------------------------------------------------------------------------
66
67    /** @returns
68        the display name of the object.
69     */
70    string getDisplayName();
71
72    //-------------------------------------------------------------------------
73
74    /** sets the display name of the object.
75     */
76    [oneway] void setDisplayName( [in] string aName );
77
78};
79
80}; }; }; };
81
82#endif
83