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_XControlInformation_idl__ 25cdf0e10cSrcweir#define __com_sun_star_ui_dialogs_XControlInformation_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/** Interface to query for controls and control properties supported by the 41cdf0e10cSrcweir implementing instance. 42cdf0e10cSrcweir 43*f431c806SJürgen Schmidt @since OpenOffice 1.1.2 44cdf0e10cSrcweir*/ 45cdf0e10cSrcweirpublished interface XControlInformation: com::sun::star::uno::XInterface 46cdf0e10cSrcweir{ 47cdf0e10cSrcweir//------------------------------------------------------------------------- 48cdf0e10cSrcweir/** Query for the supported controls of a service instance. 49cdf0e10cSrcweir 50cdf0e10cSrcweir @returns 51cdf0e10cSrcweir a sequence with the names of the supported controls. 52cdf0e10cSrcweir*/ 53cdf0e10cSrcweirsequence<string> getSupportedControls( ); 54cdf0e10cSrcweir 55cdf0e10cSrcweir//------------------------------------------------------------------------- 56cdf0e10cSrcweir/** Returns whether the specified control is supported or not. 57cdf0e10cSrcweir 58cdf0e10cSrcweir @param aControlName 59cdf0e10cSrcweir The name of the control. Common control names are for 60cdf0e10cSrcweir instance 'OkButton' or 'CancelButton'. 61cdf0e10cSrcweir 62cdf0e10cSrcweir @returns 63cdf0e10cSrcweir <TRUE/> if the specified control is supported. 64cdf0e10cSrcweir <FALSE/> if the specified control is not supported. 65cdf0e10cSrcweir*/ 66cdf0e10cSrcweirboolean isControlSupported( [in] string aControlName ); 67cdf0e10cSrcweir 68cdf0e10cSrcweir//------------------------------------------------------------------------- 69cdf0e10cSrcweir/** Returns a sequence with properties supported by the specified 70cdf0e10cSrcweir control. 71cdf0e10cSrcweir 72cdf0e10cSrcweir @param aControlName 73cdf0e10cSrcweir The name of the control. Common control names are for 74cdf0e10cSrcweir instance 'OkButton' or 'CancelButton'. 75cdf0e10cSrcweir 76cdf0e10cSrcweir @returns 77cdf0e10cSrcweir a sequence of control properties supported by the specified control. 78cdf0e10cSrcweir 79cdf0e10cSrcweir @throws com::sun::star::lang::IllegalArgumentException 80cdf0e10cSrcweir when the specified control is not supported. 81cdf0e10cSrcweir*/ 82cdf0e10cSrcweirsequence<string> getSupportedControlProperties( [in] string aControlName ) 83cdf0e10cSrcweir raises( com::sun::star::lang::IllegalArgumentException ); 84cdf0e10cSrcweir 85cdf0e10cSrcweir//------------------------------------------------------------------------- 86cdf0e10cSrcweir/** Returns whether control property is supported by a control. 87cdf0e10cSrcweir 88cdf0e10cSrcweir @param aControlName 89cdf0e10cSrcweir The name of the control. 90cdf0e10cSrcweir 91cdf0e10cSrcweir @param aControlProperty 92cdf0e10cSrcweir The control property to query for. 93cdf0e10cSrcweir 94cdf0e10cSrcweir @returns 95cdf0e10cSrcweir <TRUE/> if the specified control action is supported. 96cdf0e10cSrcweir <FALSE/> if the specified control action is not supported. 97cdf0e10cSrcweir 98cdf0e10cSrcweir @throws com::sun::star::lang::IllegalArgumentException 99cdf0e10cSrcweir when the specified control is not supported. 100cdf0e10cSrcweir*/ 101cdf0e10cSrcweirboolean isControlPropertySupported( [in] string aControlName, [in] string aControlProperty ) 102cdf0e10cSrcweir raises( com::sun::star::lang::IllegalArgumentException ); 103cdf0e10cSrcweir}; 104cdf0e10cSrcweir 105cdf0e10cSrcweir}; }; }; }; }; 106cdf0e10cSrcweir 107cdf0e10cSrcweir#endif 108