merged tag ooo/OOO330_m14
[LibreOffice.git] / offapi / com / sun / star / inspection / XStringListControl.idl
blob64074196109087c88cbd5751d6a373b38f155a96
1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * This file is part of OpenOffice.org.
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org. If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
26 ************************************************************************/
28 #ifndef __com_sun_star_inspection_XStringListControl_idl__
29 #define __com_sun_star_inspection_XStringListControl_idl__
31 #ifndef __com_sun_star_inspection_XPropertyControl_idl__
32 #include <com/sun/star/inspection/XPropertyControl.idl>
33 #endif
35 //=============================================================================
36 module com { module sun { module star { module inspection {
38 //-----------------------------------------------------------------------------
39 /** defines the interface for an <type>XPropertyControl</type> which, additionally
40 to the basic behaviour, supports a list of strings interpreted as possible
41 property values.
43 <p>A control which would canonically implement this interface is a list box control:
44 The string list defined by <type>XStringListControl</type> would in the control be
45 represented as drop-down list containing all the strings.</p>
47 @since OOo 2.0.3
49 interface XStringListControl : XPropertyControl
51 /** clears the whole list
53 void clearList();
55 /** prepends a new entry to the beginning of the list
57 void prependListEntry( [in] string NewEntry );
59 /** appends a new entry to the end of the list
61 void appendListEntry( [in] string NewEntry );
63 /** gets all list entries
65 sequence< string > getListEntries();
68 //=============================================================================
70 }; }; }; };
72 #endif