summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/inspection/XStringListControl.idl
blob: caf38d601a6a57b762cdd98a67ff511f4e4c8020 (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
/* -*- 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_inspection_XStringListControl_idl__
#define __com_sun_star_inspection_XStringListControl_idl__

#include <com/sun/star/inspection/XPropertyControl.idl>

module com {  module sun {  module star {  module inspection {

/** defines the interface for an XPropertyControl which, additionally
    to the basic behavior, supports a list of strings interpreted as possible
    property values.

    <p>A control which would canonically implement this interface is a list box control:
    The string list defined by XStringListControl would in the control be
    represented as drop-down list containing all the strings.</p>

    @since OOo 2.0.3
*/
interface XStringListControl : XPropertyControl
{
    /** clears the whole list
    */
    void clearList();

    /** prepends a new entry to the beginning of the list
    */
    void prependListEntry( [in] string NewEntry );

    /** appends a new entry to the end of the list
    */
    void appendListEntry( [in] string NewEntry );

    /** gets all list entries
    */
    sequence< string > getListEntries();
};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */