1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
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.
14 *
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).
20 *
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.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_ui_dialogs_XControlAccess_idl__
29#define __com_sun_star_ui_dialogs_XControlAccess_idl__
30
31#ifndef __com_sun_star_uno_XInterface_idl__
32#include <com/sun/star/uno/XInterface.idl>
33#endif
34
35#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
36#include <com/sun/star/lang/IllegalArgumentException.idl>
37#endif
38
39//=============================================================================
40
41module com { module sun { module star { module ui { module dialogs {
42
43//=============================================================================
44/** Generic control access interface.
45
46	<p>Use this interface to access user interface controls supported
47        by the implementing service. The supported controls, control
48        properties and the appropriate values are documented in the
49        decription of the implementing service.</p>
50
51    @see com::sun::star::ui::dialogs::FilePicker
52    @see com::sun::star::ui::dialogs::FilePicker
53
54    @since OOo 1.1.2
55*/
56published interface XControlAccess: com::sun::star::uno::XInterface
57{
58//-------------------------------------------------------------------------
59/** Change a control property.
60
61    @param aControlName
62        The name of the control. Common control names are for
63        instance 'OkButton' or 'CancelButton'.
64
65    @param aControlProperty
66        The control property to manipulate. Common control properties
67        are for instance 'Label' or 'State'.
68
69    @param aValue
70        A value appropriated for the property.
71
72    @throws com::sun::star::lang::IllegalArgumentException
73        when the control is not supported, the control property is invalid or
74        the value fits not the control action.
75*/
76void setControlProperty( [in] string aControlName, [in] string aControlProperty, [in] any aValue )
77    raises( com::sun::star::lang::IllegalArgumentException );
78
79//-------------------------------------------------------------------------
80/** Query for a control property.
81
82    @param aControlName
83       The name of the control. Common control names are for
84        instance 'OkButton' or 'CancelButton'.
85
86    @param aControlProperty
87        The requested control property. Common control properties
88        are for instance 'Label' or 'State'.
89
90    @returns
91        the requested value.
92
93    @throws com::sun::star::lang::IllegalArgumentException
94        when the control is not supported or the control property is invalid.
95*/
96any getControlProperty( [in] string aControlName, [in] string aControlProperty )
97    raises( com::sun::star::lang::IllegalArgumentException );
98};
99
100//=============================================================================
101
102}; }; }; }; };
103
104#endif
105
106