offapi/com/sun/star/ui/dialogs/XControlInformation.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XControlInformation.idl,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_ui_dialogs_XControlInformation_idl__
  32 #define __com_sun_star_ui_dialogs_XControlInformation_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  39 #include <com/sun/star/lang/IllegalArgumentException.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com { module sun { module star { module ui { module dialogs {
  45
  46 //=============================================================================
  47 /** Interface to query for controls and control properties supported by the
  48     implementing instance.
  49
  50     @since OOo 1.1.2
  51 */
  52 published interface XControlInformation: com::sun::star::uno::XInterface
  53 {
  54 //-------------------------------------------------------------------------
  55 /** Query for the supported controls of a service instance.
  56
  57     @returns
  58         a sequence with the names of the supported controls.
  59 */
  60 sequence<string> getSupportedControls( );
  61
  62 //-------------------------------------------------------------------------
  63 /** Returns whether the specified control is supported or not.
  64
  65     @param aControlName
  66         The name of the control. Common control names are for
  67         instance 'OkButton' or 'CancelButton'.
  68
  69     @returns
  70         <TRUE/> if the specified control is supported.
  71         <FALSE/> if the specified control is not supported.
  72 */
  73 boolean isControlSupported( [in] string aControlName );
  74
  75 //-------------------------------------------------------------------------
  76 /** Returns a sequence with properties supported by the specified
  77     control.
  78
  79     @param aControlName
  80         The name of the control. Common control names are for
  81         instance 'OkButton' or 'CancelButton'.
  82
  83     @returns
  84         a sequence of control properties supported by the specified control.
  85
  86     @throws com::sun::star::lang::IllegalArgumentException
  87         when the specified control is not supported.
  88 */
  89 sequence<string> getSupportedControlProperties( [in] string aControlName )
  90     raises( com::sun::star::lang::IllegalArgumentException );
  91
  92 //-------------------------------------------------------------------------
  93 /** Returns whether control property is supported by a control.
  94
  95     @param aControlName
  96        The name of the control.
  97
  98     @param aControlProperty
  99         The control property to query for.
 100
 101     @returns
 102         <TRUE/> if the specified control action is supported.
 103         <FALSE/> if the specified control action is not supported.
 104
 105     @throws com::sun::star::lang::IllegalArgumentException
 106         when the specified control is not supported.
 107 */
 108 boolean isControlPropertySupported( [in] string aControlName, [in] string aControlProperty )
 109     raises( com::sun::star::lang::IllegalArgumentException );
 110 };
 111
 112 }; }; }; }; };
 113
 114 #endif