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
24#ifndef __com_sun_star_inspection_XStringListControl_idl__
25#define __com_sun_star_inspection_XStringListControl_idl__
26
27#ifndef __com_sun_star_inspection_XPropertyControl_idl__
28#include <com/sun/star/inspection/XPropertyControl.idl>
29#endif
30
31//=============================================================================
32module com {  module sun {  module star {  module inspection {
33
34//-----------------------------------------------------------------------------
35/** defines the interface for an <type>XPropertyControl</type> which, additionally
36    to the basic behaviour, supports a list of strings interpreted as possible
37    property values.
38
39    <p>A control which would canonically implement this interface is a list box control:
40    The string list defined by <type>XStringListControl</type> would in the control be
41    represented as drop-down list containing all the strings.</p>
42
43    @since OpenOffice 2.0.3
44*/
45published interface XStringListControl : XPropertyControl
46{
47    /** clears the whole list
48    */
49    void clearList();
50
51    /** prepends a new entry to the beginning of the list
52    */
53    void prependListEntry( [in] string NewEntry );
54
55    /** appends a new entry to the end of the list
56    */
57    void appendListEntry( [in] string NewEntry );
58
59    /** gets all list entries
60    */
61    sequence< string > getListEntries();
62};
63
64//=============================================================================
65
66}; }; }; };
67
68#endif
69
70