/*************************************************************************
 *
 *  $RCSfile: XControlInformation.idl,v $
 *
 *  $Revision: 1.5 $
 *
 *  last change: $Author: vg $ $Date: 2003/06/10 11:19:58 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (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.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
 
#ifndef __com_sun_star_ui_dialogs_XControlInformation_idl__
#define __com_sun_star_ui_dialogs_XControlInformation_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif

//=============================================================================

module com { module sun { module star { module ui { module dialogs {

//=============================================================================
/** Interface to query for controls and control properties supported by the 
    implementing instance.

    @since #107627#
*/
interface XControlInformation: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** Query for the supported controls of a service instance.

    @returns 
        a sequence with the names of the supported controls.
*/
sequence<string> getSupportedControls( );

//-------------------------------------------------------------------------
/** Returns whether the specified control is supported or not.
    
    @param aControlName
        The name of the control. Common control names are for
        instance 'OkButton' or 'CancelButton'.
    
    @returns 
        <TRUE/> if the specified control is supported.
        <FALSE/> if the specified control is not supported.
*/
boolean isControlSupported( [in] string aControlName );
    
//-------------------------------------------------------------------------
/** Returns a sequence with properties supported by the specified
    control.
    
    @param aControlName
        The name of the control. Common control names are for
        instance 'OkButton' or 'CancelButton'.
        
    @returns
        a sequence of control properties supported by the specified control.
        
    @throws com::sun::star::lang::IllegalArgumentException
        when the specified control is not supported.
*/
sequence<string> getSupportedControlProperties( [in] string aControlName )
    raises( com::sun::star::lang::IllegalArgumentException );
    
//-------------------------------------------------------------------------
/** Returns whether control property is supported by a control.
    
    @param aControlName
       The name of the control.
       
    @param aControlProperty
        The control property to query for.
        
    @returns 
        <TRUE/> if the specified control action is supported.
        <FALSE/> if the specified control action is not supported.
        
    @throws com::sun::star::lang::IllegalArgumentException
        when the specified control is not supported.
*/
boolean isControlPropertySupported( [in] string aControlName, [in] string aControlProperty )
    raises( com::sun::star::lang::IllegalArgumentException );
};

}; }; }; }; };

#endif
