1d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5d1766043SAndrew Rist * distributed with this work for additional information 6d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10d1766043SAndrew Rist * 11d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12d1766043SAndrew Rist * 13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14d1766043SAndrew Rist * software distributed under the License is distributed on an 15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17d1766043SAndrew Rist * specific language governing permissions and limitations 18d1766043SAndrew Rist * under the License. 19d1766043SAndrew Rist * 20d1766043SAndrew Rist *************************************************************/ 21d1766043SAndrew Rist 22d1766043SAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir#ifndef __com_sun_star_ui_dialogs_XControlAccess_idl__ 25cdf0e10cSrcweir#define __com_sun_star_ui_dialogs_XControlAccess_idl__ 26cdf0e10cSrcweir 27cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 28cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 29cdf0e10cSrcweir#endif 30cdf0e10cSrcweir 31cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 32cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl> 33cdf0e10cSrcweir#endif 34cdf0e10cSrcweir 35cdf0e10cSrcweir//============================================================================= 36cdf0e10cSrcweir 37cdf0e10cSrcweirmodule com { module sun { module star { module ui { module dialogs { 38cdf0e10cSrcweir 39cdf0e10cSrcweir//============================================================================= 40cdf0e10cSrcweir/** Generic control access interface. 41cdf0e10cSrcweir 42cdf0e10cSrcweir <p>Use this interface to access user interface controls supported 43cdf0e10cSrcweir by the implementing service. The supported controls, control 44cdf0e10cSrcweir properties and the appropriate values are documented in the 45cdf0e10cSrcweir decription of the implementing service.</p> 46cdf0e10cSrcweir 47cdf0e10cSrcweir @see com::sun::star::ui::dialogs::FilePicker 48cdf0e10cSrcweir @see com::sun::star::ui::dialogs::FilePicker 49cdf0e10cSrcweir 50*f431c806SJürgen Schmidt @since OpenOffice 1.1.2 51cdf0e10cSrcweir*/ 52cdf0e10cSrcweirpublished interface XControlAccess: com::sun::star::uno::XInterface 53cdf0e10cSrcweir{ 54cdf0e10cSrcweir//------------------------------------------------------------------------- 55cdf0e10cSrcweir/** Change a control property. 56cdf0e10cSrcweir 57cdf0e10cSrcweir @param aControlName 58cdf0e10cSrcweir The name of the control. Common control names are for 59cdf0e10cSrcweir instance 'OkButton' or 'CancelButton'. 60cdf0e10cSrcweir 61cdf0e10cSrcweir @param aControlProperty 62cdf0e10cSrcweir The control property to manipulate. Common control properties 63cdf0e10cSrcweir are for instance 'Label' or 'State'. 64cdf0e10cSrcweir 65cdf0e10cSrcweir @param aValue 66cdf0e10cSrcweir A value appropriated for the property. 67cdf0e10cSrcweir 68cdf0e10cSrcweir @throws com::sun::star::lang::IllegalArgumentException 69cdf0e10cSrcweir when the control is not supported, the control property is invalid or 70cdf0e10cSrcweir the value fits not the control action. 71cdf0e10cSrcweir*/ 72cdf0e10cSrcweirvoid setControlProperty( [in] string aControlName, [in] string aControlProperty, [in] any aValue ) 73cdf0e10cSrcweir raises( com::sun::star::lang::IllegalArgumentException ); 74cdf0e10cSrcweir 75cdf0e10cSrcweir//------------------------------------------------------------------------- 76cdf0e10cSrcweir/** Query for a control property. 77cdf0e10cSrcweir 78cdf0e10cSrcweir @param aControlName 79cdf0e10cSrcweir The name of the control. Common control names are for 80cdf0e10cSrcweir instance 'OkButton' or 'CancelButton'. 81cdf0e10cSrcweir 82cdf0e10cSrcweir @param aControlProperty 83cdf0e10cSrcweir The requested control property. Common control properties 84cdf0e10cSrcweir are for instance 'Label' or 'State'. 85cdf0e10cSrcweir 86cdf0e10cSrcweir @returns 87cdf0e10cSrcweir the requested value. 88cdf0e10cSrcweir 89cdf0e10cSrcweir @throws com::sun::star::lang::IllegalArgumentException 90cdf0e10cSrcweir when the control is not supported or the control property is invalid. 91cdf0e10cSrcweir*/ 92cdf0e10cSrcweirany getControlProperty( [in] string aControlName, [in] string aControlProperty ) 93cdf0e10cSrcweir raises( com::sun::star::lang::IllegalArgumentException ); 94cdf0e10cSrcweir}; 95cdf0e10cSrcweir 96cdf0e10cSrcweir//============================================================================= 97cdf0e10cSrcweir 98cdf0e10cSrcweir}; }; }; }; }; 99cdf0e10cSrcweir 100cdf0e10cSrcweir#endif 101cdf0e10cSrcweir 102